DocumentorKB Guide

The easy way
1. Download the plugin (.zip file)
2. In your Admin, go to menu Plugins > Add
3. Select the tab Upload Plugin button
4. Upload the .zip file you just downloaded
5. Activate the plugin
6. DocumentorKB menu will start appearing on Dashboard

The old way (FTP)
1. Once you buy the plugin, you will get zip folder.
2. Unzip the folder and Upload ‘documentorKB’ folder to the ‘/wp-content/plugins’ directory
3. Activate the plugin through the Plugins menu in WordPress
4. A new menu will appear in your Admin

Follow the step by step process to create a document.

1. After successful activation of DocumentorKB plugin, DocumentorKB menu will appear on the dashboard of WordPress.

2. Head over DocumentorKB menu and select “Add New” option.

3. Create New Guide page will get open, here specify your guide name and select settings set. If you have already created settings set, then you can inherit settings of previously created document else choose default settings. Click on create button.

4. Click on the “Add Section” button to add sections in the document.

5. Using Add section, you can add your separate post for the document or you can add a post or pages which are created in WP posts/pages. You can also add links with a title.

Inline: In the inline section, you can create your own posts for DocumentorKB. You can add media files in the inline section e.g. images, videos and picture gallery.

Links: You can even add links to DocumentorKB. To open the link into new tab/window enable below option “Open in new window”.

5. After insert sections into Knowledge Base, click on the Edit button to see total sections added into the guide. Once list appeared you can do the following operations

Reorder: You can reorder sections just by dragging section and drop it wherever you want. Hit Save button after reorder completed.

Nesting: Drag section slightly to the right side to make it as a nested or sub-point. Hit Save button once nesting completed.

Edit: To Edit section, click on the open icon (rightmost side after section type). Section will get open, where you can change Menu title and Section title. To change the click on Edit link (above Menu title). Here you can change the content of the section and update it after changes are done. Do not forget to save changes.

Delete: To remove the section, click on the open icon (rightmost side after section type). The section will get open, where you can find the “Remove” option to delete a particular section. Hit Save button once changes are done.

6. The right sidebar consists of the link of the guide and the slug. You can easily change the slug of the guide from the right sidebar.

You can also watch the complete video tutorial to create a Knowledge Base:

 

Before you start creating your Knowledge Base, you need to set up a few things. Documentor Knowledge Base consists of two major settings namely the “Knowledge Base Slug Base” and “Section Slug Base”.

1. Login to your WordPress Dashboard
2. Go to DocumentorKB => Global Settings

You’ll find two different options i.e Knowledge Base Slug Base and Section Slug Base.

You can change these options anytime if the website or the Knowledge Base is not indexed. But once it is indexed then changing this can cause a 404 Error as the links will also get changed.

Basically, the settings panel is divided into 3 main parts
1. Basic Settings
2. Formatting Settings
3. Advance Settings

Basic Settings

Basic Settings contains the following setting fields. This setting plays a vital role in the appearance of the document.

1. Skin: Documentor has different skins such as bar, broad, cherry, expanded broad and mint. Choose anyone theme that suits your website appearance.
2. Section Animation: You can set an animation to the Knowledge Base contents. While loading contents of the guide you will experience the selected animation.
3. Indexing Format: You can enable or disable indexing of document.
4. Guide Title: If this option is enabled then it will display the name of the guide on the front end. One can easily format the title of the guide from the different options that are present.
5. Scrolling: After clicking on Menu title content get visible in scrolling effect. You can enable or disable it. Default scrolling option is ON.
6. Fixed Menu: It specifies the location of the menu.
7. Top Margin for Menu: It will specify the top margin for the menu.
8. Menu Position: The position for the menu of a document can be selected from the drop-down. It can be either placed towards the left or right of the document.

Formatting Settings

You can change the font, font style, color, and font size or you can use the theme’s CSS with the help of formatting option.

1. Nav Menu Title

1. Use theme default: To use the theme’s CSS to Nav Menu Title, you can keep option enable. If this option is enabled then rest of setting of nav menu title will not be applied on front-end.
2. Color: Choose a color from color picker box and save changes. The selected color will get applied to the nav menu title.
3. Font: You can select Regular font, Google font or Custom font from given select box. Depending on your selection below settings fields get changed.
4. Font size: You can change the font size of the nav menu title.
5. Font Style: You can change the font style of the nav menu title. If you select google font from the font option then this field gets hidden.

2. Active Nav Menu Background

1. Use theme default: If you enabled this theme’s background CSS will get applied to Active nav menu background.
2. Color: Set color to active nav menu background. If “Use theme default” option is enabled then this field is not applicable.

3. Section Title

