Table of Contents
- 1.Introduction
- 2.Overview
- 3.Type of Contents
- 4.Alluring Features
- 4.1.Multiple Documentation & Categorization
- 4.2.Drag and Drop
- 4.3.Nestable Sections
- 4.4.Suggestion Form
- 4.5.Like / Dislike
- 4.6.Custom class and CSS
- 4.7.Email, Copy and Print
- 4.8.Document Archive Listing
- 4.9.Themes
- 4.10.Compatibility
- 4.11.Modification through Hooks and Templates
- 4.12.Support and Documentation
- 4.13.New Features
- 5.Developer\\\\\\\'s Guide
- 6.License
WP Documentation Pro is an flexible but easy to use plugin that will boost up the normal speed of creating a documentation. The plugin provides beautiful layout, features and settings that will make your documentation easy, readable and attractive. The plugin accepts various range of file types, embeds and code snippets which makes it the ultimate necessity whilst creating a dynamic documentation.
The compatibility of the plugin is also one of the features why it is one of the top plugins to choose form while creating a documentation. It can also be modified very easily through custom templates and hooks according to your requirement.
The flexible feature along with the free and unlimited support and document provided with the product puts the plugin on the top of the list to choose from for documentation makers.
Installing wp-documentation-pro is very easy. Once you have installed the plugin, a new menu will appear on the dashboard called Documentations. You will be able to add new documentation, create categories and use different settings to set up your documentation which will be discussed later on in this documentation.
- Download the plugin (.zip file)
- In your Admin, go to menu Plugins > Add
- Select the tab “Upload”
- Upload the .zip file you just downloaded
- Activate the plugin
- A new menu will appear in your Admin
- Once you buy the plugin, you will get zip folder.
- Unzip the folder and Upload `wp-documentation-pro` folder to the `/wp-content/plugins/` directory
- Activate the plugin through the ‘Plugins’ menu in WordPress
- A new menu will appear in your Admin panel
WP Documentation Pro is a very easy to use plugin, with very simple and understandable settings. These settings and features can be setup with easy and without any hassle. A simple walk-through of each feature of the plugin has been provided in detail.
The first step to creating your documentation is adding a title to your documentation.
After you create a documentation for the documentation form Dashboard -> Documentation -> Add New and added a title to you documentation the first step is to add different heading on your documentation.
In the title tab you can add title to your headings for different contents.
All you have to do is press the add new button. Then a new heading will appear, where you can add a title to the heading.
Info: You will not be able to add content to the new heading unless you have published/updated the documentation after you have added the new heading
After you have created your heading and published/updated it you will be able to add contents to your heading. The WP Documentation Pro plugin supports various types of contents like images, video, code snippets, gallery etc. For more details on the “Type of Contents” please refer the explanation below.
Other than that you will also be able to add a description for the documentation, that will not be present while viewing the documentation’s detailed view but will be seen on the archive view ( Standard view option) of the documentation.
The settings tab inside the documentation provides an individual settings options where you will be able to set different settings to each one of your documentation.
The individual settings is divided into three sections each one of it explained below.
The general settings comes packed with different versatile settings. Each one of the settings options are explained below.
- Documentation title: Here you have the option to hide/show the main title of the documentation (not the heading of the content) .
- Scroll top offset: The value (in pixel) after which the table will be fixed. Default value is 30px which means the table will be fixed after scrolling down 30px.
- Go to Top: Here you have option to enable/disable the go to top button that will appear on the bottom right whilst scrolling down on the documentation .
- Suggestion form: Option to enable/disable the suggestion from to collect feedback.
- Like / Dislike: Option to enable/disable the like dislike buttons beside every heading on the documentation.
The Custom CSS settings is packed with straight forward settings to provide custom CSS editing to the documentation. Each one of the setting options are explained below.
- Custom Class: Here you can add a new custom class to the documentation and be able to modify the CSS according to your wish.
- Apply Custom CSS: Here you can enable/disable the custom CSS written for your custom class.
- Custom CSS: Here you can add custom CSS to the custom class you have created or an existing class on the documentation.
Each one of the advanced settings are listed and explained below in detail.
Smooth scroll effect: Option to enable/disable the smooth scrolling effect present on the documentation by default.
- Table of Contents (TOC) Position: Option to modify the position of the Table of Contents in the documentation.
- Hide index: Option to enable/disable the numbering on table of contents and also the documentation heading.
- Hide Buttons: Option to enable/disable the three buttons (email, copy and print) that appear besides the headings on the documentation content headings.o
Here you can create categories to help categories your documentation for better sorting.
The category can be created by going to Dashboard -> Categories -> Add New.
Now you will be able to select a category whist creating a new documentation or editing an old documentation from the right side.
Here you will be able to see all the suggestion collected from suggestion response from on the front end of the documentation. The suggestion form can be disabled/enabled on each documentation from individual settings tab as explained above.
Here you can set look and feel of all the documentation overall. Unlike the individual settings the settings on the menu tab will affect the documentation globally. The settings option is divided into two parts which is explained below.
Global settings is packed with options which deals with the global layout of the documentation. Each options of the global settings are explained below.
- Content width ( in % ): This determines the total width % of the content part in the documentation. The content width option in parallel with the table width option should make the total width % (i.e 100%) and should not be greater than 100%
- Table width ( in % ): This option determines the total width % of the table part in the documentation. As mentioned earlier the sum of content width % and table width % should be a total of 100% not more nor less.
- Documentation Nesting: This option determines the total number of nested sub headings. By default the value for this option is 3 which means that the documentation will go up to 3 nested sections ( 1, 1.1, 1.1.1) but not more than that unless the setting is changed.
- Item Per Row: Total items per row on the grid view of the archive listing on the front end.
- Archive View: Here you have option to change the archive view between two different options (Standard View and Dropdown View)
Theme settings provide you with the option to choose from the default theme ( the current theme you are using) or the Coffee theme ( provided by the documentation plugin). Remember that the theme will just affect the documentation’s detailed view but not on other parts of your theme.
The plugin is very dynamic and easy to use with many easy and helpful features which covers almost all of the things required to create a documentation. It supports any type of multimedia file like image, video, audio etc. along with different other features like displaying code snippets, block quotes, bullets and numbering and other typographic features.
The plugin supports code snippets and presents the snippets beautifully on the front end. The snippet presentation provides a charm to the documentation that is definitely an eye catcher. Below is the example of the code snippet display by the plugin.
<?php /** * The main template file. * * This is the most generic template file in a WordPress theme * and one of the two required files for a theme (the other being style.css). * It is used to display a page when nothing more specific matches a query. * E.g., it puts together the home page when no home.php file exists. * * @link https://codex.wordpress.org/Template_Hierarchy * * @package Biography */ get_header(); ?> <div id="primary" class="content-area"> <main id="main" class="site-main" role="main"> <?php if ( have_posts() ) : ?> <?php if ( is_home() && ! is_front_page() ) : ?> <header> <h1 class="page-title screen-reader-text"> <?php single_post_title(); ?> </h1> </header> <?php endif; ?> <?php /* Start the Loop */ ?> <?php while ( have_posts() ) : the_post(); ?>
Adding a code snippet if fairly easy, it takes literally just two clicks to add snippets on your documentation via this plugin.
- First of all after you have created a heading for the documentation go to the content tab.
- This will display a list of heading.
- Now you should select a heading where you want to display the code snippet,
make sure visual tab is selected. - Finally click into the <> icon which opens a new pop-up to insert the snippet
Add attractive quotes on your documentation, to make it look attractive.
You can’t blame gravity for falling in love. -Albert Einstein
Learn from yesterday, live for today, hope for tomorrow. The important thing is not to stop questioning.
Add images on your documentation to make it more descriptive, lively and understandable.
To add a video with documentation pro is pretty simple. Follow the below given video to add a video with YouTube embeds.
With documentation pro, you will be able to add multiple image galleries into you documentation.
Creating an image gallery has never been easier, with documentation-pro plugin you can easily create WordPress’s default gallery.
Follow the below given images to create a gallery.
You can also add popups to your gallery, all you have to do is first edit your existing gallery or create a new gallery. Then go to gallery settings and change the Link to settings to Media file.
The documentation plugin also supports various external embeds of different social media like twitter, facebook etc. and also other embeds like google maps, charts etc.
Twitter Embeds
love youu
— Ariana Grande (@ArianaGrande) June 17, 2016
Google Map Embed
Facebook Embeds
WP Documentation Pro also has option to export all your documentations that you have create form the plugin in an XML format which will be directly downloaded on your computer. To export a documentation go to Dashboard -> Documentations -> Export -> Select documentations you want to export -> Click on “Export” button.
You can then import the XML file to another site where you would want your exported documentation to show.
All you have to do to import is go to Dashboard ->Settings -> Import -> Install WordPress importer if you have to installed it already -> Run WordPress Importer -> Select the xml file by selecting the browse more button -> Now, click on upload file and import, just like that you will have the documentation imported.
The WP Documentation Pro plugin by WEN Solutions is the best plugin for creating a documentation,
with features like drag and drop, sortable headings and contents,impressive designs and different options to make your documentation interesting, readable and impressive.
If you are seeking to look more about the impeccable features the plugin provides, they are listed below.
The most attracting feature of the plugin is, you can make unlimited multiple documentation and sort out categories for each one of the documentation. This way you will be able to produce and categorize as many documentation as you require and surprisingly make it manageable.
The plugin provides you with the option of dragging your heading and placing it according to your requirement. This makes managing your each and every documentation easy and efficient. With this feature you can make documentation without any hassle any without worrying about anything regarding content management inside the documentation which helps save a lot of time.
Another one of the time saving feature that the documentation provides is its nestable sections. With this plugin you can easily nest the titles of the documentation inside one another and will not have to worry about labeling the numerical breakdowns of the nested titles. You will also have the option to limit the nesting sections to a limited number.
The plugin also provides the feature of enabling/disabling the suggestion form, where your documentation viewers will be able to leave their feedback about the specific documentation particularly. This will be a key feature as you will be able to gather valuable information from your documentation and implement it later on.
With the availability of the like/dislike feature on the documentation, you will be able to gather ratings of the documentation you have published. This is certainly very crucial if you would consider the readers of your documentation an asset to the betterment of the product your are documenting if not, you could always disable it.
Custom class and CSS feature is one of the rarest things you could find in a plugin, but if you would ever want to customize the layout, typography etc. of your documentation you can easily use this feature and modify the designs of the documentation as per your requirements.
The plugin also has the feature to enable/disable Email, Copy and print the documentation sections. These buttons make it easy to share your documentation if you want to allow it. With these builtin features you will also have no worries to share your documentation to your readers/customers.
We are also proud to announce that this is the first documentation to provide archive listing of the all documentations made with extra description and multiple archive view. The archive list provides a drop down list of all the documentation to browse from. This feature is certainly very essential if you are making documentation for numerous products and have a large horde of documentation readers/customers.
The plugin also provides an option to choose between two different layouts, one is the theme’s default layout other one is the plugin built coffee theme which is provided by the plugin itself. Also the plugin will be releasing different other themes on the further updates to make your documentation vivid and attractive.
The plugin is compatible with all the themes built based on Underscores format. As most of the themes today are built based on Underscores, you will have no problem making the plugin compatible with the theme, for everything else you will always have the custom CSS, modification via templates/hooks and a very reliable support team to help you out.
The plugin also provides to change its code via hooks and templates. Although the plugin is compatible with most of the underscores based themes, for those themes that are not compatible with the plugin we also provide a flexible and easy way to modify the content wrappers so that the documentation created naturally blends in with the theme.
There are two easy ways the plugin provides to make the documentation adapt to the default wrappers of the theme. The first one is through template, and another modification can be done through hooks.
WEN Solutions has always been know to provide valuable support and product documentation, We have a team of WordPress Developers always on standby to help our clients from anything and everything related to our products. We never rest until our clients are fully satisfied and their issues are solved. Not to mention that the support is free of cost and unlimited.
We have also provided a very helpful documentation that covers almost everything related on how to create a documentation with the WP Documentation Pro plugin.
We also have a promising record of releasing frequent updates to make our products better and better with more features for you to enjoy and use. Our products never gets old as every update makes it brand new and exciting.
Modifying through templates is very simple if proper procedures are followed. There a just 3 simple steps to blend the wrappers in the documentation through the templates.
First you will have to copy the template files from the plugins/wp-documentation-pro/templates/global named wrapper-start.php and wrapper-end.php to themes/your-themes/wp-documentation-pro/templates/global. (the folders wp-documentation-pro/templates/global should be created manually)
Now you will have to remove the switch case present on the template files you have copied.
Then open the single.php file (or any other file that displays the single layout of post/page ) present on the theme, identify the wrapper present and copy it.
In the context of the theme used here as an example, there are wrappers on both single.php.
After you have copied all the wrappers, you can simply go to the wrapper-start.php
and echo the wrappers like on the screen-shot below,
Now since we have printed the wrappers, we will also need to print the closing tags of the wrappers.
Modifying through hooks is also a very simple process. Here too you will have to first find and copy the wrappers present on your theme like show earlier on modification through templates.
After you have copied you will have to now remove the default action on the theme and add your own action.
To remove the default action you will have to go to your functions.php and add a remove_action() function.
You can directly paste the below given code.
remove_action('wp_documentation_before_main_content','wp_documentation_output_content_wrapper', 10); remove_action('wp_documentation_after_main_content','wp_documentation_output_content_wrapper_end', 10);
Now you will have to add two new functions on your theme’s functions.php file where one will work for the opening tag and other one for the closing tags of the wrappers.
Create two functions and paste the copied wrappers into the functions file like below
function wp_documentation_output_custom_content_wrapper() { // This is a must. $class = apply_filters( 'wp_documentation_wrapper_class', 'wp-doc-theme ' ); ?> <div id="primary" class="content-area <?php echo $class; ?>"> <main role="main" class="site-main"> <?php } function wp_documentation_output_custom_content_wrapper_end1() { ?> </main> </div> <?php }
Important thing on the function is the class variable, which is a must and should not be missed.
Now the only thing remaining is to hook the functions. For that you will have to use add action like on the code snippet below. Where you should replace the name of the function to your function name but the hook name should be same as the snippet
add_action('wp_documentation_before_main_content', 'wp_documentation_output_custom_content_wrapper', 10, 2 ); add_action('wp_documentation_after_main_content', 'wp_documentation_output_custom_content_wrapper_end', 10, 2 );
WP Documentation Pro like any other products on Theme Palace has the license validity for only one website. You can use the purchased plugin in multiple websites. Except you won’t be getting any update notifications, supports and plugin updates on them. Also the license expires after one year although you will be able to use the product but you will not be getting any updates and support on it again. You will have to re-purchase the plugin and obtain the unique license key for it.