Help:Editing: Difference between revisions
(the line-by-line thing isn't true with HTML tags) |
Hoof Hearted (talk | contribs) m (Text replacement - "Wiki Engine" to "Wiki engine") |
||
(21 intermediate revisions by 14 users not shown) | |||
Line 1: | Line 1: | ||
{{TOC right}} | |||
'''de''': [[Hilfe:Bearbeiten]], '''fr''': [[Aide:Edition]], '''it''': [[Aiuto:Modifiche]] | |||
---- | |||
'''Help:Editing''' — simple [[editing]] is one of the major benefits of using a [[wiki]]. [[User]]s can [[edit]] pages without knowing [[:Category:HTML|HTML]], and still use many of the [[mw:Help:Formatting|formatting]] features of HTML. Please feel free to experiment with these {{tag|help}} features in the [[WikiIndex:Sandbox]]. | |||
The MediaWiki software (the wiki software that is used here at WikiIndex) uses a special wiki markup language that is quite intuitive and very easy to learn. However one can also use HTML tags. That | The [[:Category:MediaWiki|MediaWiki]] software (the [[:Category:Wiki engine|wiki software]] that is used here at {{tag|WikiIndex}}) uses a special wiki [[:Category:Programming|markup language]] that is quite intuitive, and very easy to learn. However one can also use HTML tags. That is handy in case {{tag|wiki syntax}} does not provide a needed formatting feature. This '{{tag|Help|Help:}}' page provides an overview of editing on this [[WikiIndex]] wiki site. | ||
== Basic text == | ==Basic text== | ||
Most text does not require any special changes for wiki | Most text does not require any special changes for [[WhatIsWiki|wiki]] editing. A few basic rules are: | ||
*Do not routinely indent paragraphs; | |||
*Leave one single blank line between paragraphs; | |||
*To create a horizontal line, type four (4) or more hyphen <tt>(-)</tt> characters; | |||
*There is no need to encode HTML characters like <tt><</tt>, <tt>></tt>, <tt>&</tt> or <tt>"</tt>. | |||
==Bold and italic text== | |||
To mark text as '''bold''' or ''italic'', or '''''bold <u>and</u> italic''''', put the required number of apostrophies or inverted commas <tt>(')</tt> before and after those parts – two for italic and three for bold. For example: | |||
<nowiki>''italic''</nowiki> | |||
<nowiki>'''bold'''</nowiki> | |||
<nowiki>'''''bold+italic'''''</nowiki> | |||
Note that MediaWiki (like most [[:Category:Wiki engine|wiki software]]) processes {{tag|wiki syntax}} line-by-line, so if, for example, you want three bold lines of text, so you will have to format every line separately. | |||
==Headings== | |||
Headings are delimited by one-to-six (1–6) equal signs <tt>(=)</tt>. They basically correspond to HTML's <tt><nowiki><h1></nowiki></tt> through <tt><nowiki><h6></nowiki></tt> tags. | |||
== Headings == | |||
Headings are delimited by 1–6 equal signs (=). They basically correspond to HTML's <nowiki><h1></nowiki> through <nowiki><h6></nowiki> tags. | |||
<pre>= Headline of first order = | <pre>= Headline of first order = | ||
== Headline of second order == | == Headline of second order == | ||
Line 28: | Line 28: | ||
===== Headline of fifth order ===== | ===== Headline of fifth order ===== | ||
====== Headline of sixth order ======</pre> | ====== Headline of sixth order ======</pre> | ||
Note that first-order headings are not normally used in MediaWiki-powered sites. | |||
== Lists == | ==Lists== | ||
Lists are made by preceding list items by asterisk signs (*) for bulleted lists or number signs (#) for numbered lists. | Lists are made by preceding list items by asterisk signs <tt>(*)</tt> for bulleted lists, or the hash number signs <tt>(#)</tt> for numbered lists. | ||
Simple lists: | ===Simple lists:=== | ||
<pre> | <pre> | ||
* Text for a bulleted list item. | * Text for a bulleted list item. | ||
** Text for second-level list. | ** Text for second-level list. | ||
*** Text for third level, etc. | *** Text for third level, etc.</pre> | ||
</pre> | |||
...which looks like: | ...which looks like: | ||
Line 44: | Line 44: | ||
*** Text for third level, etc. | *** Text for third level, etc. | ||
Numbered lists: | ===Numbered lists:=== | ||
<pre> | <pre> | ||
# Text for a numbered list item. | # Text for a numbered list item. | ||
## Text for second-level list. | ## Text for second-level list. | ||
### Text for third level, etc. | ### Text for third level, etc. | ||
## Another Text for the second level. | ## Another Text for the second level.</pre> | ||
</pre> | |||
...which looks like: | ...which looks like: | ||
Line 58: | Line 57: | ||
## Another Text for the second level. | ## Another Text for the second level. | ||
== Indented text == | ==Indented text== | ||
To indent paragraphs preceed | To indent paragraphs, preceed the first word of the appropriate paragraph text with colon marks <tt>(:)</tt>; use several colons to obtain several levels of indentation. | ||
Simple indented text: | Simple indented text: | ||
Line 65: | Line 64: | ||
: Text to be indented (quote-block) | : Text to be indented (quote-block) | ||
:: Text indented more | :: Text indented more | ||
::: Text indented to third level | ::: Text indented to third level</pre> | ||
</pre> | |||
...which looks like: | ...which looks like: | ||
Line 73: | Line 71: | ||
::: Text indented to third level | ::: Text indented to third level | ||
== | ==Pre-formatted text== | ||
Individual lines can be displayed as | Individual words or lines of text can be displayed as pre-formatted (with fixed-pitch width or 'typewriter'-font) text, by placing one or more spaces at the start of the line of text. Other wiki formatting (like [[wikilink]]s) will be applied to this form of pre-formatted text. | ||
Additionally, multi-line sections can be marked as pre-formatted text using lines starting with <tt><nowiki><pre></nowiki></tt> (to start pre-formatted text), and <tt><nowiki></pre></tt></nowiki> (to end pre-formatted text). The <tt><nowiki><pre></nowiki></tt> and <tt><nowiki></pre></nowiki></tt> tags are not displayed in the rendered text. [[Wikilink]]s, and other wiki formatting is <u>not</u> carried out within a pre-formatted section. If wiki formatting is still required, use spaces at the start of the line instead of the <tt><nowiki><pre></nowiki></tt> and <tt><nowiki></pre></nowiki></tt> HTML tags. | |||
For instance: | For instance, when using the <tt><nowiki><pre></nowiki></tt> and <tt><nowiki></pre></nowiki></tt> HTML tags: | ||
<pre> | <pre> | ||
Pre-formatted section here. No other link | Pre-formatted section here. No other link | ||
or format processing | or format processing | ||
is done on pre-formatted sections. | is done on pre-formatted sections. | ||
For instance, [[ | For instance, [[signature]] is not a link here. | ||
</pre> | </pre> | ||
whereas: | |||
This is the starting-spaces version of | This is the starting-spaces version of | ||
pre-formatted text. Note that links like | |||
[[ | [[signature]] still work. | ||
---- | |||
==See also== | |||
See also [[Help:Contents]] | *[[Help:Contents]] — the 'index' of all help pages here on WikiIndex. | ||
[[ | [[Category:WikiIndex|Editing]] | ||
[[ | [[Category:Wiki syntax| ]] | ||
[[Category:FAQ|Editing]] |
Latest revision as of 19:27, 23 November 2022
de: Hilfe:Bearbeiten, fr: Aide:Edition, it: Aiuto:Modifiche
Help:Editing — simple editing is one of the major benefits of using a wiki. Users can edit pages without knowing HTML, and still use many of the formatting features of HTML. Please feel free to experiment with these help features in the WikiIndex:Sandbox.
The MediaWiki software (the wiki software that is used here at WikiIndex) uses a special wiki markup language that is quite intuitive, and very easy to learn. However one can also use HTML tags. That is handy in case wiki syntax does not provide a needed formatting feature. This 'Help:' page provides an overview of editing on this WikiIndex wiki site.
Basic text
Most text does not require any special changes for wiki editing. A few basic rules are:
- Do not routinely indent paragraphs;
- Leave one single blank line between paragraphs;
- To create a horizontal line, type four (4) or more hyphen (-) characters;
- There is no need to encode HTML characters like <, >, & or ".
Bold and italic text
To mark text as bold or italic, or bold and italic, put the required number of apostrophies or inverted commas (') before and after those parts – two for italic and three for bold. For example:
''italic'' '''bold''' '''''bold+italic'''''
Note that MediaWiki (like most wiki software) processes wiki syntax line-by-line, so if, for example, you want three bold lines of text, so you will have to format every line separately.
Headings
Headings are delimited by one-to-six (1–6) equal signs (=). They basically correspond to HTML's <h1> through <h6> tags.
= Headline of first order = == Headline of second order == === Headline of third order === ==== Headline of fourth order ==== ===== Headline of fifth order ===== ====== Headline of sixth order ======
Note that first-order headings are not normally used in MediaWiki-powered sites.
Lists
Lists are made by preceding list items by asterisk signs (*) for bulleted lists, or the hash number signs (#) for numbered lists.
Simple lists:
* Text for a bulleted list item. ** Text for second-level list. *** Text for third level, etc.
...which looks like:
- Text for a bulleted list item.
- Text for second-level list.
- Text for third level, etc.
- Text for second-level list.
Numbered lists:
# Text for a numbered list item. ## Text for second-level list. ### Text for third level, etc. ## Another Text for the second level.
...which looks like:
- Text for a numbered list item.
- Text for second-level list.
- Text for third level, etc.
- Another Text for the second level.
- Text for second-level list.
Indented text
To indent paragraphs, preceed the first word of the appropriate paragraph text with colon marks (:); use several colons to obtain several levels of indentation.
Simple indented text:
: Text to be indented (quote-block) :: Text indented more ::: Text indented to third level
...which looks like:
- Text to be indented (quote-block)
- Text indented more
- Text indented to third level
- Text indented more
Pre-formatted text
Individual words or lines of text can be displayed as pre-formatted (with fixed-pitch width or 'typewriter'-font) text, by placing one or more spaces at the start of the line of text. Other wiki formatting (like wikilinks) will be applied to this form of pre-formatted text.
Additionally, multi-line sections can be marked as pre-formatted text using lines starting with <pre> (to start pre-formatted text), and </pre></tt> (to end pre-formatted text). The <pre> and </pre> tags are not displayed in the rendered text. Wikilinks, and other wiki formatting is not carried out within a pre-formatted section. If wiki formatting is still required, use spaces at the start of the line instead of the <pre> and </pre> HTML tags.
For instance, when using the <pre> and </pre> HTML tags:
Pre-formatted section here. No other link or format processing is done on pre-formatted sections. For instance, [[signature]] is not a link here.
whereas:
This is the starting-spaces version of pre-formatted text. Note that links like signature still work.
See also
- Help:Contents — the 'index' of all help pages here on WikiIndex.