1. Use theme default: To use the theme’s CSS for the Section Title, you can keep this option enabled. If this option is enabled then rest of setting of section title will not be applied on front-end.
2. Color: Choose a color from color picker box and save changes. The selected color will get applied to the section title.
3. Font: You can select Regular font, Google font or Custom font from given select box. Depending on your selection below settings fields get changed.
4. Font size: You can change the font size of the section title.
5. Font Style: You can change the font style of the section title. If you have selected google font from the fonts option then this field gets hidden.
6. Last Updated Date: It will display the last updated date for each of the section of the guide if it is enabled.

4. Section Contents

1. Use theme default: To apply the theme’s css to Section Contents, you can keep option enable. If this option is enable then rest of setting of section title will not be applied on front-end.
2. Color: Choose a color from color picker box and save the changes. The selected color will get applied to section contents.
3. Font: You can select Regular font, Google font or Custom font from given select box. Depending on your selection below settings fields gets changed.
4. Font size: You can change the font size of the section contents.
5. Font Style: You can change the font style of section contents. if you have selected the Google font from the fonts option then this field gets hidden.

5. Scrollbar

1. Size: The size of the scroll can be specified from here.
2. Color: The color of the scroll can be selected from the color picker box.
3. Opacity: The Opacity of the Scroll can be set from this option

Advance Settings

Advance settings provide you options to enable or disable email, user feedback, PDF and many more.

1. Search Box: By enabling this option it will show the search option for the document on the admin panel as well as the front end.
2. Buttons: You can enable or disable this option as per your requirement. This all options are visible on the front end of DocumentorKB.
   • Section Hashtag Link: You can get a link of a particular section using this option. Icon of the link appears on the front if it is enabled.
   • Save PDF: It is to enable or disable PDF option which is visible on the front end. You can set your personalized PDF format using PDF options. Using PDF option you can change font and font size of PDF.
   • Print: Documentor provides a facility to print data directly. You can find the print option in the front end of the guide.
3. Users can suggest Edits: If you want to hear suggestions from the users, you can enable this option. The Guide Manager will receive an email once the user submits a suggestion. You can choose or set the format of the suggestion box. You can even add or remove setting fields.
4. Guide Manager: Select a guide manager. All the suggestion edit and feedback emails will be sent to the selected guide manager.
5. Visitor’s Feedback: User can submit feedback if you have enabled this option. You can set up format and message for feedback box. Feedback mail will be sent to the guide manager.
6. Feedback Count: If this option is enabled then it will show the feedback count for the document.
7. Related: This option shows related menus. After you enable this option, a new Related tab appears, where you can choose a menu from the selection box to show below DocumentorKB’s menu on the front end.
8. RTL Support: DocumentorKB supports Right to Left reading. If you enable the RTL option, the content can be able to be read from right to left.
9. Back to Top button: If this option is enabled then there will be back to top button present at the bottom of the document that will take you towards the top of the document.
10. Social Sharing: If this option is enabled then the particular document can be shared through different social media platforms from the front end. One can also decide the format and position for the social media buttons that should appear on the front end.
11. Attach Product: If this option is enabled then you will be able to attach a particular product with the document along with the link and other details of the product.

How to add Breadcrumb in the Knowledge Base:

Now, in order to add Breadcrumb in the Knowledge Base, just install any Breadcrumb plugin for example, “Flexy Breadcrumb”.

Now, Login to your WordPress dashboard. Go to Appearance =>Widgets. You’ll see the “Before Knowledge Base” widget area. Just drag and drop the text widget into the widget area and paste the shortcode of the Breadcrumb plugin. Save the changes.

You can add any type of data in DocumentorKB, e.g. Images, Videos, Gallery, Graphs and charts, Tables, Maps and many more.

1. Images:

To add images into document, Click on “Add Media” button and select image/images to add into section.

2. Videos:

Put video URL into section and video will get appear on the front end. e.g. https://www.youtube.com/watch?v=2cd4mDMsJOc

3. Image Gallery:

You can put a set of images or Portfolio or Gallery of Product screenshots in the Document, using WordPress Gallery Feature

4. Maps:

You can insert any type of Map like Google Map.
Example Google Map inserted using iframe embed code provided by Google:

5. Graphs and Charts:

You can embed any type of charts or graphs such as Google Charts or chart.js charts or using shortcode generated by any chart plugin on WordPress.

Example: Google Chart

6. Facebook Status:

Embed Facebook Status by using the Embed code:

Enable/Disable PDF:
To enable/disable PDF go to DocumentorKB=> All KnowledgeBases => Select your document => Edit section => Settings Tab => Advance settings => Buttons => Save PDF.

DocumentorKB provides you with the option to generate PDF. Once you have completed with your section insertion, hit Generate PDF button to generate it. After the successful generation of PDF, you’ll receive a message on the screen. Every time you make changes in the sections you need to generate PDF, else the older generated PDF will get downloaded from the front end. After PDF generation pdf symbol will appear on the front end.

