Difference between revisions of "Help:Contents"

From Data Crystal
Jump to: navigation, search
m (When To Start A New Page: typo: if -> of)
 
(27 intermediate revisions by 11 users not shown)
Line 1: Line 1:
General information about editing and formatting wiki articles can be found at [http://meta.wikimedia.org/wiki/Help:Contents the Meta-Wiki help page]. Other links on this page will cover such topics specific to this wiki.
+
This page includes basic help for adding content to Data Crystal pages. [[#Additional Help|Additional help articles]] are available. General information about editing and formatting Wiki articles can be found at [http://meta.wikimedia.org/wiki/Help:Contents the Meta-Wiki help page].
  
* [[Help:Page names|Page naming conventions]]
+
== Additional Help ==
* [[Help:Templates|Templates used by this wiki]]
+
* [[Help:Ram Map|RAM Maps]]
* [[Help:Game page example|An example of the standard game page outline]]
+
* [[Help:Rom Map|ROM Maps]]
* [[Help:Table page example|An example of the standard table page outline]]
+
* [[Help:Notes|Notes Pages]]
* [[Help:Datacrystal Style|Stylistic and formatting conventions used by this wiki]]
+
* [[Help:Table Files|Table Files]]
* [[Help:Language|Linguistic conventions used by this wiki]]
+
* [[Help:Templates|Templates Help page]]
 +
* [[Help:Game page example|Game page example]]
  
==Community Projects==
+
 
===PJCL===
+
== Starting a new page ==
Project Cat Lover is a club founded by [[Cat Lover]] to do random stuff to improve the community.
+
===When To Start A New Page===
* Founder: [[Cat Lover]]
+
If you want to add information about a game and the game does not have a page on Data Crystal, you can add the page yourself. If circumstances warrant, you may also create a new sub-page for a game. The following would be good candidates for a new page.
* Members:
+
* Adding a game to Data Crystal
** [[Cat Lover]]
+
* Lengthy explanations of data structures or formats
* Misc Info:
+
* Long lists, data tables, or enumerations
** I'm willing to rename this club. --[[User:Cat Lover|Cat Lover]] 18:43, 14 April 2007 (EDT)
+
 
====PJstats====
+
 
Categorizing all the games into hacked-ness categories.
+
There are also certain types of pages that fall outside the scope of this wiki or should not be created without consulting staff.
100%
+
* Trivia/fun facts
====PJcate====
+
* Different revisions and dumps of the same game on the same console
Categorizing all the categories in [[Special:Uncategorizedcategories]].
+
* Game review, opinion, or discussion
174 divided by (174 - number completed) equals precent completed.
+
* Non-hacking related content
174 divided by 164 = 1.07% as of Saturday, April 14, 2007, 6:43 PM, GMT-05:00
+
 
 +
 
 +
Some additional tips when deciding whether to create a new page:
 +
* Can the new content go into the RAM map, ROM map, or notes page? Instead of creating an article with little content, it is often better to add a section to the game's standard [[Help:Notes|Notes]] page, with a link from the game's main page if appropriate. The RAM map, ROM map, and notes pages are all linked to from a game's main page on Data Crystal, as well as the game's page on [http://romhacking.net romhacking.net].
 +
* Can the new content be merged with an existing page? (Instead of creating separate pages for "spell values", "item values", "enemy values", etc. these lists can all go into a single page.)
 +
* Is it better to link to offsite content? This especially applies to content tangentially related to ROM-hacking, such as articles on game- or series-specific wikis, or [https://tcrf.net/The_Cutting_Room_Floor The Cutting Room Floor], for
 +
example.
 +
 
 +
===Tips On Creating A New Page===
 +
Use these guidelines for naming your articles. To create the page, type the desired page name into the search box, click "Go", and then click on the link to create the page.
 +
* For game pages, use the simplest, most obvious name possible; you can always create a redirect and/or disambiguation page later if needed.
 +
* Sub-pages regarding a single game or system should should use name of the game or console as a prefix, separated by a colon. For example, the item properties table for EarthBound is found at '''[[EarthBound:Item Properties Table]]''', and the article explaining colors for Super Nintendo is found at '''[[Super Nintendo:Color]]'''.
 +
 
 +
When creating a new page, try to follow conventions and use wiki templates as appropriate.
 +
* For a game's main page, try using an existing page for a different game as a starting point.
 +
* For [[Help:Ram Map|RAM maps]], [[Help:Rom Map|ROM maps]], [[Help:Notes|Notes pages]] and [[Help: Table Files|table files]], use the appropriate templates.
 +
* For other sub-pages, provide a link to the game's or system's main page.
 +
 
 +
 
 +
== Content And Conventions ==
 +
Data Crystal strives for a uniform style across all pages. Please adhere to the following guidelines when writing articles of your own. All Data Crystal articles should be written in [[Wikipedia:Standard English|Standard English]]. If you are unfamiliar with the English language, please contact an administrator before posting any articles. Refrain from using ''leetspeak'' or other non-standard forms of English on Data Crystal.
 +
 
 +
Since English is the primary language of this Wiki, game consoles will be referred to by the name they were released in the United States. For example, the '''Nintendo Famicom''' will be referred to as the '''Nintendo Entertainment System'''. Regarding games, the same rule applies and exceptions should be made in the case of games that were not released in the United States; however, an English name should be provided under Miscellaneous.
 +
 
 +
; Third-person point of view.
 +
: Data Crystal aims for an encyclopedic method of writing so please phrase all articles in the third person. This includes Wikipedia's idea of '''[[Wikipedia:Neutral point of view|Neutral point of view]]'''.
 +
; ROM Hacking Content.
 +
: Data Crystal is a repository of ROM Hacking information. Please limit the scope of articles to ROM Hacking and related topics. Many tangentially related topics already have thorough articles on Wikipedia, and we encourage inter-wiki linking. In fact, a [[Help:Templates|template]] exists to make this as easy as possible.
 +
; Game pages
 +
: Please create separate pages for each game. In creating these pages, please see the respective template game page.
 +
; Wiki networking
 +
: Please create links to newly created articles, and avoid creating orphaned pages.
 +
 
 +
 
 +
== Basic Wiki syntax ==
 +
<div align="center">
 +
{| style="border:1px solid #aaa; text-align:left;"
 +
|-<!--COLUMN HEADINGS-->
 +
| width="25%" style="background: #ccccff; text-align:center;"|'''Description'''
 +
| style="background: #ccccff; text-align:center; border:1px solid #ccc;"|'''You type'''
 +
| width="25%" style="background: #ccccff; text-align:center;"|'''You get'''
 +
|-<!--1ST HEADING-->
 +
| colspan="3" style="background: #ccccff; font-family: sans-serif; text-align:center;" | Applies anywhere
 +
|-<!--1ST ROW 1ST COLUMN-->
 +
|Italic text
 +
|<!--2ND COLUMN-->
 +
<tt><big><nowiki>''italic''</nowiki></big></tt>
 +
|<!--3RD COLUMN-->
 +
''italic''
 +
|-<!--HORIZONTAL LINE-->
 +
|colspan="3" style="border-top:1px solid #ccc;"|
 +
|-<!--2ND ROW 1ST COLUMN-->
 +
|Bold text
 +
|
 +
<tt><big><nowiki>'''bold'''</nowiki></big></tt>
 +
|
 +
'''bold'''
 +
|-
 +
|colspan="3" style="border-top:1px solid #ccc;"|
 +
|-
 +
|Bold and italic text
 +
|
 +
<tt><big><nowiki>'''''bold & italic'''''</nowiki></big></tt>
 +
|
 +
'''''bold & italic'''''
 +
|-
 +
|colspan="3" style="border-top:1px solid #ccc;"|
 +
|-
 +
|Internal link<br />
 +
(within Data Crystal)
 +
|
 +
<tt><big><nowiki>[[name of page]]</nowiki></big></tt><br />
 +
<tt><big><nowiki>[[name of page|display text]]</nowiki></big></tt><br />
 +
<tt><big><nowiki>[[#Basic Wiki syntax|anchor link text]]</nowiki></big></tt><br />
 +
|
 +
[[name of page]]<br />
 +
[[name of page|display text]]<br />
 +
[[#Basic Wiki syntax|anchor link text]]<br />
 +
|-
 +
|colspan="3" style="border-top:1px solid #ccc;"|
 +
|-
 +
|Redirect to another page
 +
|
 +
<tt><big><nowiki>#redirect [[Target page]]</nowiki></big></tt>
 +
|
 +
1. redirect [[Target page]]
 +
|-
 +
|colspan="3" style="border-top:1px solid #ccc;"|
 +
|-
 +
|External link<br />
 +
(to other websites)
 +
|
 +
<tt><big><nowiki>[http://www.example.com]</nowiki></big></tt><br />
 +
<tt><big><nowiki>[http://www.example.com display text]</nowiki></big></tt><br />
 +
<tt><big><nowiki>http://www.example.com</nowiki></big></tt>
 +
|
 +
[http://www.example.com]<br />
 +
[http://www.example.com display text]<br />
 +
http://www.example.com
 +
|-
 +
|colspan="3" style="border-top:1px solid #ccc;"|
 +
|-
 +
|Don't interpret text<br />
 +
|
 +
<tt><big><nowiki><!--an embedded comment--></nowiki></big></tt><br />
 +
<tt><big><nowiki><nowiki><!--an embedded comment--></nowiki></nowiki></big></tt>
 +
|
 +
<!--an embedded comment--><br />
 +
<nowiki><!--an embedded comment--></nowiki>
 +
|-
 +
|colspan="3" style="border-top:1px solid #ccc;"|
 +
|-
 +
|
 +
Sign your posts <br />
 +
on talk pages
 +
|
 +
<tt><big><nowiki>~~~~</nowiki></big></tt>
 +
|
 +
[[User:Username|Username]] {{CURRENTTIME}}, <br />
 +
{{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}} (UTC)
 +
|-<!--2ND HEADING-->
 +
| colspan="3" style="background: #ccccff; font-family: sans-serif; text-align:center;" | Applies only at the beginning of the line
 +
|-
 +
|Headings<br />
 +
of different sizes
 +
|
 +
<tt><big><nowiki>==level 1==</nowiki></big></tt><br />
 +
<tt><big><nowiki>===level 2===</nowiki></big></tt><br />
 +
<tt><big><nowiki>====level 3====</nowiki></big></tt><br />
 +
<tt><big><nowiki>=====level 4=====</nowiki></big></tt>
 +
|
 +
 
 +
Headings of different levels.
 +
 
 +
|-
 +
|colspan="3" style="border-top:1px solid #ccc;"|
 +
|-
 +
|Horizontal rule
 +
|
 +
<big><nowiki>----</nowiki></big>
 +
|
 +
----
 +
|-
 +
|colspan="3" style="border-top:1px solid #ccc;"|
 +
|-
 +
|Bulleted list
 +
|
 +
<tt><big>* list item a</big></tt><br />
 +
<tt><big>* list item b</big></tt><br />
 +
<tt><big>** list sub-item</big></tt><br />
 +
<tt><big>* list item c</big></tt>
 +
|
 +
* list item a
 +
* list item b
 +
** list sub-item
 +
* list item c
 +
|-
 +
|colspan="3" style="border-top:1px solid #ccc;"|
 +
|-
 +
|Numbered list
 +
|
 +
<tt><big># first list item</big></tt><br />
 +
<tt><big># second list item</big></tt><br />
 +
<tt><big>## sub-item</big></tt><br />
 +
<tt><big># third list item</big></tt>
 +
|
 +
# first list item
 +
# second list item
 +
## sub-item
 +
# third list item
 +
|-
 +
|colspan="3" style="border-top:1px solid #ccc;"|
 +
|-
 +
|Mixture of bulleted<br />and numbered lists
 +
|
 +
<tt><big>* list item X</big></tt><br />
 +
<tt><big>* list item Y</big></tt><br />
 +
<tt><big>*# first sub-item</big></tt><br />
 +
<tt><big>*# second sub-item</big></tt><br />
 +
<tt><big>* list item Z</big></tt>
 +
|
 +
* list item X
 +
* list item Y
 +
*# first sub-item
 +
*# second sub-item
 +
* list item Z
 +
|-
 +
|colspan="3" style="border-top:1px solid #ccc;"|
 +
|-
 +
|Definition
 +
|
 +
<tt><big>; Technical Term</big></tt><br />
 +
<tt><big>: Definition 1</big></tt><br />
 +
<tt><big>: Definition 2</big></tt><br />
 +
|
 +
; Technical Term
 +
: Definition 1
 +
: Definition 2
 +
|-
 +
|colspan="3" style="border-top:1px solid #ccc;"|
 +
|-
 +
|Indentation
 +
|
 +
<tt><big>: normal text (indented)</big></tt><br />
 +
<tt><big>::* List item A (indented)</big></tt><br />
 +
<tt><big>:# First List Item (indented)</big></tt><br />
 +
<tt><big>:; Technical Term (indented)</big></tt><br />
 +
|
 +
: normal text (indented)
 +
::* List item A (indented)
 +
:# First List Item (indented)
 +
:; Technical Term (indented)
 +
|-
 +
|colspan="3" style="border-top:1px solid #ccc;"|
 +
|-
 +
|Preformatted text<br />
 +
(boxed text)
 +
|
 +
<big><tt> add a space at the beginning of the line to create preformatted text in a box</tt></big><br />
 +
|
 +
<big>add a space at the beginning of the line<br />to create preformatted text in a box</big>
 +
|-
 +
|colspan="3" style="border-top:1px solid #ccc;"|
 +
|-
 +
|Thumbnail image
 +
|
 +
<big><tt><nowiki>[[Image:Wiki.png|thumb|Caption text]]</nowiki></tt></big><br />
 +
|
 +
[[Image:Super_Mario_Bros_Title.png|thumb|Caption text]]
 +
|}
 +
</div>
 +
 
 +
== Namespaces ==
 +
Pages on Data Crystal are grouped into collections called '''namespaces''', which differentiate between the purpose of the pages at a high level. Namespaces are indicated in page titles by prefixing the page name with ''namespace:'', so the prefix ''Help:'' in this page's title (''Help:Contents'') indicates that this page is in the '''Help''' namespace. Note, however, that colons and prefixes can also appear in page titles without indicating a namespace. For instance, the page [[Foo:Namespaces]] is a page located in the mainspace because the namespace '''Foo''' does not exist. Similarly the page [[Help:Foo:Namespaces]] is in the '''Help''' namespace.
 +
 
 +
There are several defined namespaces, for a complete list please refer to [http://www.mediawiki.org/wiki/Help:Namespaces the MediaWiki help page].
 +
 
 +
=== Main ===
 +
This is the ''null'' namespace, commonly called the '''main namespace''' or '''mainspace'''. This namespace typically contains the bulk of the content pages in Data Crystal.
 +
 
 +
=== User ===
 +
Each user has a corresponding page in the '''User''' namespace. This page and respective subpages, can be used by users to record information about themselves or to test and draft new content. For example, pages of the form ''User:UserName/Sandbox'' or ''User:UserName/TestPage'' can only be edited by the user themselves or by administrators.
 +
 
 +
=== File ===
 +
The '''File''' namespace is used to store images, videos or sound files. Each file has a corresponding page in the File namespace which should be used to hold licensing data as well.
 +
 
 +
=== Template ===
 +
The '''Template''' namespace is used to hold templates, blocks of text or wikicode that are intended to be embedded in several other pages.
 +
 
 +
=== Help ===
 +
The '''Help''' namespace is usually used to hold help files, instructions and 'how-to' guides.
 +
 
 +
 
 +
== Templates ==
 +
As mentioned above, Data Crystal includes a Template namespace which holds pages designed specifically to be embedded on other pages. Therefore, a page within the ''Template:'' namespace is called a '''template''' and this special page is meant to reduce the need for writing the same thing multiple times. Also, a page in the template namespace can be linked to like any other page:
 +
 
 +
<div align="center">
 +
{| style="margin: 15px; border:1px solid #aaa; text-align:center;"
 +
| width="33%" style="background: #ccccff;"|'''You type'''
 +
| width="33%" style="background: #ccccff;"|'''Where [[Template:Example1]] contains'''
 +
| width="33%" style="background: #ccccff;"|'''You get'''
 +
|-
 +
|<big><code><nowiki>[[Template:Example1]]</nowiki></code></big>
 +
|rowspan=4|<big><code>{{msgnw:Example1}}</code></big>
 +
|[[Template:Example1]]
 +
|-
 +
|<big><code><nowiki>{{Template:Example1}}</nowiki></code></big>
 +
|{{Example1}}
 +
|-
 +
|<big><code><nowiki>{{</nowiki>Example1<nowiki>}}</nowiki></code></big>
 +
|{{Example1}}
 +
|-
 +
|<big><code>abc<nowiki>{{Example1}}</nowiki>def</code></big>
 +
|abc{{Example1}}def
 +
|}
 +
</div>
 +
 
 +
One important feature of templates is their ability to take arguments. As shown in the previous table, a template with no arguments is called as <big><code><nowiki>{{template_name}}</nowiki></code></big>. Parameters are defined inside triple braces and when the template is embedded to a page, the contents of the parameter name will also be embedded:
 +
 
 +
<div align="center">
 +
{| style="margin: 15px; border:1px solid #aaa; text-align:center;"
 +
| width="33%" style="background: #ccccff;"|'''You type'''
 +
| width="33%" style="background: #ccccff;"|'''Where [[Template:Example2]] contains'''
 +
| width="33%" style="background: #ccccff;"|'''You get'''
 +
|-
 +
|<big><code><nowiki>{{Example2|1=Angus}}</nowiki></code></big>
 +
|rowspan=4|<big><code>{{msgnw:Example2}}</code></big>
 +
|{{Example2|1=Angus}}
 +
|-
 +
|<big><code><nowiki>{{Example2|Jimmy}}</nowiki></code></big>
 +
|{{Example2|Jimmy}}
 +
|-
 +
|<big><code><nowiki>{{Example2|2=Kirk}}</nowiki></code></big>
 +
|{{Example2|2=Kirk}}
 +
|-
 +
|<big><code><nowiki>{{Example2||David}}</nowiki></code></big>
 +
|{{Example2||David}}
 +
|}
 +
</div>
 +
 
 +
By default, the parameters are numbered in order, starting from 1; there is no practical limit to the number of parameters that can be defined (at least 65536).  However, named parameters may be added at any point without interrupting the numbering:
 +
 
 +
<div align="center">
 +
{| style="margin: 15px; border:1px solid #aaa; text-align:center;"
 +
| width="33%" style="background: #ccccff;"|'''You type'''
 +
| width="33%" style="background: #ccccff;"|'''Where [[Template:Example3]] contains'''
 +
| width="33%" style="background: #ccccff;"|'''You get'''
 +
|-
 +
|<big><code><nowiki>{{Example3|Super|Mario|Brothers}}</nowiki></code></big>
 +
|rowspan=5|<big><code>{{msgnw:Example3}}</code></big>
 +
|{{Example3|Super|Mario|Brothers}}
 +
|-
 +
|<big><code><nowiki>{{Example3|Super|Mario|x=Brothers}}</nowiki></code></big>
 +
|{{Example3|Super|Mario|x=Brothers}}
 +
|-
 +
|<big><code><nowiki>{{Example3|Super|x=Mario|Brothers}}</nowiki></code></big>
 +
|{{Example3|Super|x=Mario|Brothers}}
 +
|-
 +
|<big><code><nowiki>{{Example3|Super|x=Mario|x=Brothers}}</nowiki></code></big>
 +
|{{Example3|Super|x=Mario|x=Brothers}}
 +
|-
 +
|<big><code><nowiki>{{Example3|1=Super|2=Mario|=Brothers}}</nowiki></code></big>
 +
|{{Example3|1=Super|2=Mario|=Brothers}}
 +
|}
 +
</div>
 +
 
 +
Please refer to the [[Help:Templates|Templates Help page]] for a list of existing templates and their usage.

Latest revision as of 20:29, 26 June 2020

This page includes basic help for adding content to Data Crystal pages. Additional help articles are available. General information about editing and formatting Wiki articles can be found at the Meta-Wiki help page.

Additional Help


Starting a new page

When To Start A New Page

If you want to add information about a game and the game does not have a page on Data Crystal, you can add the page yourself. If circumstances warrant, you may also create a new sub-page for a game. The following would be good candidates for a new page.

  • Adding a game to Data Crystal
  • Lengthy explanations of data structures or formats
  • Long lists, data tables, or enumerations


There are also certain types of pages that fall outside the scope of this wiki or should not be created without consulting staff.

  • Trivia/fun facts
  • Different revisions and dumps of the same game on the same console
  • Game review, opinion, or discussion
  • Non-hacking related content


Some additional tips when deciding whether to create a new page:

  • Can the new content go into the RAM map, ROM map, or notes page? Instead of creating an article with little content, it is often better to add a section to the game's standard Notes page, with a link from the game's main page if appropriate. The RAM map, ROM map, and notes pages are all linked to from a game's main page on Data Crystal, as well as the game's page on romhacking.net.
  • Can the new content be merged with an existing page? (Instead of creating separate pages for "spell values", "item values", "enemy values", etc. these lists can all go into a single page.)
  • Is it better to link to offsite content? This especially applies to content tangentially related to ROM-hacking, such as articles on game- or series-specific wikis, or The Cutting Room Floor, for

example.

Tips On Creating A New Page

Use these guidelines for naming your articles. To create the page, type the desired page name into the search box, click "Go", and then click on the link to create the page.

  • For game pages, use the simplest, most obvious name possible; you can always create a redirect and/or disambiguation page later if needed.
  • Sub-pages regarding a single game or system should should use name of the game or console as a prefix, separated by a colon. For example, the item properties table for EarthBound is found at EarthBound:Item Properties Table, and the article explaining colors for Super Nintendo is found at Super Nintendo:Color.

When creating a new page, try to follow conventions and use wiki templates as appropriate.

  • For a game's main page, try using an existing page for a different game as a starting point.
  • For RAM maps, ROM maps, Notes pages and table files, use the appropriate templates.
  • For other sub-pages, provide a link to the game's or system's main page.


Content And Conventions

Data Crystal strives for a uniform style across all pages. Please adhere to the following guidelines when writing articles of your own. All Data Crystal articles should be written in Standard English. If you are unfamiliar with the English language, please contact an administrator before posting any articles. Refrain from using leetspeak or other non-standard forms of English on Data Crystal.

Since English is the primary language of this Wiki, game consoles will be referred to by the name they were released in the United States. For example, the Nintendo Famicom will be referred to as the Nintendo Entertainment System. Regarding games, the same rule applies and exceptions should be made in the case of games that were not released in the United States; however, an English name should be provided under Miscellaneous.

Third-person point of view.
Data Crystal aims for an encyclopedic method of writing so please phrase all articles in the third person. This includes Wikipedia's idea of Neutral point of view.
ROM Hacking Content.
Data Crystal is a repository of ROM Hacking information. Please limit the scope of articles to ROM Hacking and related topics. Many tangentially related topics already have thorough articles on Wikipedia, and we encourage inter-wiki linking. In fact, a template exists to make this as easy as possible.
Game pages
Please create separate pages for each game. In creating these pages, please see the respective template game page.
Wiki networking
Please create links to newly created articles, and avoid creating orphaned pages.


Basic Wiki syntax

Description You type You get
Applies anywhere
Italic text

''italic''

italic

Bold text

'''bold'''

bold

Bold and italic text

'''''bold & italic'''''

bold & italic

Internal link

(within Data Crystal)

[[name of page]]
[[name of page|display text]]
[[#Basic Wiki syntax|anchor link text]]

name of page
display text
anchor link text

Redirect to another page

#redirect [[Target page]]

1. redirect Target page

External link

(to other websites)

[http://www.example.com]
[http://www.example.com display text]
http://www.example.com

[1]
display text
http://www.example.com

Don't interpret text

<!--an embedded comment-->
<nowiki><!--an embedded comment--></nowiki>


<!--an embedded comment-->

Sign your posts
on talk pages

~~~~

Username 23:43,
21 October 2021 (UTC)

Applies only at the beginning of the line
Headings

of different sizes

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

Headings of different levels.

Horizontal rule

----


Bulleted list

* list item a
* list item b
** list sub-item
* list item c

  • list item a
  • list item b
    • list sub-item
  • list item c
Numbered list

# first list item
# second list item
## sub-item
# third list item

  1. first list item
  2. second list item
    1. sub-item
  3. third list item
Mixture of bulleted
and numbered lists

* list item X
* list item Y
*# first sub-item
*# second sub-item
* list item Z

  • list item X
  • list item Y
    1. first sub-item
    2. second sub-item
  • list item Z
Definition

; Technical Term
: Definition 1
: Definition 2

Technical Term
Definition 1
Definition 2
Indentation

: normal text (indented)
::* List item A (indented)
:# First List Item (indented)
:; Technical Term (indented)

normal text (indented)
  • List item A (indented)
  1. First List Item (indented)
Technical Term (indented)
Preformatted text

(boxed text)

add a space at the beginning of the line to create preformatted text in a box

add a space at the beginning of the line
to create preformatted text in a box
Thumbnail image

[[Image:Wiki.png|thumb|Caption text]]

Caption text

Namespaces

Pages on Data Crystal are grouped into collections called namespaces, which differentiate between the purpose of the pages at a high level. Namespaces are indicated in page titles by prefixing the page name with namespace:, so the prefix Help: in this page's title (Help:Contents) indicates that this page is in the Help namespace. Note, however, that colons and prefixes can also appear in page titles without indicating a namespace. For instance, the page Foo:Namespaces is a page located in the mainspace because the namespace Foo does not exist. Similarly the page Help:Foo:Namespaces is in the Help namespace.

There are several defined namespaces, for a complete list please refer to the MediaWiki help page.

Main

This is the null namespace, commonly called the main namespace or mainspace. This namespace typically contains the bulk of the content pages in Data Crystal.

User

Each user has a corresponding page in the User namespace. This page and respective subpages, can be used by users to record information about themselves or to test and draft new content. For example, pages of the form User:UserName/Sandbox or User:UserName/TestPage can only be edited by the user themselves or by administrators.

File

The File namespace is used to store images, videos or sound files. Each file has a corresponding page in the File namespace which should be used to hold licensing data as well.

Template

The Template namespace is used to hold templates, blocks of text or wikicode that are intended to be embedded in several other pages.

Help

The Help namespace is usually used to hold help files, instructions and 'how-to' guides.


Templates

As mentioned above, Data Crystal includes a Template namespace which holds pages designed specifically to be embedded on other pages. Therefore, a page within the Template: namespace is called a template and this special page is meant to reduce the need for writing the same thing multiple times. Also, a page in the template namespace can be linked to like any other page:

You type Where Template:Example1 contains You get
[[Template:Example1]] Hello World! Template:Example1
{{Template:Example1}} Hello World!
{{Example1}} Hello World!
abc{{Example1}}def abcHello World!def

One important feature of templates is their ability to take arguments. As shown in the previous table, a template with no arguments is called as {{template_name}}. Parameters are defined inside triple braces and when the template is embedded to a page, the contents of the parameter name will also be embedded:

You type Where Template:Example2 contains You get
{{Example2|1=Angus}} Hello {{{1}}}! Hello Angus!
{{Example2|Jimmy}} Hello Jimmy!
{{Example2|2=Kirk}} Hello {{{1}}}!
{{Example2||David}} Hello !

By default, the parameters are numbered in order, starting from 1; there is no practical limit to the number of parameters that can be defined (at least 65536). However, named parameters may be added at any point without interrupting the numbering:

You type Where Template:Example3 contains You get
{{Example3|Super|Mario|Brothers}} {{{1}}} {{{2}}} {{{x}}}! Super Mario {{{x}}}!
{{Example3|Super|Mario|x=Brothers}} Super Mario Brothers!
{{Example3|Super|x=Mario|Brothers}} Super Brothers Mario!
{{Example3|Super|x=Mario|x=Brothers}} Super {{{2}}} Brothers!
{{Example3|1=Super|2=Mario|=Brothers}} Super Mario {{{x}}}!

Please refer to the Templates Help page for a list of existing templates and their usage.