Ponydocs

Build content in Ponydocs

Download manual as PDF

Download topic as PDF

Create and edit a topic

Once you've created a product, a version for the product, a manual and a table of contents for that product, you can create topics.

When you add a topic name to a TOC file and then save that file, the topic you named is created. To access it for initial editing, click on the topic name from the TOC file.

Topics and version tags

By default, when a topic is created by saving a TOC file, it is automatically tagged with all the versions that the TOC file was tagged with. If a topic only applies to a subset of the versions supported by the TOC, remove the other version tags, being careful not to remove or leave any extra brackets, and then re-save the topic before proceeding.

Things to know when creating or editing a topic

  • The H1 is by default the original topic name you used when you created it in the TOC file.
  • You can't use question marks, colons, hash signs, or slashes in filenames, but you can add them back in in the H1 within the topic if needed.
  • You can change the H1 to be something else (for example, to re-include : or ? symbols if they're needed) and this will also be reflected in the left-hand navigation shown to the user.
  • A topic can only have one H1 in it.

Markup in Ponydocs

Ponydocs is built on top of a standard MediaWiki installation, and uses the standard MediaWiki markup.

Adding graphics

To include a graphic in a topic, use the Upload file link in the Toolbox, then link to that graphic using the MediaWiki linking syntax.

PREVIOUS
Create a table of contents
  NEXT
Link to other topics

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