Generate PDF button:
In order to generate PDF of the section, just click on the “Generate PDF” link under every section.

PDF options: 
You can find many options regarding the format of PDF file. You can change font and font size of each type of content from Header, Footer, Title etc.

Language Support:
DocumentorKB is WPML compatible. You can generate a PDF file in any language. You need to add sections in your language and generate PDF after insertion is done. Your generated PDF file will get saved and on user end generated PDF file will get downloaded. Before that, you need set font to “free serif” from PDF options to all type of contents e.g PDF title, PDF subtitle, TOC menu title, Section title, Section Contents.

You can see the preview before embedding it on the front end, Go to Admin panel => DocumentorKB => All Knowledge Bases => All created document list will appear => Choose your document and click on preview link, which is available below the document name.

In preview of document, most of features are not supported.

 

You can delete particular, Go to Admin panel => DocumentorKB => All Knowledge Bases => All created document list will appear => Choose your document and click on Delete link, which is available below document name. Your document will get deleted.

If you do not want to modify the Default Settings every time a new Guide is created, on the Create New Knowledge Base Panel, you can choose which Guide’s settings you want to inherit.

You can import the document created on localhost. Go to Admin panel => DocumentorKB => All Knowledge Bases => you will find the “Import” button on the top-right side of a page. => Choose your file and hit import

Yes, Menu title and Section both are different. Menu title appears on the left of the document and section title appears on content.

To delete a particular section, Goto Admin Panel >> DocumentorKB >> All KnowledgeBases >> selecting the particular section. When the section will get open then one will find the Remove option to delete the particular section from the bottom. Once the changes are done then hit the Save button.

DocumentorKB allows you to add external links as a menu. Go to Add section of DocumentorKB, where you can find links section. Put your menu title, respective link and insert section. To open link in new tab, enable below “Open in new window” checkbox.

To enable go to Admin panel => DocumentorKB => All KnowledgeBases => Edit => Settings => Advance settings => Show Related, enable option and save changes. After enable this option new Related tab get appeared, where you can choose menu from selection box to show below documentor menu on front end.

Go to Admin panel => Documentor => All KnowledgeBases => Edit => Settings => Basic settings => Indexing Format, disable option and save changes. Your indexing format will not appeared on front end.

Go to Admin panel => Documentor => All KnowledgeBases=> Edit => Settings => Basic settings => Fixed menu, disable option and save changes.

Yes, you can disable it, for user view. Go to Admin panel => DocumentorKB => All KnowledgeBases=> Edit => Settings => Advance settings => Users can suggest Edits, disable option and save changes.

You can add or remove fields from Suggest Edit form, Go to Admin panel => Documentor => All KnowledgeBases => Edit => Settings => Advance settings => Users can suggest Edits. You will find the Format link. After link on that, suggest form template will get open where you can add or remove fields.

You can select the Knowledge Base manager, who can manage all stuff regarding document changes and suggestion mails.

Go to Admin panel => DocumentorKB => All KnowledgeBases => Edit => Settings => Advance settings => Visitor’s Feedback. Disable respective option and save changes. On front end feedback option will not appeared.

Yes, you can edit the feedback form. Go to Admin panel => DocumentorKB => All KnowledgeBases=> Edit => Settings => Advance settings => Visitor’s Feedback. You will find format link, where you can add or remove fields in the form.

You can add widgets above the Knowledge Base. Go to Appearance => Widgets.

You’ll be able to see the “Before Knowledge Base” widget area. Drag and drop the required widget in the “Before Knowledge Base” widget area.

You can also add widgets to your Knowledge Base. Go to Appearance => Widget. You’ll see a new widget area “Knowledge Base Below Content”. Just Drag and Drop the required widget to this widget area.

DocumentorKB supports video. You can show it on the front end. Paste your YouTube video URL into section and update section. Videos will automatically appear on the front end.

You can insert any type of Map like Google Map.
Example Google Map inserted using iframe embed code provided by Google:

Almost all the shortcodes will be working when embedded into the Guide. You can directly put shortcode into section and save.

You can change font of PDF file, go to Admin Panel => DocumentorKB => All KnowledgeBases => Edit => Settings => Advance Settings => Buttons => Save PDF => option. One form will get open, in which you can change font and font size.

Sometimes it may occur the PDF created may not look similar to what it displays on the web page. Therefore, you have an option to upload your custom created PDF to your Knowledge Base. Hence, the end user who will click on the PDF icon will get the custom PDF downloaded.

How to upload a Custom PDF:

1. Go to DocumentorKB => Edit the Knowledge Base.
2. Click on the Section of which you want to upload the PDF
3. Click on edit and Scroll down where you’ll find the DocumentorKB PDF File option.
4. Upload your custom PDF and update the changes.
5. Go back to your Knowledge Base and generate the PDF again.