tangcl
/
www-content
forked from enlightenment/www-content
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Wiki page documentation-guide.md changed with summary [sidebar -> navigation] by Andrew Williams

This commit is contained in:
Andrew Williams 2017-11-30 06:43:12 -08:00 committed by apache
parent a9b8498ad8
commit 64d919509d
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
pages/contrib/docs/documentation-guide.md.txt
View File

@ -239,11 +239,11 @@ Note that although Markdown does not require the numbers to be in the right orde
At present, sub-lists are only correctly rendered in unordered bullet list format and will not display correctly in numbered list format.
## Sidebars ##
## Navigation ##
Documentation namespaces should have *sidebars*, permanent boxes visible on all pages providing quick navigation through that namespace. These sidebars exist as a page named "sidebar" in the parent namespace.
Documentation namespaces should have *navigation* sidebars, permanent boxes visible on all pages providing quick navigation through that namespace. These navigation elements are controlled by a page named "navigation" in the root of each top level namespace. Each navigation file is a hierarchical list of links for the entire namespace tree - child pages will be displayed when the parent page is being displayed so we can keep the navigation manageable.
When creating a new document in a namespace, or moving an existing document, always update the sidebar. To do so, find the sidebar file: the sidebar for the "/contrib" namespace, for example, is "/contrib/sidebar".
When creating a new document in a namespace, or moving an existing document, always update the navigation file. To do so, find the right file for the namespace: the navigation file for the "/contrib" namespace, for example, is "/contrib/navigation".
The format of a sidebar is shown below:
@ -260,7 +260,7 @@ The format of a sidebar is shown below:
* [[/contrib/docs/eo | Eolian File Format]]
```
Note that these pages are in DokuWiki markup format, not Markdown Extra. Each entry in the sidebar should be in the form of a DokuWiki link; if the page to which you are linking has the DokuWiki title set in the frontmatter this will be pulled through and used as the display text. To override this title, or to link to a page which does not yet exist and thus has no title, use a pipe character followed by your preferred link text.
Note that these pages are in DokuWiki markup format, not Markdown Extra. Each entry in the navigation should be in the form of a DokuWiki link; if the page to which you are linking has the DokuWiki title set in the frontmatter this will be pulled through and used as the display text. To override this title, or to link to a page which does not yet exist and thus has no title, use a pipe character followed by your preferred link text.
> **NOTE:**
> Always include the ``.md`` extension when linking to a page in Markdown format. Although the link will work without it, DokuWiki will not be able to retrieve the title tag for sidebar display.