Difference between revisions of "Help:Contents"

From RadioNerds
Jump to navigation Jump to search
(Created page with "== Text formatting markup == {| class="wikitable" ! Description ! width=40% | You type ! width=40% | You get |- ! colspan="3" style="background: #ABE" | Character (inline) fo...")
 
 
(17 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
== Text formatting markup ==
 
  
−
{| class="wikitable"
 
−
! Description
 
−
! width=40% | You type
 
−
! width=40% | You get
 
−
|-
 
−
! colspan="3" style="background: #ABE" | Character (inline) formatting – ''applies anywhere''
 
−
|-
 
−
| Italic text
 
−
| <pre>
 
−
''italic''
 
−
</pre>
 
−
|
 
−
''italic''
 
−
|-
 
−
| Bold text
 
−
| <pre>
 
−
'''bold'''
 
−
</pre>
 
−
|
 
−
'''bold'''
 
−
|-
 
−
| Bold and italic
 
−
| <pre>
 
−
'''''bold & italic'''''
 
−
</pre>
 
−
|
 
−
'''''bold & italic'''''
 
−
|-
 
−
| Strike text
 
−
| <pre>
 
−
<strike> strike text </strike>
 
−
</pre>
 
−
|<strike> strike text </strike>
 
−
|-
 
−
| Escape wiki markup
 
−
| <pre>
 
−
&lt;nowiki&gt;no ''markup''&lt;/nowiki&gt;
 
−
</pre>
 
−
|
 
−
<nowiki>no ''markup''</nowiki>
 
−
|-
 
−
| Escape wiki markup once
 
−
| <pre>
 
−
[[API]]&lt;nowiki/>extension
 
−
</pre>
 
−
|
 
−
[[API]]<nowiki/>extension
 
−
|-
 
−
! colspan="3" style="background: #ABE" | Section formatting – ''only at the beginning of the line''
 
−
|-
 
−
| Headings of different levels
 
−
| <pre>
 
  
−
== Level 2 ==
 
  
−
=== Level 3 ===
 
  
−
==== Level 4 ====
+
==Quick Start==
 +
Creating a new page on a wiki can be counter intuitive, these instructions will get you though the basic steps.
 +
 
 +
{{message|You must be logged in the add a page!}}
 +
 
 +
 
 +
 
 +
;1) Search the wiki for your topic, enter the text in several ways to make sure its not already there.
 +
 
 +
 
 +
;2) if your satisfied that the topic is missing, search for it one more time, this time use the EXACT TERM you want your new page title to be.
 +
 
 +
[[File:help-1.png]]
 +
 
  
−
===== Level 5 =====
+
;3) When the query comes back, you will see the title listed in red near the top left of the page.  Click on the red link to create the new page.
  
−
====== Level 6 ======
+
[[File:help-2.png]]
  
−
</pre>
 
−
----
 
