DLXS Style Guide

From DLXS Documentation

(Difference between revisions)
Jump to: navigation, search
(→Text Formatting)
(→Text Formatting)
Line 17: Line 17:
! Example
! Example
|-
|-
-
|Citation
+
|Bold
 +
|
 +
|<nowiki>'''Bold text'''</nowiki>
 +
|'''Bold text'''
 +
|-
 +
|Italic
 +
|
 +
|<nowiki>''Italicized text''</nowiki>
 +
|''Italicized text''
 +
|-
 +
|Bold & Italic
 +
|
 +
|<nowiki>'''''Italicized & Bold text'''''</nowiki>
 +
|'''''Italicized & Bold text'''''
 +
|-
 +
|Citations
|Use when you need to display code that is used by the wiki
|Use when you need to display code that is used by the wiki
|<nowiki><cite>lorem ipsum</cite></nowiki>
|<nowiki><cite>lorem ipsum</cite></nowiki>
|<cite>lorem ipsum</cite>
|<cite>lorem ipsum</cite>
|-
|-
-
|pre
+
|Inline code
-
|Use when displaying '''large chunks of code''' that you want to set apart from rest of text. ''You do not need to use <nowiki><code> when using <pre></nowiki>''
+
-
|<nowiki><pre>lorem ipsum</pre></nowiki>
+
-
|<pre>lorem ipsum</pre>
+
-
|-
+
-
|code
+
|Use when displaying '''in line code''' (code embedded in other text) and '''names of scripts'''
|Use when displaying '''in line code''' (code embedded in other text) and '''names of scripts'''
|<nowiki>This is a sentence with <code>a bit of code</code> in it.</nowiki>
|<nowiki>This is a sentence with <code>a bit of code</code> in it.</nowiki>
|This is a sentence with <code>a bit of code</code> in it.
|This is a sentence with <code>a bit of code</code> in it.
 +
|-
 +
|Blocks of code
 +
|Use when you want to display large blocks of code and keep original formatting. ''<nowiki><code> should always go outside <pre></nowiki>''
 +
|<nowiki><code><pre><ul>
 +
<li class="list">list item 1</li>
 +
<li class="list">list item 2</li>
 +
</ul></pre></code></nowiki>
 +
|<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.
 +
|<nowiki><pre>lorem
 +
ipsum</pre></nowiki>
 +
|<pre>lorem
 +
ipsum</pre>
|-
|-
|nowiki
|nowiki
|Use when you need to display code that is used by the wiki
|Use when you need to display code that is used by the wiki
-
|<nowiki><nowiki><code>lorem ipsum</code></nowiki></nowiki>
+
|<nowiki><nowiki><markup>lorem ipsum</markup></nowiki></nowiki>
-
|<nowiki><code>lorem ipsum</code></nowiki>
+
|<nowiki><markup>lorem ipsum</markup></nowiki>
|-
|-
|strikethrough
|strikethrough

Revision as of 17:12, 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."

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
Citations Use when you need to display code that is used by the wiki <cite>lorem ipsum</cite> lorem ipsum
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> 
<ul>
  <li class="list">list item 1</li>
  <li class="list">list item 2</li>
</ul>
Keep original formatting of text (not for code) Use when displaying non-code text that you want to set apart from rest of text. <pre>lorem ipsum</pre> 
lorem 
     ipsum
nowiki 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> lorem ipsum

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


Images

DLXS wiki upload page

DLXS wiki list of uploaded images

Style Markup Example
Basic image w/custom alt text [[Image:DLXSlogo.gif|The DLXS logo]] 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.
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.
Image resized [[Image:DLXSlogo.gif|50 px]]
Link directly to an image without displaying it: [[:media:DLXSlogo.gif|Image of the DLXS logo]] Image of the DLXS logo

Comments

Advanced Markup

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.
Retrieved from "http://webservices.itcs.umich.edu/mediawiki/dlxs13/index.php/DLXS_Style_Guide"
Personal tools