DLXS Style Guide
From DLXS Documentation
(→Text formatting markup) |
|||
| Line 1: | Line 1: | ||
<big><font color= "green">(DRAFT! a work in progress)</font></big> | <big><font color= "green">(DRAFT! a work in progress)</font></big> | ||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| + | = Basics = | ||
== Text formatting markup == | == Text formatting markup == | ||
| - | {| cellpadding=" | + | {| cellpadding="15" cellspacing="0" border="1" |
! Style | ! Style | ||
! When to use | ! When to use | ||
| Line 56: | Line 46: | ||
</pre> | </pre> | ||
(everything before the pipe | won't show) | (everything before the pipe | won't show) | ||
| - | |||
and NOT: | and NOT: | ||
| Line 65: | Line 54: | ||
</pre> | </pre> | ||
This isn't the best way to create a new page, it names the page whatever is in the brackets, and then forevermore you have to remember that it's not called "Sample Makefile.html" or something more intuitive when you want to link to it. | This isn't the best way to create a new page, it names the page whatever is in the brackets, and then forevermore you have to remember that it's not called "Sample Makefile.html" or something more intuitive when you want to link to it. | ||
| + | |||
| + | |||
| + | = Advanced Markup = | ||
| + | == Release markup == | ||
| + | Additions about a forthcoming release should just be added to any relevant pages as a new paragraph. Header tags should also be used and the paragraph should be given a title "Release X" so it can be easily searched and integrated when the release is ready. more... | ||
| + | |||
| + | For example: | ||
| + | |||
| + | |||
| + | <font color= "red">Release X</font> | ||
| + | <p style="background-color:#ff9;"> | ||
| + | Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Praesent velit. Curabitur non turpis sit amet nulla viverra feugiat. Ut sit amet pede. In hac habitasse platea dictumst. Nam ultrices. Duis pellentesque augue non velit. In nisi. Aenean nonummy. Fusce quis ligula nec nisi rhoncus adipiscing. Nullam laoreet nibh sed lacus. Quisque aliquam turpis id nibh. Nunc faucibus justo at dolor. Integer blandit est vel sem. Sed suscipit lorem sed mi tincidunt elementum. | ||
| + | </p> | ||
Revision as of 13:28, 9 October 2007
(DRAFT! a work in progress)
Contents |
Basics
Text formatting markup
| Style | When to use | Markup | Example |
|---|---|---|---|
| Citation | Use when you need to display code that is used by the wiki | <cite>lorem ipsum</cite> | lorem ipsum |
| pre | Use when displaying large chunks of code that you want to set apart from rest of text | <pre>lorem ipsum</pre> | lorem ipsum |
| code | Use when displaying in line code (code embedded in other text) | <code>lorem ipsum</code> | This is a sentence with a bit of code
|
| tt | Use when ??? | <tt>lorem ipsum</tt> | lorem ipsum |
| nowiki | Use when you need to display code that is used by the wiki | <nowiki><code>lorem ipsum</code></nowiki> | <code>lorem ipsum</code> |
Linking
The preferable way of linking to a file is:
[[Sample Makefile.html|Makefile.html click here]]
(everything before the pipe | won't show)
and NOT:
"For more information about the [[Makefile.html click here]]."
This isn't the best way to create a new page, it names the page whatever is in the brackets, and then forevermore you have to remember that it's not called "Sample Makefile.html" or something more intuitive when you want to link to it.
Advanced Markup
Release markup
Additions about a forthcoming release should just be added to any relevant pages as a new paragraph. Header tags should also be used and the paragraph should be given a title "Release X" so it can be easily searched and integrated when the release is ready. more...
For example:
Release X
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Praesent velit. Curabitur non turpis sit amet nulla viverra feugiat. Ut sit amet pede. In hac habitasse platea dictumst. Nam ultrices. Duis pellentesque augue non velit. In nisi. Aenean nonummy. Fusce quis ligula nec nisi rhoncus adipiscing. Nullam laoreet nibh sed lacus. Quisque aliquam turpis id nibh. Nunc faucibus justo at dolor. Integer blandit est vel sem. Sed suscipit lorem sed mi tincidunt elementum.
