Documentor Guide

Installation #

The easy way
1. Download the plugin (.zip file)
2. In your Admin, go to menu Plugins > Add
3. Select the tab “Upload”
4. Upload the .zip file you just downloaded
5. Activate the plugin
6. Documentor 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 `documentor` 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

Steps to create a new guide #

Using Documentor plugin, creating documentation is very easy task. You just need to put your data. Follow step by step process to create a document.

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

2. Head over Documentor menu and select create new option.

doc-create

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

4. Click on “Add Section” button to add sections in 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.

Add_sections

Inline: In inline section, you can create your own posts which are usable in Documentor. You can add media files in inline section e.g. images, videos and picture gallery.

Posts: This section will display all posts which are created in posts section of WordPress. You just need to select or search posts and insert into Documentor.

Pages: This section will display all pages which are created in Pages section of WordPress. You just need to select or search Pages and insert into Documentor.

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

6. After insert sections into Documentor, click on Edit button to see total sections added into Documentor. Once list appeared you can do following oprations

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 right side to make it as a nested or sub point. Hit Save button once nesting completed.

nested_doc

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

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

edit_delete1

7. Now go to Embed tab copy respective shortcode and paste it in post/page or use template tag in theme template file to display document on front end.

Embed Code #

Manage page: In the Documentor menu go to the Manage option that will list the document in list view along with shortcode and template tags.

doc-embed

Shortcode: Shortcode is a best and easy way to display document on front end. Use respective shortcode of document in post/page to display document on particular post/page.
Example Shortcode: [ documentor 1 ]

Template Tag: Use template tag of respective document in theme’s template file (e.g. page.php, single.php) to display document on every post/page.
Example Template tag:

Embed Tab: You can also find shortcode and template tag of document in “Embed Tab”. Go to in edit section of document and click on “Embed Tab” respective Shortcode and Template will get appear.

Quick Tag: You can add Documentor in post/page by using Quick tag. You will find quick tag of Documentor pro in Visual section of Edit post/page.

quick_tag1

Towards the top of Manage Guide there are following options that are present:

Create New: Besides creating a new guide from the Documentor menu from the left, one can also create a guide using this option.

Import: One can easily import the document that is created on the localhost using this option. Choose the file that you want to import and the document gets imported easily.

Settings Panel #

Basically, settings panel divided in 3 main parts
1. Basic Settings
2. Formatting Settings
3. Advance Settings

Basic Settings

Basic Settings contains following setting fields. This settings plays vital role in appearance of documentor.

basic-settings (1)

  1. Skin: Documentor have different skins such as: bar, broad, cherry and mint. Choose the particular skin for it.
  2. Section Animation: You can set animation to Documentor contents. While loading contents of Documentor animation will appear.
  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 click on Menu title content get visible in scrolling effect. You can enable or disable it. Default scrolling option is ON.
  6. Fixed Menu: It specify the location of 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.
  9. Toggle child menu: When Toggle child menu is enabled then instead of displaying the child section of the guide on the front end there will be a toggle menu displayed and when clicked it will display the child menu. By default it will be invisible.
  10. Extras on Section hover: When this option is enabled then it will not show the icons for each menu of the section unless it is hovered over it.

Formatting Settings

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

documentor_formatting

1. Nav Menu Title
  1. Use theme default: To use theme’s css to Nav Menu Title, you can keep option enable. If this option is enable then rest of setting of nav menu title will not applied on front-end.
  2. Color: Choose color from color picker box and save changes. Selected color will get applied to 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 font size of nav menu title.
  5. Font Style: You can change font style of nav menu title. if you selected google font from font then this field get hide.
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 is enable then this field is not applicable.
3. Section Title
  1. Use theme default: To use theme’s css to Section Title, you can keep option enable. If this option is enable then rest of setting of section title will not applied on front-end.
  2. Color: Choose color from color picker box and save changes. Selected color will get applied to 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 font size of section title.
  5. Font Style: You can change font style of section title. if you selected google font from font then this field get hide.
  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 use 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 applied on front-end.
  2. Color: Choose color from color picker box and save changes. 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 get changed.
  4. Font size: You can change font size of section contents.
  5. Font Style: You can change font style of section contents. if you selected google font from font then this field get hide.
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 provides you option to enable or disable email, user feedback, PDF and many more.

