Primary

Widgets

Several widgets come with the Documentation plugin.The most important one in most applications is the Document Hierarchy widget as it provides an easily navigable overview of the documentation structure based on the overall documentation structure as well as the document that is currently viewed by the visitor.

Screen Shot 2015-04-23 at 23.36.35

Widget: Document Hierarchy

  • Title – unless empty, this is displayed as the widget’s title above its content.
  • Root depth – Indicate a number. Shows documents within the hierarchy from root documents (those documents without parents) up to the indicated level below the root. The default is 1, showing only documents at the very root level.
  • Documents above – Show parent documents above the current one up to how many levels?
  • Children of documents above – Show child documents of parent documents above the current one up to how many levels deep?
  • Documents below – Show child documents of the current one up to how many levels deep?

Widget: Document Children

  • Title
  • Children of … – Leave empty to show all documents. To show child documents for a specific document, indicate the document ID. To show child documents for the current document, indicate: {current}
  • Sublevel depth – Show documents within the hierarchy to how many levels deep?
  • Order by … – Sorting criteria. One or more options separated by comma. Choices are: post_title, menu_order, post_date, post_modified, ID, post_author and post_name.
  • Sort order – Ascending or descending.
  • Include documents – List of documents to include, indicate document IDs separated by comma.
  • Exclude documents – Indicate document IDs separated by comma.
  • Show author
  • Show date

Widget: Documents

  • Title
  • Number of documents – limits the number of entries displayed.
  • Order by …
  • Sort order
  • Category ID – Display documents in the specified categories when indicated or in the current category when {current} is indicated.
  • Show author
  • Show date
  • Show number of replies