−
{{note|
 
−
* [[Help_talk:Formatting#Level_1|Skip Level 1]], it is page name level.
 
−
* An article with 4 or more headings automatically creates a [[wikipedia:Wikipedia:Section#Table of contents (TOC)|table of contents]].
 
−
}}
 
−
|
 
  
−
<!-- using HTML markup to avoid creating new sections -->
+
;4) Enter your new text for the page as required.
−
<h2>Level 2</h2>
 
  
−
<h3>Level 3</h3>
+
[[File:help-3.png]]
  
−
<h4>Level 4</h4>
 
  
−
<h5>Level 5</h5>
 
  
−
<h6>Level 6</h6>
+
==Adding Manuals==
  
−
|-
+
To add a manual I use the following template:
−
| Horizontal rule
 
−
| <pre>
 
−
Text before
 
−
----
 
−
Text after
 
−
</pre>
 
−
|
 
−
Text before
 
−
----
 
−
Text after
 
−
|-
 
−
| Bullet list
 
−
|
 
 
<pre>
 
<pre>
−
* Start each line
+
;{{pdf|TM-11-5820-477-12.pdf|TM 11-5820-477-12}}
−
* with an [[Wikipedia:asterisk|asterisk]] (*).
+
:Operator’s and Organizational Maintenance Manual for Radio Set Control Groups
−
** More asterisks give deeper
+
::AN/GRA-39 (NSN 5820-00-889-3680)
−
*** and deeper levels.
+
::AN/GRA-39A (NSN 5820-00-889-5654 )
−
* Line breaks <br />don't break levels.
+
::AN/GRA-39B (NSN 5820-00-949-9909)
−
*** But jumping levels creates empty space.
+
::AN/GRA-39C (NSN 5820-01-196-0204)
−
Any other start ends the list.
+
::2 January 1989
 
</pre>
 
</pre>
−
|
 
−
* Start each line
 
−
* with an [[Wikipedia:asterisk|asterisk]] (*).
 
−
** More asterisks give deeper
 
−
*** and deeper levels.
 
−
* Line breaks <br />don't break levels.
 
−
*** But jumping levels creates empty space.
 
−
Any other start ends the list.
 
−
|-
 
−
| Numbered list
 
−
|
 
−
<pre>
 
−
# Start each line
 
−
# with a [[Wikipedia:Number_sign|number sign]] (#).
 
−
## More number signs give deeper
 
−
### and deeper
 
−
### levels.
 
−
# Line breaks <br />don't break levels.
 
−
### But jumping levels creates empty space.
 
−
# Blank lines
 
  
−
# end the list and start another.
 
−
Any other start also
 
−
ends the list.
 
−
</pre>
 
−
|
 
−
# Start each line
 
−
# with a [[Wikipedia:Number_sign|number sign]] (#).
 
−
## More number signs give deeper
 
−
### and deeper
 
−
### levels.
 
−
# Line breaks <br />don't break levels.
 
−
### But jumping levels creates empty space.
 
−
# Blank lines
 
  
−
# end the list and start another.
+
 
−
Any other start also
+
==Adding Image Galleries==
−
ends the list.
+
 
−
|-
 
−
| Definition list
 
−
| <pre>
 
−
;item 1
 
−
: definition 1
 
−
;item 2
 
−
: definition 2-1
 
−
: definition 2-2
 
−
</pre>
 
−
|
 
−
;item 1
 
−
: definition 1
 
−
;item 2
 
−
: definition 2-1
 
−
: definition 2-2
 
−
|-
 
−
| Indent text
 
−
| <pre>
 
−
: Single indent
 
−
:: Double indent
 
−
::::: Multiple indent
 
−
</pre>
 
−
----
 
−
{{Note|This workaround may harm accessibility.}}
 
−
|
 
−
: Single indent
 
−
:: Double indent
 
−
::::: Multiple indent
 
−
|-
 
−
| Mixture of different types of list
 
−
|
 
 
<pre>
 
<pre>
−
# one
+
==Images==
−
# two
+
<gallery widths=100px heights=100px perrow=5>
−
#* two point one
+
File:gra-39.jpg
−
#* two point two
+
File:Gra-39-l.gif
−
# three
+
File:gra39r.gif
−
#; three item one
+
</gallery>
−
#: three def one
 
−
# four
 
−
#: four def one
 
−
#: this looks like a continuation
 
−
#: and is often used
 
−
#: instead <br />of &lt;nowiki><br />&lt;/nowiki>
 
−
# five
 
−
## five sub 1
 
−
### five sub 1 sub 1
 
−
## five sub 2
 
 
</pre>
 
</pre>
−
----
 
−
{{note|The usage of <code>#:</code> and <code>*:</code> for breaking a line within an item may also harm accessibility.}}
 
−
|
 
−
# one
 
−
# two
 
−
#* two point one
 
−
#* two point two
 
−
# three
 
−
#; three item one
 
−
#: three def one
 
−
# four
 
−
#: four def one
 
−
#: this looks like a continuation
 
−
#: and is often used
 
−
#: instead <br />of <nowiki><br /></nowiki>
 
−
# five
 
−
## five sub 1
 
−
### five sub 1 sub 1
 
−
## five sub 2{{anchor|pre}}
 
−
|-
 
−
| Preformatted text
 
−
| <pre>
 
−
Start each line with a space.
 
−
Text is '''preformatted''' and
 
−
''markups'' '''''can''''' be done.
 
−
</pre>
 
−
----
 
−
{{note|This way of preformatting only applies to section formatting. Character formatting markups are still effective.}}
 
−
|
 
−
Start each line with a space.
 
−
Text is '''preformatted''' and
 
−
''markups'' '''''can''''' be done.
 
−
|-
 
−
| Preformatted text blocks
 
−
| <pre> <nowiki><nowiki>Start with a space in the first column,
 
−
(before the <nowiki>).
 
  
−
Then your block format will be
 
−
    maintained.
 
−
 
−
This is good for copying in code blocks:
 
  
−
def function():
 
−
    """documentation string"""
 
  
−
    if True:
+
Copy that into the page, then edit the sections as appropriate:
−
        print True
+
:The top line is
−
    else:
+
::<pre>;{{pdf | FILENAME.PDF |  DISPLAY NAME }}</pre>  
−
        print False</nowiki></nowiki>
+
:Add the filename as you '''want it to be, not what it is'''  you will be able to upload it and rename it to this in one process.  we are naming files based on the TM number, try to stick to that.
−
</pre>
+
 
−
|
+
:The Center section:
−
<nowiki>Start with a space in the first column,
+
::<pre>: TITLE
−
(before the <nowiki>).
+
::MODEL(s) </pre>
 +
 
 +
:The Last Section is the date of the manual
 +
::<pre>::DATE IN THE SAME FORMAT ON THE MANUAL</pre>
 +
 
 +
Don't stress if it's not perfect, we can always fix it later.
 +
 
 +
When you save it, the link will be red, just click on it, and it will take you to an upload form with the FILENAME pre-filled, just browse for the file on your drive and upload.
  
−
Then your block format will be
 
−
    maintained.
 
  
−
This is good for copying in code blocks:
 
  
−
def function():
 
−
    """documentation string"""
 
  
−
    if True:
+
__NOTOC__
−
        print True
 
−
    else:
 
−
        print False</nowiki>
 
−
|}
 

Latest revision as of 18:46, 7 October 2013



Quick Start

Creating a new page on a wiki can be counter intuitive, these instructions will get you though the basic steps.

Idea.png
You must be logged in the add a page!


1) Search the wiki for your topic, enter the text in several ways to make sure its not already there.


2) if your satisfied that the topic is missing, search for it one more time, this time use the EXACT TERM you want your new page title to be.

Help-1.png


3) When the query comes back, you will see the title listed in red near the top left of the page. Click on the red link to create the new page.

Help-2.png


4) Enter your new text for the page as required.

