Help:Contents: Difference between revisions

From PZwiki
(Removed images section since it has a dedicated page. +added style guide link to contents and moved external/mediawiki links to top of page.)
mNo edit summary
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{languages}}
{| width=80% style="text-align:center;" cellspacing=10
==Welcome to The Project Zomboid Wiki help pages==
|- style="vertical-align:top;"
Below are a list of helpful articles to get you started.
| colspan="2" | <!--
*[[Help:Editing for beginners|Editing for beginners]]
####################
*[[Help:Navigation|Navigation]]
### NAVIGATION  ###
*[[Help:Editing pages|Editing pages]]
####################
*[[Help:Creating a new page|Creating a new page]]
-->{{Languages}}{{Tutorial navigation}}
*[[Help:Formatting|Formatting]]
|- style="vertical-align:top;"
*[[Help:Links|Links]]
| width=50% |<!--
*[[Help:Images|Images]]
####################
*[[Help:Tables|Tables]]
### LEFT COLUMN  ###
*[[Style Guide]]
####################
-->
{| width=100% style="text-align:right"
|- style="vertical_align:top;"
| <span style="float: left;">[[File:ScholarSpiffo.png|250px|Float]]</span><span style="font-size:150%">'''Welcome to the<br>Zomboid help articles'''</span>
----
Project Zomboid's complete guide to wiki editing


New to wiki editing?


 
<span style="font-size:125%">'''[[Help:Editing for beginners|Get Started]]'''</span>
==MediaWiki Links==
|}
PZWiki uses MediaWiki wiki software, general help using the software can be found below.
{| width=100% style="height:103px; background-color: #C3E4ED; margin-top:6px;" cellspacing=0
* [https://www.mediawiki.org/wiki/Help:Formatting Format]
|-
* [https://www.mediawiki.org/wiki/Help:Images Images]
| colspan="2" style="text-align: center; font-size: 150%; color:#000; background: #9AC0CD;"| <div class="header" style="align: center;"><small>'''Advanced resources'''<br></small> </div>
* [https://www.mediawiki.org/wiki/Help:Tables Tables]
|- style="vertical-align:top; text-align:left;"
* [https://www.mediawiki.org/wiki/Help:Links Links]
| style="width:50%; padding: 5px;"|
* [https://www.mediawiki.org/wiki/Help:Lists Lists]
:[https://www.mediawiki.org/wiki/Help:Templates Writing templates]
 
:[https://www.mediawiki.org/wiki/Help:Magic_words Magic words]
[[Category:Help]]
| style="width:50%; padding: 5px;"|
 
:[https://www.mediawiki.org/wiki/Help:Namespaces Namespaces]
 
:[https://www.mediawiki.org/wiki/Help:Special_pages Special pages]
 
|}
 
| width=50% | <!--
 
####################
 
### RIGHT COLUMN ###
 
####################
__TOC__
-->
==Creating a Page==
{| width=100% style="background-color: #C3E4ED; margin-top:6px;" cellspacing=0
===Using links===
|-
If you or any other contributor create a link to an article that does not exist yet, the link will be colored red, <span style="color: #ba0000">like this</span>.<br>
| colspan="2" style="text-align: center; font-size: 150%; color:#000; background: #9AC0CD;"| <div class="header" style="align: center;"><small>'''PZwiki editing'''<br></small> </div>
 
|- style="vertical-align:top; text-align:left;"
Clicking a red link will take you to the edit page for the new article. Simply type your text, click save and the new page will be created.<br>
| style="width:50%; padding: 5px;"|
 
:[[Help:Editing for beginners|Editing for beginners]]
Once the page has been created, the link will automatically change from red to blue (or purple for pages you've already visited) indicating that the article now exists.
:[[Help:Editing pages|Editing pages]]
 
:[[Help:Creating a new page|Creating a new page]]
Usually this is the best way to create a new page, because it means that right from the start, the page will be linked from at least one other place on the wiki (and typically you will want to mesh it into other related pages later).<br>
:[[Help:Formatting|Formatting]]
 
| style="width:50%; padding: 5px;"|  
If you are creating a new page without creating any link to it, you may need to ask yourself: Does this page really fit in with the topics already covered in the wiki? <br>
:[[Help:Links|Links]]
 
:[[Help:Images|Images]]
Also, how are you expecting visitors to find this page? Normally there is no reason to create a page without first creating a red link to it.
:[[Help:Tables|Tables]]
 
:[[PZwiki:Style guide|Style guide]]
=== From the search box ===
 
If you search for a page that doesn't exist (using the search box in the top right of the page) then you will be provided with a link to create the new page.
[[File:Sg1.PNG|thumb|500px|left]] <br clear=all>
 
=== Using the URL ===
 
You can also use a URL for creating a new page. The URL to an article of the wiki usually looks like this: &nbsp;
 
<code><nowiki>https://pzwiki.net/wiki/</nowiki>'''ARTICLE'''</code> &nbsp;
 
If you replace <code>'''ARTICLE'''</code> with the name of the page you want to create, you will be taken to a blank page, indicating that no article of that name exists yet.
 
Clicking the "Create" Tab at the top right of the page (next to the search function) will then take you to the edit page for that article, where you can create the new page by typing your text, and clicking submit.
 
 
==Page Format==
There are a variety of formats we use within the wiki to ensure there is consistency between each page type.
 
===Boilerplates===
[[:Category:Boilerplates|Boilerplates]] are premade page templates that should be used as a starting place when creating new pages. You can think of them as being forms where you ultimately just fill in the blanks.
 
Each boilerplate contains a ''language'' bar, ''header'' bar and ''infobox/image''.
 
* ''[[Template:Languages|language]]'' bar — Adds a list of languages that the page can be found in;
** Placed at the top of every page that is in more than one language;
** Example:
<pre>{{Languages|Main Page}}</pre>
::Will produce:
{{Languages|Main Page}}
 
* ''[[Template:Header|header]]'' bar — Adds ''category navigation'', ''version updated'' and a ''background'' to the page.
** Should be placed at the top of the page, under the language bar, all other content should be added below this;
** '''category navigation''' — Displays the categorical path within the navigational network;
** '''version updated''' — Displays the version the article was last updated on, while also adding it to the version category, used to easily identify outdated articles;
** '''background''' — Presents the article within a type defined background colour.
** Example:
<pre>{{header|The Game World|Items|Consumables|Food|Perishable Food|type=Food|version=Version 39|incver=58}}</pre>
::Will produce:<br><br>
{{header|The Game World|Items|Consumables|Food|Perishable Food|type=Food|version=Version 39|incver=58|hidecat=true}}
A whole page's worth of content in here.</div><br>
 
{{Items|image=Image.png |weight=?}}
* ''[[:Category:Infobox|infobox]]'' — Is a fixed-format table added to the top right-hand corner of articles to consistently present a summary of some unifying aspect that the articles share;
** Example: <code><nowiki>{{</nowiki>Items|image=Image.png |weight=?}}</code>
::Will produce: (displayed on the far right)<br><br><br><br><br>
 
* ''image'' — Is very similar to the infobox, except it does not display information and will only contain an image and a caption;
** Used on pages that don't have an infobox, or just simply need an image, such as in [[:Category:Guides|Guides]].
** Example:  
{| style="float:right; border:1px solid FFFFFF;margin:.46em 0 0 .2em"
|- style="font-size:100%"
| valign="top" |[[Image:Image.png]]<!--
  --><br> ''Text that would go below the image.''
|}
|}
<pre>
{| width=100% style="background-color: #C3E4ED; margin-top:18px;" cellspacing=0  
{| style="float:right; border:1px solid FFFFFF;margin:.46em 0 0 .2em"
|-  
|- style="font-size:100%"
| colspan="2" style="text-align: center; font-size: 150%; color:#000; background: #9AC0CD;"| <div class="header" style="align: center;"><small>'''Basic resources'''<br></small> </div>
| valign="top" |[[Image:Image.png]]<!--
|- style="vertical-align:top; text-align:left;"
  --><br> ''Text that would go below the image.''
| style="width:50%; padding: 5px;"|
:[https://www.mediawiki.org/wiki/Help:Editing_pages Editing pages]
:[https://www.mediawiki.org/wiki/Help:Formatting Formatting]
:[https://www.mediawiki.org/wiki/Help::Links Links]
:[https://www.mediawiki.org/wiki/Help:Images Images]
:[https://www.mediawiki.org/wiki/Help:Tables Tables]
:[https://www.mediawiki.org/wiki/Help:Starting_a_new_page Starting a new page]
| style="width:50%; padding: 5px;"|
:[https://www.mediawiki.org/wiki/Help:Subpages Subpages]
:[https://www.mediawiki.org/wiki/Help:Moving_a_page Moving (renaming) a page]
:[https://www.mediawiki.org/wiki/Help:Categories Categories]
:[https://www.mediawiki.org/wiki/Help:Talk_pages Talk pages]
:[https://www.mediawiki.org/wiki/Help:Cite References]
:[[wikipedia:Wikipedia:Manual of style|Manual of style]]
|}
|}
</pre>
|- style="vertical-align:top;"
:: Will produce: (displayed on the far right)<br><br><br><br>
| colspan="2" | <!--
 
####################
===Other formats===
### FOOTER      ###
Boilerplates are currently the standard formats used within the wiki. However not all page types have their dedicated boilerplate, or you (the editor) may be unsure which boilerplates to use.
####################
 
-->''PZWiki uses [https://www.mediawiki.org/wiki/MediaWiki MediaWiki] wiki software, further help using the software can be found on the [https://www.mediawiki.org/wiki/Help:Contents contents] page.''
Rather than leaving it empty, we ask that you add these if unsure what to add.
* ''[[Template:VersionNotice|Version Notice]]'' — Displays the version the article was last updated on, while also adding it to the version category;
** This is the bare minimum of what ''should'' be added to any page created, as it allows us to identify which pages might be outdated.
** Should be added at the top of the page, under the ''language bar''.
** Example: <code><nowiki>{{</nowiki>VersionNotice|version=Version 39|incver=58}}</code>
:: Will produce:
::: ''Note: This page was updated with [[Version history|Version 39.58]] of Project Zomboid in mind. If the page turns out to be outdated please add an outdated [[Template:Notice|Notice]] banner.''
* ''[[:Category:Main|Category]]'' — Adds the article to the designated category (seen at the bottom of the page);
** Pick any one or more categories that you believe fit the page.
** Example: <code><nowiki>[[</nowiki>Category:Tools]]</code> will add the page to the [[:Category:Tools|Tools]] category.
* ''[[Template:Notice|Notice]]'' box — Adds a notice box indicating what is either wrong with the page, or what the page is about.
** Should be added at the top of the page, under the ''language bar'' and ''boilerplate''.
** Example: <code><nowiki>{{</nowiki>Notice|Short}}</code>
:: Will produce:
{{NoticeBox|1|#0af|file=Notepad.png|width=32px|height=32px|desc=This article may '''need more content'''. Editors are encouraged to add new material to the page while expanding upon current topics.}}
* Other templates:
** ''[[Template:RecipeLookup|Recipe Lookup]]'' — Displays all recipe indexes, with instructions on how to add new recipes.
** ''[[Template:About|About]]'' — Used for disambiguation, directing the reader to another page they may have been looking for instead.
 
 
== Formatting ==
 
You can format your text by using wiki markup. This consists of normal characters like asterisks, apostrophes or equal signs which have a special function in the wiki, sometimes depending on their position. For example, to format a word in ''italic'', you include it in two pairs of apostrophes like <code><nowiki>''this''</nowiki></code>.
 
=== Text formatting markup ===
 
{| class="wikitable"
! width=10% |Description
! width=45% | You type
! width=45% | You get
|-
! colspan="3" style="background: #CFCFCF" | 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'''''
 
|-
| Escape wiki markup
| <pre>
&lt;nowiki&gt;no ''markup''&lt;/nowiki&gt;
</pre>
|
<nowiki>no ''markup''</nowiki>
|-
! colspan="3" style="background: #CFCFCF" | Section formatting – ''only at the beginning of the line''
|-
| Section Headings of different levels
| <pre>
 
== Level 2 ==
 
=== Level 3 ===
 
===== Level 4 =====
 
====== Level 5 ======
 
======== Level 6 ========
 
</pre>
|
<!-- HTML to avoid creating new sections again -->
 
<h2>Level 2</h2>
 
<h3>Level 3</h3>
 
<h4>Level 4</h4>
 
<h5>Level 5</h5>
 
<h6>Level 6</h6>
 
|-
| Horizontal rule
| <pre>
Text before
----
Text after
</pre>
|
Text before
----
Text after
|-
| Bullet list
|
<pre>
 
 
* Start each line
* with an 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.
 
 
* combine bullet list
** with definition
::- definition
** creates empty space
 
* combine bullet list
** with definition
*:- definition
** without empty spaces
*bullet list
:- definition
:* sublist that doesn't create empty
:* spaces after definition
 
</pre>
|
 
* Start each line
* with an (*).
** 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.
* combine bullet list
** with definition
::- definition
** creates empty space
* combine bullet list
** with definition
*:- definition
** without empty spaces
*bullet list
:- definition
:* sublist that doesn't create empty
:* spaces after definition
 
|-
| 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>
 
|
 
: Single indent
:: Double indent
::::: Multiple indent
 
|-
| Mixture of different types of list
|
<pre>
 
 
# 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 &lt;nowiki><br />&lt;/nowiki>
# five
## five sub 1
### five sub 1 sub 1
## five sub 2
 
</pre>
 
|
 
# 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>
 
|
 
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:
        print True
    else:
        print False</nowiki></nowiki>
</pre>
|
<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>
|}
|}


 
[[Category:Help]]
=== Paragraphs ===
 
MediaWiki ignores single line breaks. To start a new paragraph, leave an empty line. You can force a line break within a paragraph with the HTML tag <code>&lt;br /></code>.
 
=== HTML tags ===
 
Some [[wikipedia:HTML|HTML]] tags are allowed in MediaWiki, for example <code>&lt;code></code>, <code>&lt;div></code>, <code><nowiki><span></nowiki></code> and <code><nowiki><font></nowiki></code>. These apply anywhere you insert them.
 
{| class="wikitable"
! Description
! width=40% | You type
! width=40% | You get
|-
| Inserted <br />(Displays as underline in most browsers)
| <pre>
<ins>Inserted</ins>
 
or
 
<u>Underline</u>
</pre>
|
<ins>Inserted</ins>
 
or
 
<u>Underline</u>
|-
| Deleted <br />(Displays as strikethrough in most browsers)
| <pre>
<s>Struck out</s>
 
or
 
<del>Deleted</del>
 
</pre>
|
<s>Struck out</s>
 
or
 
<del>Deleted</del>
|-
| Fixed width text
| <pre>
<code>Source code</code>
 
or
 
<code>Fixed width text</code>
</pre>
|
<code>Source code</code>
 
or
 
<code>Fixed width text</code>
|-
| Blockquotes
| <pre>
Text before
<blockquote>Blockquote</blockquote>
Text after
</pre>
|
Text before
<blockquote>Blockquote</blockquote>
Text after
|-
| Comment
| <pre>
<!-- This is a comment -->
Comments are visible only
in the edit zone.
</pre>
|
 
<!-- This is a comment -->
Comments are visible only
in the edit zone.
 
|-
| Completely preformatted text
| <pre>
<pre>
Text is '''preformatted''' and
''markups'' '''''cannot''''' be done&lt;/pre>
</pre>
 
|
<pre>
Text is '''preformatted''' and
''markups'' '''''cannot''''' be done
</pre>
|-
| '''Customized''' preformatted text
| <pre>
<pre style="color: red">
Text is '''preformatted'''
with a style and
''markups'' '''''cannot''''' be done
&lt;/pre>
</pre>
 
|
<pre style="color: red">
Text is '''preformatted'''
with a style and
''markups'' '''''cannot''''' be done
</pre>
|}

Revision as of 14:42, 13 January 2019