adv-doc

  1. Load Sections using AJAX: If you enable this option only active menu’s contents will get visible through AJAX.
  2. 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.
  3. Buttons: You can enable or disable this options as per your requirement. This all options are visible on front end of documentor.
    • Link: You can get link of particular section using this option. Icon of link is appeared on front if it is enable.
    • Email: This option is visible on front end. Using this option user can send mail to document owner.
    • Save PDF: It is for enable or disable PDF option which is visible on front end. You can set your personalized PDF format using PDF options. Using PDF options you can change font and font size of PDF.
    • Print: Documentor provides a facility to print data directly. on right side of document print option appeared if you enabled this option.
  4. Users can suggest Edits: If you want to hear suggestions for edit from users, you can enable this option. User mail will automatically send to guide manager of document. You can choose or set format for suggestion box. You can add or remove setting fields.
  5. Guide Manager: Select a guide manager. All suggestion edit and feedback email sent to selected guide manager.
  6. Visitor’s Feedback: User can submit feedback if you have enable this option. You can set up format and message for feedback box. Feedback mail will send to guide manager.
  7. Feedback Count: If this option is enabled then it will show the feedback count for the document.
  8. Related: This option shows related menus. 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.
  9. RTL Support: If this option is enabled then for the particular document right to left will be supported.
  10. 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.
  11. 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.
  12. Attach Product: If this option is enabled then one will be able to attach a particular product with the document along with the link and other details of the product.

Examples #

You can add any type of data in Documentor, 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.

image

2. Videos:

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

videos

3. Image Gallery:

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

gallery

4. Maps:

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

map

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

graphs

6. Facebook Status:

Embed Facebook Status by using the Embed code:

facebook

PDF Settings #

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

Documentor pro provides you option to generate PDF. Once you have completed with your section insertion, hit Generate PDF button to generate it. After successfully generation of PDF message will get appeared. Every time after changes in section you need to generate PDF else old generated PDF will get downloaded from front end. After PDF generation pdf symbol will appear on front end.

Generate PDF button (Disabled if loading through AJAX is On):
When Loading Sections using AJAX is disable then you will find Generate PDF button below all section on Edit page.

ajax_disable_1

Generate PDF button (Enabled if loading through AJAX is off):
When Loading Sections using AJAX is enable then you will find Generate PDF button in edit section of every section. You need to generate PDF for each section individually.

ajax_enable_1

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

pdf options

Language Support:
Documentor pro is WPML compatible. You can generate 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.

FAQ's #

How to Preview a created document on Admin Panel? #

You can see preview before embed on front end, Go to Admin panel => Documentor => Manage => 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.

preview

How to Delete a already created document? #

You can delete particular, Go to Admin panel => Documentor => Manage => 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.

delete-doc (1)

I want all my documents to have same Settings, how do I do that? #

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

setting_set

How to Import my guide from localhost to my actual site? #

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

import-doc (1)

What is Menu Title and Section Title? Can they be different? #

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

Title

How to delete a section from the Guide? #

To delete a particular section, Goto Admin Panel >> Documentor >> Manage >> 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.

delete

Can I Search and add my existing Posts or Pages to the Guide? #

Yes, you can add your existing post or pages, which are all ready created in WordPress. Go to in Add section, you will find Post and Page tab. using respective tab you can add them. You can search your choice post or page using search option.

search

The same way the user can also search the content from the front end that will list out all the related search result for it.

How to disable the Indexing i.e. 1.1, 2 in menu? #

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

indexing

How to disable Scroll Effect in case of one Page Guides? #

It is easy to disable the scrolling effect in case of Page Guides from: Go to Admin panel => Documentor => Manage => Edit => Settings => Basic settings => Scrolling, disable option and save changes.

scroll

How to enable content load via AJAX? #

AJAX loading allows you to load contents individually, in small place you can adjust big document. Go to Admin panel => Documentor => Manage => Edit => Settings => Advance settings => AJAX loading, enable option and save changes.

ajax

How to disable the Fixed position of the Menu or TOC? #

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

fix_menu

Can I disable the "Suggest Edit" option? #

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

suggest_edit

How can I add extra fields in "Suggest Edit" form? #

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

suggest_form

What is a guide manager? What is his role in Guide maintenance? #

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

guide manager

How can I disable "Visitor's Feedback"? #

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

visitor_feedback

Can I add fields to Negative Feedback Form? #

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

feedback_form

Where can I find the Embed Code? #

Go to Admin panel => Documentor => Manage => Edit => Embed code tab, where you can find Shortcode and Template tag of respective document. On manage page you will find all list of documents and it’s shortcode and template tags.

embed_code

Can I disable Inline Sections? I just want to add Posts and Pages to the Guide. #

To disable inline section, Go to Admin panel => Documentor => Global setting => Custom post. Disable that option and save changes. Inline section will not appeared in Add sections.

inline (1)

Can I disable adding Posts and Pages to the Guide, I just want to add custom section? #

Yes, you can do that go to Admin panel => Documentor => Custom Posts. Remove selection from of Posts and Pages from selection box and save changes.

glb (1)

Can I enable other Custom Posts to be selected and added as section to the Guide? #

Yes, you can do that go to Admin panel => Documentor => => Global settings Custom Posts. select sections from selection box and save changes.

glb (1)

How can I embed video into the Guide? #

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

videos

How can I embed Google Map? #

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

map

