Creating a wiki page

From PCLinuxOSHelp Knowledge Base
Jump to: navigation, search

A guide on how to create and format pages.

THIS PAGE NEEDS EDITING, BUT IS STILL USABLE


Creating/Editing a page
Create a new page

    Think of descriptive name for your new page and search for it.
        Search for the name using Title Case so our titles stay tidy. 
    If no page by this name exists, then MediaWiki will let you create a new page.
    If there is a page by that name, think of a new name, or if the other page should be renamed, leave a comment. 

Edit an existing page

    Click the "Edit This Page" link at the top right, on any page. 

Stubs

    A red link on a page is called a "stub." By clicking on the stub you 

can create a new page.
Converting Documents into Wiki Text
PDF, RTF, and Word Documents

Use the OpenOffice program Writer. Use the Export function to convert Word documents to clean MediaWiki text. This MediaWiki text can be simply copy & pasted directly into the edit box in our Wiki.


Formatting Guidelines

Most of the formatting can be done with these buttons in editing mode. If you want to try more advanced formatting consult the MediaWiki Editing Manual. Take a look at our Sample Page for an idea of how to properly format a page.
Formatting Text
Text formatting markup
Description 	You type 	You get
applies anywhere
Italic text 	<tt>italic</tt> 	italic
Bold text 	<tt>bold</tt> 	bold
Bold and italic 	<tt>bold & italic</tt> 	bold & italic
Escape wiki markup 	<tt><nowiki>no

"markup"</nowiki></tt>
	no markup
only at the beginning of

the line
Indent text 	

<tt>:Single indent</tt><br /> <tt>::Double indent</tt><br /> <tt>:::::Multiple indent</tt>
	

    Single indent

        Double indent

                    Multiple indent 

Headings of different levels <br />

NOTE: An article with four or more headings will automatically create a [http://en.wikipedia.org/wiki/Wikipedia:Section#Table_of_contents_.28TOC.29 table of contents].
	

<tt>==level 2==</tt><br /> <tt>===level 3===</tt><br /> <tt>====level 4====</tt><br />
	

<!-- little hack to prevent TOC viewing --> <span style="font-size: 150%; margin: 0; padding-top: .5em; padding-bottom: .17em; border-bottom: 1px solid #aaa;">Level 2</span><br/><br/> <span style="font-size: 132%; border-bottom: none; font-weight: bold;">Level 3</span><br/> <span style="font-size: 100%; border-bottom: none; font-weight: bold;">Level 4</span><br/>
Bullet list 	

* one<br /> * two<br /> * three<br /> ** three and one-third<br /> ** three and two-thirds<br />
	

    one
    two
    three
        three and one-third
        three and two-thirds 

Numbered list 	

# one<br /> # two<br />spanning several lines<br />without breaking the numbering<br /> # three<br /> ## three point one<br /> ## three point two<br />
	

    one
    two<br>spanning several lines<br>without breaking the numbering
    three
        three point one
        three point two 

Mixture of bulleted<br /> and numbered lists 	

# one<br /> # two<br /> #* two point one<br /> #* two point two<br />
	

    one
    two
        two point one
        two point two 

Definition list 	

;Definition<br /> :item 1<br /> :item 2<br />
	

Definition
    item 1 
    item 2 

Preformatted text 	

  preformatted text is done with<br />   a space at the<br />   beginning of the line<br />
	

preformatted text is done with
a space at the 
beginning of the line

Blockquotes 	

Body<br> text text text text text text text text text text text text text text text text text text text text text text text text

<blockquote> quote quote quote quote quote quote </blockquote>

text text text text text text text text text text text text
	

Body<br> text text text text text text text text text text text text text text text text text text text text text text text text

<blockquote> quote quote quote quote quote quote </blockquote>

text text text text text text text text text text text text
Comment 	

<tt><!--This is comment--></tt>
	

<!--This is comment-->|}


File:Wiki headline button.png Headings - Organize your page by headings. This lets people jump right to where they want to go.

File:Wiki bold button.png Bold - Use for emphasis or whenever the title of the entry is mentioned

