Help:Contents

From PZwiki
Jump to: navigation, search
Geographylogo.pngLanguage: English  • français • 日本語 • norsk


Welcome to The Project Zomboid Wiki help pages

Below are a list of helpful articles to get you started.

Creating a Page

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, like this.

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.

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.

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).

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?

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.

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.

Sg1.PNG

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:  

https://pzwiki.net/wiki/ARTICLE  

If you replace ARTICLE 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

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.

  • 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:
{{Languages|Main Page}}
Will produce:
Geographylogo.pngLanguage: English  • français • Deutsch • русский • 日本語 • Nederlands • polski • norsk • español • português • 中文 • italiano • 한국어


  • 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:
{{header|The Game World|Items|Consumables|Food|Perishable Food|type=Food|version=Version 39|incver=58}}
Will produce:

 Page Updated @ Version 39.58 
   Navigation - Main Index -> The Game World -> Items -> Consumables -> Food -> Perishable Food -> Contents   


A whole page's worth of content in here.

Contents
Image.png

Weight: ?


  • 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: {{Items|image=Image.png |weight=?}}
Will produce: (displayed on the far right)




  • 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 Guides.
    • Example:
Image.png
Text that would go below the image.
{| 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.''
|}
Will produce: (displayed on the far right)



Other formats

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.

Rather than leaving it empty, we ask that you add these if unsure what to add.

  • 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: {{VersionNotice|version=Version 39|incver=58}}
Will produce:
Note: This page was updated with Version 39.58 of Project Zomboid in mind. If the page turns out to be outdated please add an outdated Notice banner.
  • 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: [[Category:Tools]] will add the page to the Tools category.
  • 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: {{Notice|Short}}
Will produce:
Notepad.png This article may need more content. Editors are encouraged to add new material to the page while expanding upon current topics.
  • Other templates:
    • Recipe Lookup — Displays all recipe indexes, with instructions on how to add new recipes.
    • 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 ''this''.

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

Escape wiki markup
<nowiki>no ''markup''</nowiki>

no ''markup''

Section formatting – only at the beginning of the line
Section 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 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

  • Start each line
  • with an (*).
    • 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.

  • 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

;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 2
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


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 <br />.

HTML tags

Some HTML tags are allowed in MediaWiki, for example <code>, <div>, <span> and <font>. These apply anywhere you insert them.

Description You type You get
Inserted
(Displays as underline in most browsers)
<ins>Inserted</ins>

or

<u>Underline</u>

Inserted

or

Underline

Deleted
(Displays as strikethrough in most browsers)
<s>Struck out</s>

or

<del>Deleted</del>

Struck out

or

Deleted

Fixed width text
<code>Source code</code>

or

<code>Fixed width text</code>

Source code

or

Fixed width text

Blockquotes
Text before
<blockquote>Blockquote</blockquote>
Text after

Text before

Blockquote

Text after

Comment
<!-- This is a comment -->
Comments are visible only 
in the edit zone.

Comments are visible only in the edit zone.

Completely preformatted text
<pre>
Text is '''preformatted''' and 
''markups'' '''''cannot''''' be done</pre>
Text is '''preformatted''' and 
''markups'' '''''cannot''''' be done
Customized preformatted text
<pre style="color: red">
Text is '''preformatted''' 
with a style and 
''markups'' '''''cannot''''' be done
</pre>
Text is '''preformatted''' 
with a style and 
''markups'' '''''cannot''''' be done

Images

Suppоrted media types for images

The following file formats are suppоrted by default:

  • .jpg or .jpeg : bitmap image compressed in the standard JPEG format (this lossy format is most suitable for photographs).
  • .png : bitmap image in the Portable Network Graphics format (specified by the W3 Consortium).
  • .gif : bitmap image in the legacy Graphics Interchange Format.

Rendering a single image

Syntax

The full syntax for displaying an image is:

[[File:filename.extension|options|caption]]

where options can be zero or more of the following, separated by pipes |:

  • Format option: one of border and/or frameless, frame, thumb (or thumbnail);
    • Controls how the rendered image is formatted and embedded in the rest of the page.
  • Resizing option: one of
    • {width}px — Resizes the image to fit within the given maximum width in pixels, without restricting its height;
    • x{height}px — Resizes the image to fit within the given maximum height in pixels, without restricting its width;
    • {width}x{height}px — Resizes the image to fit within the given width and height in pixels;
    • upright — Resizes an image to fit within reasonable dimensions, according to user preferences (suitable for images whose height is larger than width).
Note that the image will always retain its aspect ratio, and can only be reduced (not increased) in size unless it's in a scalable media type (bitmap images cannot be scaled up).
The default maximum size depends on the format and the internal image dimensions (according to its media type).
  • Horizontal alignment option: one of left, right, center, none;
    • Controls the horizontal alignment (and inline/block or floating styles) of the image within a text (no default value).
  • Vertical alignment option: one of baseline, sub, super, top, text-top, middle, bottom, text-bottom;
    • Controls the vertical alignment of a non-floating inline image with the text before or after the image, and in the same block (the default vertical alignment is middle).
  • Link option: one of
    • link={target} — Allows to change the target (to an arbitrary page title, or URL) of the generated link, activatable on the rendered image surface; e.g. [[File:Image.png|20px|link=http://www.wikipedia.org]] renders as Image.png (external link), or [[File:Image.png|20px|link=Main_Page]] renders as Image.png (internal link).
    • link= (with an empty value) — Displays an image without any activatable link; e.g. [[File:Image.png|20px|link=]] renders as Image.png.
      • If you set |link=| (empty), then no title will be rendered.


External Links