How can I embed Charts in the Guide? #

graphs

How can I embed tabs in the guide? #

Documentor plugin almost supports all types of shortcodes. You just need to embed Tabs shortcode into post/page and add that post/page into documentor. You can use WordPress Post Tabs. Using Wordress Posts Tabs’s Quick tag user can easily create tabs and paste the shortcode of WordPress Post Tabs inside the Documentor guide and the tabs will start appearing.

Can I put any shortcode inside the guide content? #

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

How can I change the font of PDF? #

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

pdf font (1)

How can I get a PDF in Chinese Language? #

Documentor supports WPML plugin. You can create PDF in any language. Add Chinese language post/pages into documentor and set PDf font to ‘Free Serif’ from Documentor => Manage => Edit => Settings => Advance Settings => Buttons => PDF options. After that Generate PDF.
If AJAX is enable then we will find ‘Generate PDF’ button in each individual section else AJAX is disable then below of sections.

Add Section:

doc_chinese

Font Selection:

font (1)

How can I get PDF if my Guide has Spanish content? #

Documentor supports WPML plugin. You can create PDF in any language. Add Spanish language post/pages into documentor and set PDf font to ‘Free Serif’ from Documentor => Manage => Edit => Settings => Advance Settings => Buttons => PDF options. After that Generate PDF.
If AJAX is enable then we will find ‘Generate PDF’ button in each individual section else AJAX is disable then below of sections.

Add Section:

doc_spanish

Font Selection:

font (1)

Is Documentor Responsive? #

Documentor plugin is responsive. You can open it on any device, e.g. Mobile phones, Tablets and computer monitor.

doc_mobile

I have embedded the document, but my content is not scrolling? #

Go to Admin panel => Documentor => Manage => Edit => Settings => Basic settings => Scrolling, disable option and save changes.

scrolling (1)

I want to change the font size of Suggest Edit to bold and italic, how should I do that? #

You can do that with documentor. Go to Admin panel => Documentor => Manage => Edit => Settings => Formatting => Section Contents => Font Style. Here you can change font style as per your requirement. If you have selected Google font from Font option then this field will not be there.

document_font

How to set minimum user level to create as well as Manage Guides? #

Goto Admin Panel >> Documentor >> Global Settings >> Minimum User Level to create and manage guides >> Select the User from the drop down and save the changes.

user level (1)

How to decide the Menu Position for the menus of the document? #

Goto Admin Panel >> Documentor >> Edit >> Settings >> Basic Settings >> Menu Position. Select the position for the Menu title either to the left or right and then save the changes.

menu position (1)

How to enable Social Sharing for the particular Document? #

Goto Admin Panel>> Documentor>> Manage>> Edit>> Settings>> Advanced Settings >> Social Sharing. One can also decide the format for social sharing from Format.

social sharing (1)

Also one can easily decide the Social Media buttons that are to be displayed, its format and the position where it is to be displayed.

social

How to attach Product with the particular Document? #

Goto Admin Panel >> Documentor >> Manage >> Edit >> Settings >> Advanced Settings >> Attach Product. The format for the product can be decided through Options.

attach product (1)

One can easily add the Name, Version and other details of the Product.

attach

How to change the size, color and opacity for the Scrollbar in a Document? #

Goto Admin Panel >> Manage >> Edit >> Settings >> Formatting Settings (Scrollbar Section) >> Size/ Color/ Opacity.

One can easily change the size and other details of the Scroll bar from here.

scroll

How to toggle child menu for the particular Document? #

One can enable this option from Admin Panel >> Manage >> Edit >> Settings >> Basic Settings >> Toggle child menu (enable)

When this setting is enabled then instead of displaying the child section of the guide, it will display the toggle that will display the child menu when it is clicked.

toggle (1)

How to add Last Updated Date for the particular Document? #

Goto Admin Panel >> Manage >> Edit >> Settings >> Formatting Settings (Section Content) >> Last Updated Date (Enable)

last update (1)

How to hide the extra icons from each of the menu and to show them on hover? #

Goto Admin Panel >> Manage >> Edit >> Settings >> Basic Settings >> Extras on Section hover (Enable)

When this option is enabled then initially it will hide all the options for the menu unless it is hovered over it.

hover (1)

How to use RTL Support for your content of the Document? #

Goto Admin Panel >> Manage >> Edit >> Settings >> Advanced Settings >> RTL Support (Enable)

Initially while creating the guide for the document this option is disable but when you want to display the content from Right to Left then this option is to be enabled.

RTL support

How to add Back to Top Button for the Document? #

Goto Admin Panel >> Documentor >> Manage >> Edit >> Settings >> Advanced Settings >> Back to Top Button (Enable)

When this option is enabled then there will be a button Back to Top at the front end that will directly take you towards the top of the Document that is added.

back to top (1)

Help Guide Powered by Documentor
Suggest Edit