| 1 | [:page:PageHeader][:toc:]
|
|---|
| 2 | + Wiki Pad Help Style Guide
|
|---|
| 3 |
|
|---|
| 4 | As the user base of WikidPad increases continously, we did a full refactoring of these pages.
|
|---|
| 5 |
|
|---|
| 6 | The objective of this page is to document and to explain the architecture and styles we have applied.
|
|---|
| 7 |
|
|---|
| 8 | ++ Structure of any regular Page
|
|---|
| 9 |
|
|---|
| 10 | Any regular page of this help wiki is build as follows:
|
|---|
| 11 |
|
|---|
| 12 | * First Line: including the PageHeader and the (local) ToC
|
|---|
| 13 | * Second Line: First Level Header-1 - using "+ 'WikiWord of WikiPage'"
|
|---|
| 14 | * Third Line: empty line.
|
|---|
| 15 | * body of the page
|
|---|
| 16 | * Two blanc lines
|
|---|
| 17 | * Last Line: including the PageFooter, followed by applicable WikiDocumentAttributes.
|
|---|
| 18 |
|
|---|
| 19 | ++ The First Line
|
|---|
| 20 |
|
|---|
| 21 | Obviously, the single line \[:page:PageHeader]\[:toc:] on top serves two purposes:
|
|---|
| 22 |
|
|---|
| 23 | +++ A general Navigation Table
|
|---|
| 24 |
|
|---|
| 25 | \[:page:PageHeader] allows for a table of important links to be offered anywhere,
|
|---|
| 26 | thus improving the already excellent navigation capabilities of WikidPad.
|
|---|
| 27 |
|
|---|
| 28 | And such can be removed or adjusted in one central place, if needed.
|
|---|
| 29 | You may even empty the content of PageHeader in order to make it's effect invisible.
|
|---|
| 30 |
|
|---|
| 31 | +++ An OverView of the HeadLines
|
|---|
| 32 |
|
|---|
| 33 | Using \[:toc:] gives a comprehensive overview of all headers defined in the page,
|
|---|
| 34 | and should allow easy navigation especially in lengthy pages without any need to
|
|---|
| 35 | use the PageStructureWindow
|
|---|
| 36 |
|
|---|
| 37 | +++ Beware exported results!
|
|---|
| 38 |
|
|---|
| 39 | So far, any such navigation aid can also be accomplished by means build into WikidPad.
|
|---|
| 40 | Alas: if You export a WiKi e.g. to [HTML pages], all these build in functionalities are
|
|---|
| 41 | not available any more.
|
|---|
| 42 |
|
|---|
| 43 | ++ The Last Line
|
|---|
| 44 |
|
|---|
| 45 | Intentionally, all relevant attributes are kept in the last line.
|
|---|
| 46 |
|
|---|
| 47 | Somtimes, this line may not be easy to read -on first glance.
|
|---|
| 48 |
|
|---|
| 49 | Alas: keeping the attributes together with the PageFooter allows for global SearchingTheWiki
|
|---|
| 50 | thereby keeping complete control of what-is-used-where.
|
|---|
| 51 |
|
|---|
| 52 | We believe, gives an important advantage for the ongoing maintenance of the pages.
|
|---|
| 53 |
|
|---|
| 54 | ++ Applicable WikiDocumentAttributes
|
|---|
| 55 |
|
|---|
| 56 | Following WikiDocumentAttributes are used in the last line, and preferably in the following order:
|
|---|
| 57 |
|
|---|
| 58 | +++ icon:
|
|---|
| 59 |
|
|---|
| 60 | ++++ Grouping Icons
|
|---|
| 61 |
|
|---|
| 62 | +++++ icon: list
|
|---|
| 63 |
|
|---|
| 64 | +++++ icon: left-right
|
|---|
| 65 | [Icon left-right] is used for the pages regarding the [Menus]
|
|---|
| 66 |
|
|---|
| 67 | +++++ icon: spanner
|
|---|
| 68 | [Icon spanner] is used for Example Pages such as ExampleInsertions.
|
|---|
| 69 |
|
|---|
| 70 | ++++ Special Purpose Icons
|
|---|
| 71 |
|
|---|
| 72 | +++++ icon: cog
|
|---|
| 73 | [Icon cog], which is also used by WikidPad for the [Func. pages] in the [Tree View]
|
|---|
| 74 | is used for the page abut WikiMaintenance.
|
|---|
| 75 |
|
|---|
| 76 | +++++ icon: disk
|
|---|
| 77 | [Icon disk] is used for the page about AutoSave.
|
|---|
| 78 |
|
|---|
| 79 | +++++ icon: folder
|
|---|
| 80 | [Icon folder] is used for the pages related to directories such as
|
|---|
| 81 | the [installation directory] or the [data directory].
|
|---|
| 82 |
|
|---|
| 83 | +++++ icon: console
|
|---|
| 84 | [Icon console] is used for the page about CommandLineSupport.
|
|---|
| 85 |
|
|---|
| 86 | +++++ icon: lens
|
|---|
| 87 | [Icon lens] is used for the pages IncrementalSearch and SearchingTheWiki.
|
|---|
| 88 |
|
|---|
| 89 | +++++ icon: pin
|
|---|
| 90 | [Icon pin] is used for the page about TodoItems.
|
|---|
| 91 |
|
|---|
| 92 | +++++ icon: rename
|
|---|
| 93 | [Icon rename] is used for the page about RenamingWikiWords.
|
|---|
| 94 |
|
|---|
| 95 | +++++ icon: question
|
|---|
| 96 | [Icon question] is used for the page about WhereIsTheDataStored.
|
|---|
| 97 |
|
|---|
| 98 |
|
|---|
| 99 | +++ alias:
|
|---|
| 100 |
|
|---|
| 101 | +++ short_hint:
|
|---|
| 102 |
|
|---|
| 103 | +++ camelCaseWordsEnabled: false
|
|---|
| 104 |
|
|---|
| 105 | +++ child_sort_order: natural
|
|---|
| 106 |
|
|---|
| 107 | +++ bookmarked: true
|
|---|
| 108 |
|
|---|
| 109 | +++ tree_position:
|
|---|
| 110 |
|
|---|
| 111 |
|
|---|
| 112 | ++ Naming Conventions for WikiPages
|
|---|
| 113 |
|
|---|
| 114 |
|
|---|
| 115 | ++ Exceptions
|
|---|
| 116 |
|
|---|
| 117 |
|
|---|
| 118 | [:page:PageFooter] |
|---|
