Getting Started Tips
Markup Language
You should note that the markup language resembles, but it not the same as HTML.
The syntax available is described in Our Syntax Guide (visible after authentication).
Although many examples are shown in the syntax guide, there are some Retro1.Org specific extensions present here which support the specialized documentation for pages like the DtCyber manual. The Extended Backus-Naur extension enables syntax like this:
<ebnf> "dtCyber Command Line" {
command = "dtcyber" ( ( "/?" | "-?" ) | ( section_name ( file_name ) ) ).
}</ebnf>
To render the following diagram:
Copying An Existing Page
If you want to 'carry forward' an old page and rework it. You may copy any of the old pages using the right-hand navigator from the page you wish to copy:
When prompted ' just change the root node of the new page name 'cfarchive' to 'members' and then any subordinate, colon-delimited name to position the copy in the Members Section page hierarchy. You will not be able to write to any root node other than 'members'. Valid WIKI page names consist of any lower case string of alpha-numeric characters, dots('.') or underscores('_'). Invalid characters will automatically be replaced by underscores for you.
The 'start' page name is the 'landing page' for any subordinate hierarchy section. You may feel free to borrow ideas from any other page if you want to tailor the 'start' page for any subsection.
If you just want to create a page from 'scratch'' you may do that by entering the page name into the 'Add Page' box:
That brings up the editor page into which you can type whatever content you want.
Click Preview
And when you're done, just click Save,
A note about extensibility:
There are many Syntax extensions added to help people who are already familiar with MarkDown, MediaWIKI Tables, and other syntaxes, use them in this context without a ton of additional learning.
Of particular note:
It takes a little practice, but the in-built editor's toolbar helps create the markup language. It's quirky to people who are used to a What You See Is What You Get Editor.
- Syntax Plugins have documentation links at the bottom of the Syntax help page.
- There is EBNF Support for Syntax Diagrams.
- Syntax highlighting is supported for over 100 languages.
- You may create drawings and embed them directly to help illustrate whatever you want. The embeddings are from DIAGRAMS.NET . While editing a page, you can insert a drawing using the 'insert image' icon in the editor:
and then select 'Create A Diagram'
Documentation Patterns
Many more examples of documentation patterns may be found in the article Documentation Patterns