Ponydocs

Build content in Ponydocs

Download manual as PDF

Download topic as PDF

Create a manual

Once you've created a product and a version for the product, you can create manuals.

To access the Manuals management page, use the following URL, substituting the server name for your own Ponydocs server in place of <yourponydocsserver>:

http://<yourponydocsserver>/Documentation:<product short name>:Manuals

The order in which the manuals are defined in the Manuals management page defines the order in which they are displayed in the list of manuals in the left hand navigation.

Note: A given manual will only appear in this list if there is a table of contents page defined for the manual for the currently selected version of documentation.

Syntax

Use the following syntax to define a new manual:

{{#manual:<manualshortname>|<manual display name>}}
  • <manualshort name> is what gets used in the URL for that manual.
  • <manual display name> is what is shown in the list of manuals the end user sees.

IMPORTANT: Do not use URL-unsafe characters such as : (colon), ? (question mark), / (forward slash), or spaces in the short name.

PREVIOUS
Create a version
  NEXT
Create a table of contents

This documentation applies to the following versions of Ponydocs: 1.0


Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters