Page Format

From DocuWiki

Jump to: navigation, search


This page will explain the format and syntax of each page of this wiki.

For detailed general information about wiki syntax and markup please read the MediaWiki Help

The most common formatting Markup is explained on this help page.

Contents

[edit] Page Types

The most important page types on this wiki are Documentary pages and Category pages.

There are also a few others, like User pages, Talk pages and Special pages, but of lesser importance.

[edit] Documentary Page

The documentary page is the most common page on this wiki. Each documentary has its own documentary page where all necessary information about this documentary is displayed.

[edit] Page Structure

Each Documentary Page follows the same structure provided by the templates used in postbot, the wizard to create new pages.

This structure must be kept identical for all pages.

[edit] General Information

The first section is the General Information, which contains details about the topic of the documentary, the host or narrator, the publisher and publishing year as well as the spoken language and in some cases alternative titles and names.

[edit] Syntax

The syntax for this first phrase is quite complex and requires some further knowledge on Category pages first. Please edit the general information phrase only after having read about the category pages further down below.

Example from Once upon a time: Man

 [[:Category:History|History]][[Category:History]] Documentary 
 published by [[:Category:Procidis|Procidis]][[Category:Procidis]] 
 broadcasted as part of [[:Category:Once upon a time|Once upon a time]][[Category:Once upon a time|Man]] series in [[:Category:1978|1978]][[Category:1978]] - [[:Category:English|English]][[Category:English]], [[:Category:French|French]],[[:Category:German|German]],[[:Category:Spanish|Spanish]] [[Multilanguage]] narration
 
 also known as
 * [[Il ├ętait une fois...L'homme]]
 * [[Es war einmal...der Mensch]]
 * [[Erase una vez...el hombre]]
 
 [[Category:Name]]

The basic markup consists out of 3 types of links

Please note that a link to a category starts with [[:Category:... while a category tag starts with [[Category:.... The only difference is the ":" before Category. Category Tags will generate any ouput on the page.

The pipe "|" separates the link or category target from the modifier. In case of a link, the text after the pipe is show as the link text. In case of a category tag, the page is listed with the name after the pipe in the category.

Please read more about Category pages further down below.

[edit] Structure

The template used to create the general information phrase looks like this:

{Subjects} [[Documentary]]
hosted by {Narrators}, published by {Publishers} 
broadcasted as part of {Series} series 
in {Year} 
- {Languages} narration
{Themes}

While

Special cases:

  • If there is no Narrator or Host then instead of "hosted by {Narrator}" the text "with [[:Category:No narration|no narration]][[Category:No narration]]" is used to make it part of the No Narration category. Also the word "narration" at the end is replaced by "language".
  • If this documentary is not part of a series the phrase "broadcasted as part of {Series} series" is omitted completely.
  • If there is no spoken language (which includes no narration), then the {Languages} are replaced by [[:Category:No spoken language|No spoken language]][[Category:No spoken language]] to make it part of the No spoken language category.
  • If more than one language is used then the text "[[Multilanguage]]" is inserted before "narration".
  • If alternative names are available then these are listed below as "also known as". Each alternative name is a separate redirect page back to the original english page. If an alternative name is a translation of the english title, then the redirect page will have the category tag for the respective language. Chinese titles are interwiki-linked to [jlpzj.net]

Notes:

  • With time the template has received various modifications to cope with new requirements. On older pages the format may differ and should be updated.
  • The modifier for category tags ''[[Category:{Name}|{Modifier}]]'' is used to define the sort-name for this page in the respective category
* If the name starts with a number, the modifier is a hash '#' followed by the page name
* If the name starts with "A", "An", "The", "La", "Las", "El" or "Los" this prefix is postponed.
For example the page The 1900 House is sorted as "#1900 House, The"

[edit] Cover

The cover section should only contain one image with shows either the the film cover or a screenshot from the documentary with the title written on screen.

[edit] Information

The Information section holds a general description or synopsis of the contents of this documentary. If it is a multi-part series then it can contain sub-sections for each episode along with a cover or screenshot for each episode

[edit] Screenshots

A list or gallery of screenshots from the documentary.

[edit] Technical Specs

This section contains some technical details about the video file of this documentary. If there are several versions each version is given its own sub-section names by its separating characteristics.

[edit] Links

The links section is mainly a container for further links for this documentary or video file.

[edit] Further Information

If available, this section links to further information about the documentary or topic of the documentary. This can be the publishers website, wikipedia entry, etc.

[edit] Release Post

This sub-section contains a list of links to places where this documentary has been made available.

[edit] Related Documentaries

This sub-section contains a list of links to other documentaries which are related by topic or focus.

It should always contain at least one entry

[edit] ed2k Links

This sub-section contains the ed2k-links for the known video files enclosed in <ed2k>...</ed2k> tags. If multiple versions are available, they are separated by an "or" on an otherwise blank line.

[edit] Category Pages

Category Pages mostly have no contents of their own but serve as a grouping container for all other Pages, including other Category Pages.

Each Category Page starts with the Category: namespace.

[edit] Category Tags

To group other pages in a category with the name <CategoryName>, these pages need to contain a category Tag in their page source written as

[[Category:<CategoryName>]]

These tags are not visible on the actual page (only in the source) and are only used internally.

[edit] Sorting

All members of a category are listed below the category page contents (which is usually empty) and are grouped by their first letter and sorted by their pagename by default. To override this default you can provide a modifier to the category tag on the respective page written as

[[Category:<CategoryName>|<Modifier>]]

This modifier is separated by a pipe "|" and defines a sort-name for the category. The first letter of this modifier is used for grouping while the whole modifier is then used for to define the sorting order. The modifier is not displayed or shown anywhere and only changes the ordering invisibly.

More details: MediaWiki Help:Categories Sort Key

[edit] User Pages

Each user can have a user page named User:<Username> with no specific contents requirements. It's recommended to use this page to test out wiki syntax.

[edit] Talk Pages

Each Page has an associated Discussion or Talk Page. These are accessible through the "discussion" tab at the top of each page next to the "article" tab of the actual page contents.

These talk pages serve to discuss issues with the pages contents with other users.

[edit] Special Pages

Special pages have no editable contents but provide computed and generated information about other pages on the wiki. They can be accessed through a link in the bottom left toolbox

Personal tools