Ticket #423 (accepted todo)
Asciidoc Guide for Lumiera Helpers
| Reported by: | ct | Owned by: | bjmr |
|---|---|---|---|
| Priority: | normal | Milestone: | |
| Component: | smallTasks | Keywords: | uwiki asciidoc doc |
| Cc: | Blocked By: | ||
| Blocking: |
Description
Write a small Guide showing what asciidoc features we use and how things shall be formatted.
Asciidoc offers some alternatives. To make our Documents consistent this needs to be documented. Such an guide will also help beginners as tiny reference for the most basic things when writing documentation.
examples:
For headers we use the underlined version in favor of preceeding/trailing ='s. How many empty lines before/after paragraphs and headers. What style for cross references and indices. General Style examples for common things, functions/parameter documentation, enumerations/lists and so on
Attachments
Change History
Changed 18 months ago by bjmr
-
attachment
quickstart.txt
added
comment:1 Changed 18 months ago by bjmr
- Owner set to bjmr
- Status changed from new to accepted
Most of this has been addressed in http://staging.lumiera.org/quickstart.txt
Some additional formatting notes should be added based on this ticket
Note: See
TracTickets for help on using
tickets.

quickstart.txt from bjmr's repo 8/2