Developers Documentation

×

Warning

0 error for file:https://clearos.com/dokuwiki2/lib/exe/css.php?t=dokuwiki&tseed=82873f9c9a1f5784b951644363f20ef8

User Tools

Site Tools


Developer Guide For App Documentation

ClearOS Webconfig contains contextual links to documentation landing pages within the Wiki. These landing pages are dynamically created and located in the :apps folder of this wiki. By default, you will not need to modify these documents as they will be automatically generated if you've created the appropriate external content.

Layout

Content of the wiki is scanned and these pages are conglomerations of links based on whether the content exists or not. The layout is as follows:

  • App Title
    • Auto generated title name if the app exists.
  • Icon
    • The icons are currently pulled from the icon directory of the training module.
  • Summary
    • Derived from a json web service call to app description
  • User Guides Section
    • Userguides which contain the proper label of the clearos version and the app-name will automatically get added in the userguide section. An example of the keywords that would make this work if your application was called 'Green Apples' would be 'clearos7, app-green-apples'
  • ClearOS versions
    • This is a subcategory, if your app is developed a version or for versions of ClearOS, include the versions for which your userguide applies into the keywords text. You can include multiple versions (ie. clearos6, clearos7)
  • Training
    • Links to training content
    • This pulls from tags in the relevant documents with the label 'training'
  • Best Practices / Whitepapers / Implementation Guides
    • This pulls from tags in the relevant documents with the label 'bestpractices'
  • Troubleshooting Guides
    • This pulls from tags in the relevant documents with the label 'troubleshooting'
  • Prototyping, Unsupported Methods, and Tricks
    • This pulls from tags in the relevant documents with the label 'skunkworks'
  • Help and Navigation
    • Common navigation links will be added
  • Keywords
    • Default keywords are added for search engine optimization

If content or a link does not appear on the page, there could be a syntax error associated with the base name NOT matching the actual app name or with the keywords added to the content that is supposed to be reference. Additionally, the script which creates this index must be run.

content/en_us/kb_wiki_appdocstyle.txt · Last modified: 2015/02/13 10:11 by dloper

https://clearos.com/dokuwiki2/lib/exe/indexer.php?id=content%3Aen_us%3Akb_wiki_appdocstyle&1569272739