Help-3.png


Adding Manuals

To add a manual I use the following template: 

;{{pdf|TM-11-5820-477-12.pdf|TM 11-5820-477-12}}
:Operator’s and Organizational Maintenance Manual for Radio Set Control Groups
::AN/GRA-39 (NSN 5820-00-889-3680)
::AN/GRA-39A (NSN 5820-00-889-5654 )
::AN/GRA-39B (NSN 5820-00-949-9909) 
::AN/GRA-39C (NSN 5820-01-196-0204) 
::2 January 1989


Adding Image Galleries

==Images==
<gallery widths=100px heights=100px perrow=5>
File:gra-39.jpg
File:Gra-39-l.gif
File:gra39r.gif
</gallery>


Copy that into the page, then edit the sections as appropriate:

The top line is 
;{{pdf | FILENAME.PDF |  DISPLAY NAME }}
Add the filename as you want it to be, not what it is you will be able to upload it and rename it to this in one process. we are naming files based on the TM number, try to stick to that.
The Center section: 
: TITLE
MODEL(s)
The Last Section is the date of the manual 
::DATE IN THE SAME FORMAT ON THE MANUAL

Don't stress if it's not perfect, we can always fix it later.

When you save it, the link will be red, just click on it, and it will take you to an upload form with the FILENAME pre-filled, just browse for the file on your drive and upload.



Retrieved from "http://www.radionerds.com/index.php?title=Help:Contents&oldid=6697"