DLXS Style Guide
From DLXS Documentation
(Difference between revisions)
(→Sections & Paragraphs) |
|||
| Line 16: | Line 16: | ||
|- | |- | ||
| - | |Sections: | + | |'''Sections:''' using four or more headers on a page will create a table of contents (TOC) to appear in front of the first header. |
|<pre><nowiki> | |<pre><nowiki> | ||
= Section = | = Section = | ||
| Line 26: | Line 26: | ||
==== Sub-sub-sub-section ==== | ==== Sub-sub-sub-section ==== | ||
</nowiki></pre> | </nowiki></pre> | ||
| - | | | ||
| - | |||
| - | = Section = | ||
| - | |||
| - | == Sub-section == | ||
| - | |||
| - | === Sub-sub-section === | ||
| - | |||
| - | ==== Sub-sub-sub-section ==== | ||
| - | |||
|- | |- | ||
| - | |Paragraphs | + | |'''Paragraphs:''' leave a blank line between paragraphs |
|<pre><nowiki>Line one | |<pre><nowiki>Line one | ||
Line two</nowiki></pre> | Line two</nowiki></pre> | ||
| - | |Line one | ||
| - | |||
| - | Line two | ||
|} | |} | ||
Revision as of 18:18, 11 October 2007
(DRAFT! a work in progress)
Contents |
Basics
Page Titles
For consistency, major words in all page titles should be in capital letters.
Pages pertaining to specific classes should include that class in their page title. Ex. “Mounting the Collection Online” should be "Mounting the Text Class Collection Online."
Sections & Paragraphs
| ! | ! |
| Sections: using four or more headers on a page will create a table of contents (TOC) to appear in front of the first header. | = Section = == Sub-section == === Sub-sub-section === ==== Sub-sub-sub-section ==== |
| Paragraphs: leave a blank line between paragraphs | Line one Line two |
Text Formatting
| Style | When to use | Markup | Example |
|---|---|---|---|
| Bold | '''Bold text''' | Bold text | |
| Italic | ''Italicized text'' | Italicized text | |
| Bold & Italic | '''''Italicized & Bold text''''' | Italicized & Bold text | |
| Inline code | Use when displaying in line code (code embedded in other text) and names of scripts | This is a sentence with <code>a bit of code</code> in it. | This is a sentence with a bit of code in it.
|
| Blocks of code | Use when you want to display large blocks of code and keep original formatting. <code> should always go outside <pre> | <code><pre><ul> <li class="list">list item 1</li> <li class="list">list item 2</li> </ul></pre></code> | |
| Keep original formatting of text (not for code) | Use when displaying non-code text that you want to set apart from rest of text. (This can also be done with leading spaces, but is not recommended). | <pre>lorem ipsum</pre> | lorem
ipsum
|
| Show wiki markup | Use when you need to display code that is used by the wiki. | <nowiki><markup>lorem ipsum</markup></nowiki> | <markup>lorem ipsum</markup> |
| strikethrough | Use when you want to indicate that something no longer applies, but don't want to delete it yet. | <strikethrough>lorem ipsum</strikethrough> | |
| Citations | Use when you need to display code that is used by the wiki | <cite>lorem ipsum</cite> | lorem ipsum |
| block quote | For a long citation (not for code) that you want indented. | |<blockquote>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Integer eget sapien eu libero porttitor eleifend. Mauris ornare nunc a ligula. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos hymenaeos.</blockquote> | Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Integer eget sapien eu libero porttitor eleifend. Mauris ornare nunc a ligula. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos hymenaeos. |
Linking
| Style | Markup | Example |
|---|---|---|
| Link to another wiki page | Go to [[Installing_DLXS]] | Installing_DLXS |
| Link to another wiki page but have the link say something different | Go to [[Installing_DLXS|DLXS installation]] | DLXS installation |
| Link to a section within another wiki page | [[Installing_DLXS#Installation_Instructions]] | Installing_DLXS#Installation_Instructions |
| Link to a section on the current page | [[DLXS_style_guide#Advanced_Markup]] | DLXS_style_guide#Advanced_Markup |
| Link to a section on the current page but have the link say something different | [[DLXS_style_guide#Advanced_Markup|Advanced]] | Advanced |
| Link to an external (non-wiki) source | [http://en.wikipedia.org Wikipedia] | Wikipedia |
Lists
| Type | Markup | Example |
|---|---|---|
| Bullet list | * Item 1 ** Item 1.1 ** Item 1.2 * Item 2 ** Item 2.1 *** Item 2.1.1 *** Item 2.1.2 *** Item 2.1.3 ** Item 2.2 * Item 3 |
|
| Numbered list | # Item 1 ## Item 1.1 ## Item 1.2 # Item 2 ## Item 2.1 ### Item 2.1.1 ### Item 2.1.2 ### Item 2.1.3 ## Item 2.2 # Item 3 |
|
Tables
You can use wiki table formatting or html table formatting
<table cellpadding="5" cellspacing="0" border="1">
<tr>
<th>heading 1</th>
<th>heading 2</th>
</tr>
<tr>
<td>cell 1</td>
<td>cell 2</td>
</tr>
</table>
|
| ||||
{| cellpadding="15" cellspacing="0" border="1"
|-
!heading 1
!heading 2
|-
|cell 1
|cell 2
|}
OR
{| cellpadding="15" cellspacing="0" border="1"
|-
!heading 1 !! heading 2
|-
|cell 1 || cell 2
|}
|
|
Images
DLXS wiki list of uploaded images
| Style | Markup | Example |
|---|---|---|
| Basic image w/custom alt text | [[Image:DLXSlogo.gif|The DLXS logo]] | 
|
| Image w/custom alt text & floated to write | [[Image:DLXSlogo.gif|right|The DLXS logo]] Here is the DLXS logo floated to the right, if you put the image before the text, the text should wrap around it like this. | |
| Resize image | [[Image:DLXSlogo.gif|100px|The DLXS logo]] |
|
| Link directly to an image without displaying it: | [[:media:DLXSlogo.gif|Image of the DLXS logo]] | Image of the DLXS logo |
Comments
You can comment in the wiki the same way you would comment in html. Use when you want to leave comments only seen when in edit mode.
<!-- comment here -->
DLXS Custom Styles
| Style | When to use | Markup | Example |
|---|---|---|---|
| bug | [for use by DLXS staff only] use to alert users that there is a known bug in the software. Be sure to include the word 'Bug' for easy searching. | <div class="bug">'''Bug:''' We're working on it.</div> | Bug: We're working on it.
|
| release | [for use by DLXS staff only] Additions about a forthcoming release should just be added to any relevant pages as a new paragraph. Be sure to include the word 'Release X' (X being the release number) for easy searching. and integrated when the release is ready. | <div class="release"> '''Release X:''' Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Praesent velit. </div> | Release X: Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Praesent velit. |
| tip | Use to describe a tip for a particular procedure | <div class="tip">'''Tip:''' I found that doing x first really helps -suz</div> | Tip: I found that doing x first really helps -suz
|
| note | Use if you just want to describe something and have it stand out a bit more | <div class="note">'''Note:''' Make sure you first blah blah blah.</div> | Note: Make sure you first blah blah blah.
|
| Red Text | Make text red so it stands out (usually useful for key elements in a code snippet) | Here's what I have to say about <span class="redtext">this</span> and that's all. | Here's what I have to say about this and that's all. |
| Green Text | Make text green so it stands out (usually useful for key elements in a code snippet) | Here's what I have to say about <span class="greentext">this</span> and that's all. | Here's what I have to say about this and that's all. |
