Difference between revisions of "Help:Contents"

From RadioNerds
Jump to navigation Jump to search
Line 1: Line 1:
There are many ways to add data to a wiki, below are some hints on different wiki syntax.  the process below however seems to be the quickest for us.
+
There are many ways to add data to a wiki, below are some hints on different wiki syntax.  
  
:1 Search the wiki for your topic, be sure to search for variations.  For example, searching for prc-68 might appear. AN/PRC-68.  Wiki page titles are case sensitive.  If the page exists feel free to edit it to correct or add data.
+
==To Add New Data==
 +
:1 Search the wiki for your topic, be sure to search for variations.  For example, searching for "prc-68" might appear as "AN/PRC-68".  Wiki page titles are case sensitive.  If the page doesnt exist it will ask you if you want to create it.  If the page exists feel free to edit it to correct or add data.
 +
 
 +
:2 if it exists simply click "edit" (if your logged in) and edit at will.  If its not there, click the red text on the search term and one will be created, opened to the edit page.  Edit away.
  
:2 if it exists simply click "edit" (if your logged in) and edit at will.  If its not there, click the red text on the search turn and one will be created, opened to the edit page.  Edit away.
 
  
 
==adding manuals==
 
==adding manuals==
Line 19: Line 21:
  
  
Copy that into the page, then edit the sections as appropriate the top line is <pre>;{{pdf. |. FILENAME.PDF. DISPLAYNAME }}</pre>.  
+
Copy that into the page, then edit the sections as appropriate:
 +
:The top line is  
 +
::<pre>;{{pdf | FILENAME.PDF |  DISPLAY NAME }}</pre>  
 +
: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:
 +
::<pre>: TITLE
 +
::MODEL(s) </pre>
  
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 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.
  
The rest are file details.
+
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.
  
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.
 
  
 
== Text formatting markup ==
 
== Text formatting markup ==

Revision as of 03:33, 27 May 2013

There are many ways to add data to a wiki, below are some hints on different wiki syntax.

To Add New Data

1 Search the wiki for your topic, be sure to search for variations. For example, searching for "prc-68" might appear as "AN/PRC-68". Wiki page titles are case sensitive. If the page doesnt exist it will ask you if you want to create it. If the page exists feel free to edit it to correct or add data.
2 if it exists simply click "edit" (if your logged in) and edit at will. If its not there, click the red text on the search term and one will be created, opened to the edit page. Edit away.


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


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.


Text formatting markup

Description You type You get
Character (inline) formatting – applies anywhere
Italic text
''italic''

italic

Bold text
'''bold'''

bold

Bold and italic
'''''bold & italic'''''

bold & italic

Strike text
<strike> strike text </strike>
strike text
Escape wiki markup
<nowiki>no ''markup''</nowiki>

no ''markup''

Escape wiki markup once
[[API]]<nowiki/>extension

APIextension

Section formatting – only at the beginning of the line
Headings of different levels

== Level 2 ==

=== Level 3 ===

==== Level 4 ====

===== Level 5 =====

====== Level 6 ======


Level 2

Level 3

Level 4

Level 5
Level 6
Horizontal rule
Text before
----
Text after

Text before


Text after

Bullet list
* 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.
  • Start each line
  • with an asterisk (*).
    • More asterisks give deeper
      • and deeper levels.
  • Line breaks
    don't break levels.
      • But jumping levels creates empty space.

Any other start ends the list.

Numbered list
# 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.
  1. Start each line
  2. with a number sign (#).
    1. More number signs give deeper
      1. and deeper
      2. levels.
  3. Line breaks
    don't break levels.
      1. But jumping levels creates empty space.
  4. Blank lines
  1. end the list and start another.

Any other start also ends the list.

Definition list
;item 1
: definition 1
;item 2
: definition 2-1
: definition 2-2
item 1
definition 1
item 2
definition 2-1
definition 2-2
Indent text
: Single indent
:: Double indent
::::: Multiple indent

Single indent
Double indent
Multiple indent
Mixture of different types of list
# 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

  1. one
  2. two
    • two point one
    • two point two
  3. three
    three item one
    three def one
  4. four
    four def one
    this looks like a continuation
    and is often used
    instead
    of <br />
  5. five
    1. five sub 1
      1. five sub 1 sub 1
    2. five sub 2Template:Anchor
Preformatted text
 Start each line with a space.
 Text is '''preformatted''' and
 ''markups'' '''''can''''' be done.

Start each line with a space.
Text is preformatted and
markups can be done.
Preformatted text blocks
 <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:
        print True
    else:
        print False</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:
        print True
    else:
        print False