wedevsofficial / wedocs-plugin Goto Github PK
View Code? Open in Web Editor NEWA documentation plugin for WordPress
Home Page: https://wordpress.org/plugins/wedocs/
License: GNU General Public License v2.0
A documentation plugin for WordPress
Home Page: https://wordpress.org/plugins/wedocs/
License: GNU General Public License v2.0
New args like include_tags
and exclude_tags
will be really useful to show different types of docs
For example, I want to setup and separate docs by two tags: docs and dev-docs
With this new shortcode attributes will be really easy separate them using:
[wedocs include_tags="docs"]
[wedocs include_tags="dev-docs"]
We have different documentation groups for different departments, but there is a lot of overlap between them. It would be nice if we could have the same article appear in multiple documentation groups. Perhaps if there was a metabox when editing an article that allowed us to choose which group and sections the article appears under.
You mention this but I can't find anywhere which tells what it is. Ok - so I guessed [wedocs]. Are there any parameters?
As I known, the structure is WordPress Site -----* Doc ----* Section ----* Article
Can I have structure like?
Doc ----* Section ----* Section ----* Section ----* Section ----* Article
If we have parent and child docs, there is only a shortcode for the parent doc only. The child docs are displayed automatically.
But in some places, we need to show child docs only. So then this shortcode will come handy.
There also should be a shortcode to display table of contents. It will help for larger docs.
I'm not using the WeDocs theme so the docs fit my site theme, but by default the theme includes a SIDEBAR on which nothing is showing. You can see this as the large white space to the right in the attached screenshot.
I'd like to have the documents on a "Full Width" page specified by the theme. When I use the shortcode, it works on the first page, but as you drill in, the sidebar returns and makes the whole thing very narrow.
Any thoughts? I could add some custom code to detect the page type and override the CSS, but I'd rather not.
Hi,
Thank you for the awesome plugin.
I am trying to find two option, if possible.
I recently installed weDocs Plugin 1.3.3 on wp site, i did everything correctly. However upon clicking on each Navigation or link on table of content, it returned Page not found.
I have tried everything, please help.
On begining: sorry for my bad english
I have already installed your plugin (installed several months ago) and it works great.
Is there any option to install this plugin next to already installed as a second plugin with others post_type i.e. post_type = dok or doc or any other ?
If yes, can you tell me how can I do this?
I have a couple users and I wants to create a subpage for them where they can create their own dokumentation but without access to my already existing dokumentations.
These users have limited access to my site (pages, subpages and posts) and they don’t have access to my current documentation therefore they don’t have also access in admin panel to wedocs plugin page where others users can create and edit my current documentation.
Thats why I want to install this plugin as secondone and give access to it for these users.
I create documents with markdown.
But the documents show in wedocs without any format.
Any suggestions?
A notable improvement would be to add more sub-levels in an article.
Section
-Article
--Article
---Article
----Article
The table of contents on the demo http://docs.wedevs.com/docs/dokan/ looks pretty good. Which plugin is used to create this ToC (that understands the weDocs structure).?
When viewing the main documentation, its name is not in the breadcrumbs. When viewing the child documentation both the parent and child breadcrumb is visible.
I will add a pull request for this issue. I am adding this issue for branch reference.
Update v1.3.3 shows no existing Docs.
Logged in as admin
Wordpress menu WeDocs
Select sub-menu Docs
Existing docs still display on frontend
Hi tareq1988,
Many thanks for creating this plugin. I'm currently testing it out for my website. I tried changing it via permalinks, but it broke me dev website (codingbee.com). When I viewed the posts, I kept getting 404 error messages.
I also tried using:
https://en-gb.wordpress.org/plugins/custom-post-type-permalinks/
But still same problems.
Also is it possible to replace 'docs' with 'tutorials' in the urls?
By the way, if interested, I would be interested in supporting you via bountysource.com
Thanks again.
Sher
Hi There, There should a Section and Article duplication system, so we don't have to retype same articles in another section.
regards,
WooCommerce has some nice accessibility features on their docs. It would be nice if we can add that too.
http://prntscr.com/dnynj3
When I am on the default UI, I can change to Classic UI from the bottom. But after that, to get back to the default UI I have to click on the docs menu on the left. Even reloading the page does not work.
Also the switcher visibility should be improved.
Rather i think it would be better if it printed the sub topics on the page body.
It would be nice to have setting to modify root slug from 'docs' to anything else.
Great to be able to send feedback email to the author of the article, instead of a global feedback email.
Hello,
Docs aren't visible in admin ui when they are in pending review state. We need to come back to classic ui in order to view the docs, and change their states.
Can you add the possibility to view docs in pending review?
Thanks in advance
I propose disabling has_archive atrribute and creating normal page to be served as docs homepage.
It would contain [wedocs] and new shortcode [wedocssearch] to display search box on top.
Seems like you have simply given up developing this plugin.
Shame as this could be awesome.
Just seems plagued by unfinished code and incomplete help etc.
i have done ,[wedocs]page is all right ,but doc page can’t be found.
We use this plug in for our software documentation. How do I provide the content to our resellers to customize it? We need to export the content and import it for them.
Using this plugin to build an intranet web site.it would be very useful if i can decide who can see documents in a documentation page or simply who can see menu items and/or sub menu items in documentation page
Printing is actually a very much requested feature on one of my sites but the CSS stylesheet is too simple. Example: https://github.com/BafS/Gutenberg
Hi,
I was trying to get tags from docs type in Rest API but it looks like docs type isn't exposed in Rest API.
I managed to use them by modifying this code :
$args = array( 'labels' => $labels, 'supports' => array( 'title', 'editor', 'thumbnail', 'revisions', ), 'hierarchical' => true, 'public' => true, 'show_ui' => true, 'show_in_menu' => false, 'show_in_nav_menus' => true, 'show_in_admin_bar' => true, 'menu_position' => 5, 'menu_icon' => 'dashicons-portfolio', 'can_export' => true, 'has_archive' => true, 'exclude_from_search' => false, 'publicly_queryable' => true, 'rewrite' => $rewrite, 'capability_type' => 'post', 'taxonomies' => array( 'doc_tag' )
To this :
$args = array( 'labels' => $labels, 'supports' => array( 'title', 'editor', 'thumbnail', 'revisions', ), 'hierarchical' => true, 'public' => true, 'show_ui' => true, 'show_in_menu' => false, 'show_in_nav_menus' => true, 'show_in_admin_bar' => true, 'menu_position' => 5, 'menu_icon' => 'dashicons-portfolio', 'can_export' => true, 'has_archive' => true, 'exclude_from_search' => false, 'publicly_queryable' => true, 'rewrite' => $rewrite, 'capability_type' => 'post', 'taxonomies' => array( 'doc_tag' ), 'show_in_rest' => true,
in function register_post_type()
and this code :
$args = array( 'labels' => $labels, 'hierarchical' => false, 'public' => true, 'show_ui' => true, 'show_admin_column' => true, 'show_in_nav_menus' => true, 'show_tagcloud' => true, 'rewrite' => $rewrite
to this code :
$args = array( 'labels' => $labels, 'hierarchical' => false, 'public' => true, 'show_ui' => true, 'show_admin_column' => true, 'show_in_rest' => true, 'show_in_nav_menus' => true, 'show_tagcloud' => true, 'rewrite' => $rewrite
in function register_taxonomy()
Both modifications are in wedocs.php
Sorry for not making a PR, I'm not a developper and not sure on how to do a pull request
Add docs and Add section work fine, but whe I click Add article nothing is happened. Is this a bug?
I tried to see the developer console and when I click the Add Article button, error message ReferenceError: event is not defined
appears.
In a related support ticket, someone wants to change the Docs breadcrumb to something else.
Ref: https://wordpress.org/support/topic/how-to-change-the-breadcrumbs-text/
The feedback “Send” submit button in the modal is not translatable. I cannot change the value of this input with PO file. The 54rd line <input type=”submit” name=”submit” value=”<?php echo esc_attr( ‘Send’, ‘wedocs’ ); ?>”>
in a script “content-modal.php” looks like a bug. I suggest replacing this line with <input type=”submit” name=”submit” value=”<?php echo esc_attr( _e(‘Send’, ‘wedocs’) ); ?>”>
Could you change the plugin and update new version?
Hi Tareq,
After installing the plugin and configurating some docs all these pages ending up as 404 or redirecting to the main homepage of the website.
I have tried it on a fresh wordpress 4.6.1 / php5.6 installation with default template as sole plugin and as well as on my live website with x-theme and a lot of plugins enabled (i can share login details)
Jasper
Same issue as #4, pages are visible as drafts, but lead to 404 pages when published.
Hi, I have installed a new Wordpress using Azure, which is available at this URL:
http://servicehubdocumentation.azurewebsites.net/
Second, I installed weDocs and configured a couple of sections and docs as shown here:
Now, I can't see anything in my home page and the tutorial doesn't really explain what I am supposed to do to get weDocs working.
Am I supposed to create an empty "home page" in wordpress with some sort of tag in it?
Hi @tareq1988
Can there be a setting or shortcode parameter that allows you specify the maximum number of articles to display per doc?
For instance, if I have Doc A (with 5 articles) and Doc B (with 7 articles); and I specify say 3 as maximum number of articles, it displays not more than 3 articles each under Doc A and Doc B on the index page, then there can be a View all button to expand the list if there are more articles.
I hope this clarifies :-)
I'm not using the WeDocs theme, but by default the theme includes a left sidebar. You can see this as the large white space on the right in the attached screenshot.
I would like to have the documents on a "Full Width" page specified by the theme.
I am not a Wordpress developer, I followed the steps given in this URL, but then I do not know what else I have to do to solve the problem.
Hi,
I would like to ask if there is possible to make responsive grid. It looks awful on mobile.
The docs are displayed at /blog/docs and your breadcrumb function is using home_url('/') which is / instead of /blog/docs). How can this be resolved without editing your functions.php?
hi,
i think if there was a comment section under content it would be useful.
thank you again for sharing this great plugin.
even if there is a db solution that would be fine
Hi,
From the demo it looks like this could be a great plugin for larger documentation content where a single page is not ideal.
I gave it a try and found that the plugin installs and the admin interface works as per the screenshots. After creating the content though, previewing the content yields a 404 page not found error. It happens on both the long URLs and short URLs e.g. "?p=546". Interestingly, switching the pages from "Published" to "Save Draft" makes it possible to preview the pages.
Tested on 3.9.11 and 4.5.1
Is there any way how to exclude certain docs from the search? And maybe create different search widgets with different groups of docs?
At this moment, there is no way to change the url of the home breadcrumb link (wedocs_breadcrumbs
filter just let you set the text label but not the link)
For wordpress installs that are not a full docs website, the home url is redirecting to the main page and my desired workflow is to redirect it to the docs archive page (/docs)
I suggest to add home_link
arg to customize it from this filter
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.