Documentation
Documentation provides sound structures and tools to maintain a Documentation Management System based on WordPress. Leveraging WordPress’ framework and internal structures, the system provides a completely new section to manage documents independently from normal posts or pages. Documents are complemented by their dedicated document categories and document tags, which allows to keep the documentation structures separate from the more blog-oriented posts or CMS-like pages. It can be used to build a dedicated documentation site, a subsite for documentation in a multisite network or other creative deployments. See our documentation portal for an example where we use the system to maintain a considerable amount of documentation for our tools. Simple to use, yet powerful to maintain even thousands of documentation pages. Documents can be attached to products in WooCommerce using WooCommerce Documentation. Widgets The plugin provides several widgets that are used to display document links: Document Hierarchy : facilitates navigating and viewing the document hierarchy Document Children : displays links to children of documents Documents : to display sets of document links Document Categories : to display links to document categories Shortcodes The following shortcodes are available: [documentation_documents] Lists documents, also useful to list documents in a category. [documentation_categories] Renders a list of links to the document categories. [documentation_hierarchy] Provides a means to navigate the documentation structure, equivalent to the Document Hierarchy widget. [documentation_list_children] Lists the children of a document like the Document Children widget. [documentation_search_form] Renders a dynamic search form. Use Search Live for a more flexible search form. Recommended Useful Additions You should have a look at these tools. They will help you get the most out of this Documentation Management System. WooCommerce Documentation This extension for WooCommerce and the Documentation plugin for WordPress allows to link documentation pages to products and display them automatically on the product pages. Groups Groups is designed as an efficient, powerful and flexible solution for group-oriented memberships and content access control. Use it to control who can view documents and more. Groups Restrict Categories An extension based on Groups, provides access restrictions for categories and tags, custom post types and taxonomies. Very useful to restrict whole sets of documents based on their document categories or tags. Search Live Search Live supplies effective integrated live search facilities and advanced search features. Makes it really easy to find the desired documents. Widgets Control Widgets Control is a toolbox that features visibility management for all widgets, sidebars, sections of content and content blocks. This is very useful to show content and widgets in context. Widgets Control Pro Widgets Control Pro is the advanced version of the Widgets Control toolbox that features visibility management for all widgets, sidebars, sections of content and content blocks. With its additional features, it is even more useful to show document-specific content and widgets, including the options to show widgets on documents and related pages only. Decent Comments Decent Comments shows what people say. If you want to show comments along with their author’s avatars and an excerpt of their comment, then this is the right plugin for you. Use it to show comments posted on documents only or including them. Open Graph Protocol Framework The Open Graph protocol enables any web page to become a rich object in a social graph. For instance, this is used on Facebook to allow any web page to have the same functionality as any other object on Facebook. This will automate the process of adding basic and optional metadata to documents. Documentation Please refer to the documentation pages for details. The site uses the Documentation plugin and is a good example of deployment, with an extensive set of documentation sections and pages. Feedback Feedback is welcome! If you need help, have problems, want to leave feedback or want to provide constructive criticism, please do so here at the Documentation plugin page. Please try to solve problems there before you rate this plugin or say it doesn’t work. There goes a lot of work into providing you with free quality plugins! Please appreciate that and help with your feedback. Thanks! Twitter Follow @itthinx on Twitter for updates on this and other plugins.
Top keywords
- documentation24×3.47%
- document14×2.03%
- documents14×2.03%
- widgets12×1.74%
- categories8×1.16%
- pages8×1.16%
- search8×1.16%
- content7×1.01%
- control7×1.01%
- children5×0.72%
- document categories5×0.72%
- links5×0.72%
VS Knowledge Base
About With this lightweight plugin you can create a knowledge base that contains your categories and posts. Main features of the plugin: Free and lightweight Support for Block Editor and Classic Editor Display your knowledge base with block, shortcode or widget Custom post types are supported (such as WooCommerce product categories and products) Customize your knowledge base with attributes Documentation at WP plugin page Active support from developer at WP forum With this plugin you can also create a FAQ or wiki in the same way as a knowledge base. How to use After installation make sure you already have some categories and posts. Go to the editor and add the VS Knowledge Base block or the shortcode [knowledgebase] to a page. This will display your knowledge base. Or go to Appearance > Widgets and use the VS Knowledge Base widget. Default settings categories: 4 columns when using block or shortode 1 column when using widget 2 columns in small screens Order by name Ascending order (A-Z) Empty categories are hidden Parent and subcategories are displayed separately Default settings posts: Order by date Descending order (new to old) All posts are displayed Customize your knowledge base with attributes. Attributes You can customize your knowledge base by adding attributes to the block, shortcode or widget. Add custom CSS class to knowledge base: class="your-class-name" Change the number of columns: columns="3" Disable the columns: columns="0" Include certain categories: include="1,3,5" Exclude certain categories: exclude="8,10,12" Display empty categories too: hide_empty="0" Change the number of posts per category: posts_per_category="5" Reverse the order of posts: order="ASC" Display posts by title: orderby="title" Display posts in random order: orderby="rand" Disable category link: category_link="false" Display category description: category_description="true" Display post counter: post_count="true" Display post meta (date and author): post_meta="true" Display View All link: view_all_link="true" Change label of View All link: view_all_link_label="your label" Change label of post without title: no_post_title_label="your label" Change the “no categories are found” text: no_categories_text="your text" Example: [knowledgebase include="1,3,5" hide_empty="0" post_meta="true"] When using the block or the widget, don’t add the main shortcode tag or the brackets. Example: include="1,3,5" hide_empty="0" post_meta="true" With the columns attribute you can set the number of columns between 1 and 4. In small screens max 2 colums. You can disable the columns in favour of your own styling. The columns attribute will be ignored when using the block or widget. Because you can set the columns via the block or widget settings. Post tags Besides displaying posts by category you can also display posts by tag: taxonomy="post_tag" Custom post types It’s also possible to display categories and posts from a custom post type (such as WooCommerce product categories and products). To display these categories and posts you should add 2 attributes: “taxonomy” and “post_type” WooCommerce: Product categories and products: taxonomy="product_cat" post_type="product" Include product category image: taxonomy="product_cat" post_type="product" woo_image="true" Display by tag instead of category: taxonomy="product_tag" post_type="product" Have a question? Please take a look at the FAQ section. Translation Translations are not included, but the plugin supports WordPress language packs. More translations are very welcome! The translation folder inside this plugin is redundant, but kept for reference. Credits Without help and support from the WordPress community I was not able to develop this plugin, so thank you!