File:Wiki italic button.png Italic - Use for emphasis or for titles.

CAPS - Just don't use them at all.

Spacing - Use 1 line break after each section
Images

Sizing - Files should be under 150kb.

Naming - Do not use any spaces in the filename. Use "_" instead. Be descriptive in your file name. Someone should be able to read the file name and know what they're going to get. For software screenshots the filename should be: "Application_Name-Description" For example:

Final_Cut_Pro-Timeline.jpg

If you are documenting a process then the filename should be: "Application_Name-Process_#" For example:

Photoshop-Save_for_web_2.jpg

Links
Description 	You type 	{You get
Internal link 	<tt>Main Page</tt> 	Main Page
Piped link 	<tt>different text</tt> 	different text
External link 	<tt>http://mediawiki.org</tt> 	http://mediawiki.org
External link,<br />

different title
	<tt>[http://mediawiki.org

MediaWiki]</tt>
	MediaWiki
External link,<br />

numbered
	<tt>[1]</tt> 	[2]
Anchor link 	<tt>#See also</tt> 	#See also
Anchor link at another page 	<tt>Help:Images#See also</tt> 	Help:Images#See also
Category link 	<tt>Category:Help</tt> 	Category:Help
Internal link to image file 	<tt>media:example.jpg</tt> 	media:example.jpg
Internal link to pdf file 	<tt>media:example.pdf</tt> 	media:example.pdf
mailto link 	<tt>[mailto:info@example.org email

me]</tt>
	email me
A guide on how to create and format pages.
Creating/Editing a page
Create a new page

    Think of descriptive name for your new page and search for it.
        Search for the name using Title Case so our titles stay tidy. 
    If no page by this name exists, then MediaWiki will let you create a new 

page.

    If there is a page by that name, think of a new name, or if the other page 

should be renamed, leave a comment.
Edit an existing page

    Click the "Edit This Page" link at the top right, on any page. 

Stubs

    A red link on a page is called a "stub." By clicking on the stub you 

can create a new page.
Converting Documents into Wiki Text
PDF, RTF, and Word Documents

Use the OpenOffice program Writer. Use the Export function to convert Word documents to clean MediaWiki text. This MediaWiki text can be simply copy & pasted directly into the edit box in our Wiki.


Formatting Guidelines

Most of the formatting can be done with these buttons in editing mode. If you want to try more advanced formatting consult the MediaWiki Editing Manual. Take a look at our Sample Page for an idea of how to properly format a page.
Formatting Text
Text formatting markup
Creating/Editing a page
Create a new page

    Think of descriptive name for your new page and search for it.
        Search for the name using Title Case so our titles stay tidy. 
    If no page by this name exists, then MediaWiki will let you create a new 

page.

    If there is a page by that name, think of a new name, or if the other page 

should be renamed, leave a comment.
Edit an existing page

    Click the "Edit This Page" link at the top right, on any page. 

Stubs

    A red link on a page is called a "stub." By clicking on the stub you 

can create a new page.
Converting Documents into Wiki Text
PDF, RTF, and Word Documents

Use the OpenOffice program Writer. Use the Export function to convert Word documents to clean MediaWiki text. This MediaWiki text can be simply copy & pasted directly into the edit box in our Wiki.


Formatting Guidelines

Most of the formatting can be done with these buttons in editing mode. If you want to try more advanced formatting consult the MediaWiki Editing Manual. Take a look at our Sample Page for an idea of how to properly format a page.
Formatting Text
Text formatting markup
Description 	You type 	You get
applies anywhere
Italic text 	<tt>italic</tt> 	italic
Bold text 	<tt>bold</tt> 	bold
Bold and italic 	<tt>bold & italic</tt> 	bold & italic
Escape wiki markup 	<tt><nowiki>no

"markup"</nowiki></tt>
	no markup
Description 	You type 	You get
applies anywhere
Italic text 	<tt>italic</tt> 	italic
Bold text 	<tt>bold</tt> 	bold
Bold and italic 	<tt>bold & italic</tt> 	bold & italic
Escape wiki markup 	<tt><nowiki>no

"markup"</nowiki></tt>
	no markup
only at the beginning of

the line
Indent text 	

<tt>:Single indent</tt><br /> <tt>::Double indent</tt><br /> <tt>:::::Multiple indent</tt>
	

    Single indent

        Double indent

                    Multiple indent 

Headings of different levels <br />

NOTE: An article with four or more headings will automatically create a [http://en.wikipedia.org/wiki/Wikipedia:Section#Table_of_contents_.28TOC.29 table of contents].
	

<tt>==level 2==</tt><br /> <tt>===level 3===</tt><br /> <tt>====level 4====</tt><br />
	

<!-- little hack to prevent TOC viewing --> <span style="font-size: 150%; margin: 0; padding-top: .5em; padding-bottom: .17em; border-bottom: 1px solid #aaa;">Level 2</span><br/><br/> <span style="font-size: 132%; border-bottom: none; font-weight: bold;">Level 3</span><br/> <span style="font-size: 100%; border-bottom: none; font-weight: bold;">Level 4</span><br/>
Bullet list 	

* one<br /> * two<br /> * three<br /> ** three and one-third<br /> ** three and two-thirds<br />
	

    one
    two
    three
        three and one-third
        three and two-thirds 

Numbered list 	

# one<br /> # two<br />spanning several lines<br />without breaking the numbering<br /> # three<br /> ## three point one<br /> ## three point two<br />
	

    one
    two<br>spanning several lines<br>without breaking the numbering
    three
        three point one
        three point two 

Mixture of bulleted<br /> and numbered lists 	

# one<br /> # two<br /> #* two point one<br /> #* two point two<br />
	

    one
    two
        two point one
        two point two 

Definition list 	

;Definition<br /> :item 1<br /> :item 2<br />
	

Definition
    item 1 
    item 2 

Preformatted text 	

  preformatted text is done with<br />   a space at the<br />   beginning of the line<br />
	

preformatted text is done with
a space at the 
beginning of the line

Blockquotes 	

Body<br> text text text text text text text text text text text text text text text text text text text text text text text text

<blockquote> quote quote quote quote quote quote </blockquote>

text text text text text text text text text text text text
	

Body<br> text text text text text text text text text text text text text text text text text text text text text text text text

<blockquote> quote quote quote quote quote quote </blockquote>

text text text text text text text text text text text text
Comment 	

<tt><!--This is comment--></tt>
	

<!--This is comment-->|}


File:Wiki headline button.png Headings - Organize your page by headings. This lets people jump right to where they want to go.

File:Wiki bold button.png Bold - Use for emphasis or whenever the title of the entry is mentioned

File:Wiki italic button.png Italic - Use for emphasis or for titles.

CAPS - Just don't use them at all.

Spacing - Use 1 line break after each section
Images

Sizing - Files should be under 150kb.

Naming - Do not use any spaces in the filename. Use "_" instead. Be descriptive in your file name. Someone should be able to read the file name and know what they're going to get. For software screenshots the filename should be: "Application_Name-Description" For example:

Final_Cut_Pro-Timeline.jpg

If you are documenting a process then the filename should be: "Application_Name-Process_#" For example:

Photoshop-Save_for_web_2.jpg

Links
Description 	You type 	{You get
Internal link 	<tt>Main Page</tt> 	Main Page
Piped link 	<tt>different text</tt> 	different text
External link 	<tt>http://mediawiki.org</tt> 	http://mediawiki.org
External link,<br />

different title
	<tt>[http://mediawiki.org

MediaWiki]</tt>
	MediaWiki
External link,<br />

numbered
	<tt>[3]</tt> 	[4]
Anchor link 	<tt>#See also</tt> 	#See also
Anchor link at another page 	<tt>Help:Images#See also</tt> 	Help:Images#See also
Category link 	<tt>Category:Help</tt> 	Category:Help
Internal link to image file 	<tt>media:example.jpg</tt> 	media:example.jpg
Internal link to pdf file 	<tt>media:example.pdf</tt> 	media:example.pdf
mailto link 	<tt>[mailto:info@example.org email

me]</tt>
	email me

File:Wiki link button.png Internal Wiki Link - Link to related documents as much as possible. If you have a number of links create a heading called "Related Pages" at the end of the document.

File:Wiki external link button.png External Link - Link to external pages wherever appropriate. If you have a number of links create a heading called "Links" at the end of the document.
Tables

Tables are created using MediaWiki's [http://www.mediawiki.org/wiki/Help:Tables table syntax].

On the first line, add <br> <pre>
to make it match the style across the wiki.

Collapsible Tables

NOTE: this is not yet supported To make any table collapsible change the first line:
For example
This is a collapsible table.

For example This is a collapsible table. Style Guide

   Graphic example of a our "look": Sample Page
   Please refer to 

/APSG_2008.pdf Apple Publications Style Guide (PDF) for the preferred way to describe any technology, software, screen element, computer-related term or acronym. Proper style for common terms

   Menus, Button, Commands, and Screen Elements Please use the 

capitalization, punctuation and order that is represented on screen. For buttons with no associated text, use the text that appears in the Tooltip as you roll-over the button, or the name used in the manual, if there is no Tooltip.

   Menu selection Use the following convention: File > Save As... or 

select the File menu > Save As...

   Cmd, Ctrl, Shift, Option keyboard shortcuts. Use Cmd-S or ⌘S. Not 

Apple-S, Cmd + S, +S. Please see Keyboard shortcut and other symbols for proper use and how to insert these special symbols. Or Copy & Paste from here: ⌘⌃⇧⌥.

   for other terms, please refer to original manufacturers' use, or the 

/APSG_2008.pdf Apple Publications Style Guide (PDF) Categories

Please include Categories for all new pages you create. This is the current list of categories.
You can do so by including the following at the end of your page, replacing it with the appropriate category. You can have as many categories as you want for a page. only at the beginning of

the line Indent text

:Single indent
::Double indent
:::::Multiple indent


   Single indent
       Double indent
                   Multiple indent 

Headings of different levels

NOTE: An article with four or more headings will automatically create a table of contents.


==level 2==
===level 3===
====level 4====


Level 2

Level 3
Level 4

Bullet list

* one
* two
* three
** three and one-third
** three and two-thirds


   one
   two
   three
       three and one-third
       three and two-thirds 

Numbered list

# one
# two<br />spanning several lines<br />without breaking the numbering
# three
## three point one
## three point two


   one
   two
spanning several lines
without breaking the numbering three three point one three point two

Mixture of bulleted
and numbered lists

# one
# two
#* two point one
#* two point two


   one
   two
       two point one
       two point two 

Definition list

;Definition
:item 1
:item 2


Definition

   item 1 
   item 2 

Preformatted text

  preformatted text is done with
  a space at the
  beginning of the line


preformatted text is done with a space at the beginning of the line

Blockquotes

Body
text text text text text text text text text text text text text text text text text text text text text text text text

<blockquote> quote quote quote quote quote quote </blockquote>

text text text text text text text text text text text text


Body
text text text text text text text text text text text text text text text text text text text text text text text text

quote quote quote quote quote quote

text text text text text text text text text text text text Comment

<!--This is comment-->


|}


File:Wiki headline button.png Headings - Organize your page by headings. This lets people jump right to where they want to go.

File:Wiki bold button.png Bold - Use for emphasis or whenever the title of the entry is mentioned

File:Wiki italic button.png Italic - Use for emphasis or for titles.

CAPS - Just don't use them at all.

Spacing - Use 1 line break after each section Images

Sizing - Files should be under 150kb.

Naming - Do not use any spaces in the filename. Use "_" instead. Be descriptive in your file name. Someone should be able to read the file name and know what they're going to get. For software screenshots the filename should be: "Application_Name-Description" For example:

Final_Cut_Pro-Timeline.jpg

If you are documenting a process then the filename should be: "Application_Name-Process_#" For example:

Photoshop-Save_for_web_2.jpg

Links Description You type {You get Internal link Main Page Main Page Piped link different text different text External link http://mediawiki.org http://mediawiki.org External link,

different title [http://mediawiki.org MediaWiki] MediaWiki External link,

numbered [5] [6] Anchor link #See also #See also Anchor link at another page Help:Images#See also Help:Images#See also Category link Category:Help Category:Help Internal link to image file media:example.jpg media:example.jpg Internal link to pdf file media:example.pdf media:example.pdf mailto link [mailto:info@example.org email me] email me

File:Wiki link button.png Internal Wiki Link - Link to related documents as much as possible. If you have a number of links create a heading called "Related Pages" at the end of the document.

File:Wiki external link button.png External Link - Link to external pages wherever appropriate. If you have a number of links create a heading called "Links" at the end of the document. Tables

Tables are created using MediaWiki's table syntax.

On the first line, add
 to make it match the style across the wiki.

Collapsible Tables

NOTE: this is not yet supported To make any table collapsible change the first line:
For example
This is a collapsible table.

For example This is a collapsible table. Style Guide

   Graphic example of a our "look": Sample Page
   Please refer to 

/APSG_2008.pdf Apple Publications Style Guide (PDF) for the preferred way to describe any technology, software, screen element, computer-related term or acronym. Proper style for common terms

   Menus, Button, Commands, and Screen Elements Please use the 

capitalization, punctuation and order that is represented on screen. For buttons with no associated text, use the text that appears in the Tooltip as you roll-over the button, or the name used in the manual, if there is no Tooltip.

   Menu selection Use the following convention: File > Save As... or 

select the File menu > Save As...

   Cmd, Ctrl, Shift, Option keyboard shortcuts. Use Cmd-S or ⌘S. Not 

Apple-S, Cmd + S, +S. Please see Keyboard shortcut and other symbols for proper use and how to insert these special symbols. Or Copy & Paste from here: ⌘⌃⇧⌥.

   for other terms, please refer to original manufacturers' use, or the 

/APSG_2008.pdf Apple Publications Style Guide (PDF) Categories

Please include Categories for all new pages you create. This is the current list of categories.
You can do so by including the following at the end of your page, replacing it with the appropriate category. You can have as many categories as you want for a page.

File:Wiki link button.png Internal Wiki Link - Link to related documents as much as possible. If you have a number of links create a heading called "Related Pages" at the end of the document.

File:Wiki external link button.png External Link - Link to external pages wherever appropriate. If you have a number of links create a heading called "Links" at the end of the document. Tables

Tables are created using MediaWiki's table syntax.

On the first line, add
 to make it match the style across the wiki.

Collapsible Tables

NOTE: this is not yet supported To make any table collapsible change the first line:
For example
This is a collapsible table.

For example This is a collapsible table. Style Guide

   Graphic example of a our "look": Sample Page
   Please refer to 

/APSG_2008.pdf Apple Publications Style Guide (PDF) for the preferred way to describe any technology, software, screen element, computer-related term or acronym. Proper style for common terms

   Menus, Button, Commands, and Screen Elements Please use the 

capitalization, punctuation and order that is represented on screen. For buttons with no associated text, use the text that appears in the Tooltip as you roll-over the button, or the name used in the manual, if there is no Tooltip.

   Menu selection Use the following convention: File > Save As... or 

select the File menu > Save As...

   Cmd, Ctrl, Shift, Option keyboard shortcuts. Use Cmd-S or ⌘S. Not 

Apple-S, Cmd + S, +S. Please see Keyboard shortcut and other symbols for proper use and how to insert these special symbols. Or Copy & Paste from here: ⌘⌃⇧⌥.

   for other terms, please refer to original manufacturers' use, or the 

/APSG_2008.pdf Apple Publications Style Guide (PDF) Categories

Please include Categories for all new pages you create. This is the current list of categories.
You can do so by including the following at the end of your page, replacing it with the appropriate category. You can have as many categories as you want for a page.

</pre>