Help:Editing: Difference between revisions

m Social aspects: Move "Categories" into its own section (not related to social aspects)
ArrowHead294 (talk | contribs)
mNo edit summary
Line 1: Line 1:
Wikis should be easy to edit, so most text you add or change will appear as you expect it. But you can do more if you want.
Wikis should be easy to edit, so most text you add or change will appear as you expect it. But you can do more if you want.


[https://wikiindex.org/Xenharmonic_Wiki This wiki] is currently in [https://wikiindex.org/Category:ConfirmEmail ConfirmEmail mode] after the move from [[Wikispaces]] to a MediaWiki-based installation (the edit mode may change again some time). For editing or adding information to the wiki, you have to join it. See [[How to Get Your Xenwiki Account]] for more!
[https://wikiindex.org/Xenharmonic_Wiki This wiki] is currently in [https://wikiindex.org/Category:ConfirmEmail ConfirmEmail mode] after the move from Wikispaces to a MediaWiki-based installation (the edit mode may change again some time). For editing or adding information to the wiki, you have to join it. See [[How to Get Your Xenwiki Account]] for more!


== Using links ==
== Using links ==
:''Shortcut: [[Help: Links]]''
: ''Shortcut: [[Help: Links]]''
What you always have dreamed of (for your paper notes) - in a wiki it becomes true: fast links!
What you always have dreamed of (for your paper notes)—in a wiki it becomes true: fast links!


=== Internal links ===
=== Internal links ===
 
If you enclose a word in double brackets (like <code><nowiki>[[word]]</nowiki></code>), you get an internal link, hopefully to an already existing page&mdash;if not, it appears red, and you just created the opportunity for your co-authors to add the details. If you want a text differing from the link target, you can place it after a pipe symbol: <code><nowiki>[[word|different text]]</nowiki></code>.  
If you enclose a word in double brackets (like <code><nowiki>[[word]]</nowiki></code>), you get an internal link, hopefully to an already existing page - if not, it appears red, and you just created the opportunity for your co-authors to add the details. If you want a text differing from the link target, you can place it after a pipe symbol: <code><nowiki>[[word|different text]]</nowiki></code>.  


=== Linking to sections ===
=== Linking to sections ===
You may link to sections in the same page by using the section title with the prefix <code>#</code>. MediaWiki automatically converts it into a link with the correct anchor identifier. For example to link to the beginning of this section use <code><nowiki>[[#Using links]]</nowiki></code> (rendered as [[#Using links]]) or with changed text <code><nowiki>[[#Using links|top of this section]]</nowiki></code> (rendered as [[#Using links|top of this section]]).
You may link to sections in the same page by using the section title with the prefix <code>#</code>. MediaWiki automatically converts it into a link with the correct anchor identifier. For example to link to the beginning of this section use <code><nowiki>[[#Using links]]</nowiki></code> (rendered as [[#Using links]]) or with changed text <code><nowiki>[[#Using links|top of this section]]</nowiki></code> (rendered as [[#Using links|top of this section]]).


=== Interwiki links ===
=== Interwiki links ===
Links to some wikis are supported by placing a specific wiki alias and a colon (<code>:</code>) to the common in-wiki link syntax: <code><nowiki>[[otherwiki: name there]]</nowiki></code> as a prefix, for example, <code><nowiki>[[Wikipedia: Microtonal music]]</nowiki></code> gets rendered as [[Wikipedia: Microtonal music]]. Although this features is named "interwiki", is also includes some services that are definitively not wiki-like, for instance a google search can as well be embedded in wiki syntax: <code><nowiki>[[Google: 159edo]]</nowiki></code> (rendered as: [[Google: 159edo]]) The sites currently supported are managed in [[Special:Interwiki]]. A space after the prefix doesn't change the effect but looks better.
Links to some wikis are supported by placing a specific wiki alias and a colon (<code>:</code>) to the common in-wiki link syntax: <code><nowiki>[[otherwiki: name there]]</nowiki></code> as a prefix, for example, <code><nowiki>[[Wikipedia: Microtonal music]]</nowiki></code> gets rendered as [[Wikipedia: Microtonal music]]. Although this features is named "interwiki", is also includes some services that are definitively not wiki-like, for instance a google search can as well be embedded in wiki syntax: <code><nowiki>[[Google: 159edo]]</nowiki></code> (rendered as: [[Google: 159edo]]) The sites currently supported are managed in [[Special:Interwiki]]. A space after the prefix doesn't change the effect but looks better.


=== External links ===
=== External links ===
For external links, simply place the URL into the text, certain protocols (http, https, mailto) will be automatically transformed into links. For alternate text, use single brackets, start with the URL and after a space enter the title, like so <code><nowiki>[http://acid3.acidtests.org the Acid3 test]</nowiki></code> which renders to [http://acid3.acidtests.org the Acid3 test].
For external links, simply place the URL into the text, certain protocols (http, https, mailto) will be automatically transformed into links. For alternate text, use single brackets, start with the URL and after a space enter the title, like so <code><nowiki>[http://acid3.acidtests.org the Acid3 test]</nowiki></code> which renders to [http://acid3.acidtests.org the Acid3 test].


Line 27: Line 23:


=== Redirects ===
=== Redirects ===
Redirects can be [[#Regular redirect|regular]] or [[#Smart redirect|“smart”]] (definition redirect).  
Redirects can be [[#Regular redirect|regular]] or [[#Smart redirect|“smart”]] (definition redirect).  


==== Regular redirect ====
==== Regular redirect ====
A regular redirect is performed by <code><nowiki>#REDIRECT [[Page title]]</nowiki></code>.  
A regular redirect is performed by <code><nowiki>#REDIRECT [[Page title]]</nowiki></code>.  


Line 38: Line 32:
Redirects are also useful to directly link into sections (especially if they have the potential to grow to an article in future).
Redirects are also useful to directly link into sections (especially if they have the potential to grow to an article in future).


Redirects to redirects should be fixed by skipping intermediate targets. The page [[Special: DoubleRedirects]] can be used to detect them.
Redirects to redirects should be fixed by skipping intermediate targets. The page [[Special:DoubleRedirects]] can be used to detect them.


==== Smart redirect ====
==== Smart redirect ====
A "smart redirect" is a page that has a small definition of a term with a link to a broader presentation of the corresponding area. Don't forget to categorize such a page by placing <code><nowiki>[[Category:smart redirect]]</nowiki></code> at its end.
A "smart redirect" is a page that has a small definition of a term with a link to a broader presentation of the corresponding area. Don't forget to categorize such a page by placing <code><nowiki>[[Category:smart redirect]]</nowiki></code> at its end.


Line 49: Line 42:


==== Soft redirect ====
==== Soft redirect ====
 
This kind of redirect has been eliminated and should not be used anymore. It was there for a historical reason: to overcome usability issues on Wikispaces (the former wiki platform): Editing redirects was restricted to administrators, so normal users could not expand a redirect page into a full article. (See also [https://yahootuninggroupsultimatebackup.github.io/tuning/topicId_101227.html Yahoo! Tuning Group] for the discussion on the tuning list)
This kind of redirect has been eliminated and '''should not be used any more'''. It was there for a historical reason only to overcome usability issues on wikispaces (the former wiki platform): editing redirects was restricted to administrators, so normal users could not expand a redirect page into a full article. (See also [https://yahootuninggroupsultimatebackup.github.io/tuning/topicId_101227.html Yahoo! Tuning Group] for the discussion on the tuning list)


== Text formatting ==
== Text formatting ==
=== Emphasis ===
=== Emphasis ===
Some typographic markup can easy be added by including the phrase in doubled <code><nowiki>''</nowiki></code> or tripled <code><nowiki>'''</nowiki></code> (apostrophe chars):
Some typographic markup can easy be added by including the phrase in doubled <code><nowiki>''</nowiki></code> or tripled <code><nowiki>'''</nowiki></code> (apostrophe chars):


* ''italic'' using <nowiki>''italic''</nowiki>
* '''Bold''' using <nowiki>'''bold'''</nowiki>
* '''bold''' using <nowiki>'''bold'''</nowiki>
* ''Italic'' using <nowiki>''italic''</nowiki>
* '''''bold italic''''' using <nowiki>'''''bold italic'''''</nowiki>
* '''''Bold italic''''' using <nowiki>'''''bold italic'''''</nowiki>


=== Lists ===
=== Lists ===
:''See [[Help: List]] for advanced use cases.''
: ''See [[Help: List]] for advanced use cases.''
There are tree basic types of lists in HTML that are supported in MediaWiki markup: [[#unordered|unordered]] (or "bulleted") lists, [[#numbered|numbered]] lists, [[#description|description]] lists. Each type of lists can be created within wiki source code by just indicating the items at the beginning of the line (the list is automatically built around them). Each item has to start on a new line.
There are tree basic types of lists in HTML that are supported in MediaWiki markup: [[#unordered|unordered]] (or "bulleted") lists, [[#numbered|numbered]] lists, [[#description|description]] lists. Each type of lists can be created within wiki source code by just indicating the items at the beginning of the line (the list is automatically built around them). Each item has to start on a new line.


Line 83: Line 74:


; Coffee
; Coffee
: a brewed drink prepared from roasted coffee beans. (from: ''[[Wikipedia: Coffee]])
: A brewed drink prepared from roasted coffee beans. (from: ''[[Wikipedia: Coffee]])
 
; Wine
; Wine
: an alcoholic beverage made from fermented grapes. (from: ''[[Wikipedia: Wine]]'')
: An alcoholic beverage made from fermented grapes. (from: ''[[Wikipedia: Wine]]'')
 
; Milk
; Milk
: a white liquid nutrient-rich food produced by the mammary glands of mammals. (from: ''[[Wikipedia: Milk]]'')
: A white liquid nutrient-rich food produced by the mammary glands of mammals. (from: ''[[Wikipedia: Milk]]'')


==== Combined List Styles ====
==== Combined List Styles ====
# Morning
# Morning
#* Coffee
#* Coffee
Line 99: Line 91:


=== Tables ===
=== Tables ===
:''for advanced examples see [[Help:Table]]''
: ''For advanced examples, see [[Help:Table]]''


You can add tables to wiki pages:
You can add tables to wiki pages:
{| class="wikitable"
{| class="wikitable"
! You write <br> in <br> [[Help:Wikitext editor|wikitext]]
! You write <br /> in <br /> [[Help:Wikitext editor|wikitext]]
|
|
  <nowiki>
  <nowiki>
Line 117: Line 109:
|}</nowiki>
|}</nowiki>
|-
|-
! You get <br> (rendered)
! You get <br /> (rendered)
|
|
<!-- begin result -->
<!-- begin result -->
Line 136: Line 128:


==== Horizontal alignment of column content ====
==== Horizontal alignment of column content ====
Text alignment can be an issue. The table default is cell text being left-alignened, but decimal numbers usually are right-aligned and common fractions center-aligned.
Text alignment can be an issue. The table default is cell text being left-alignened, but decimal numbers usually are right-aligned and common fractions center-aligned.


Line 149: Line 140:


=== Images ===
=== Images ===
Inserting a JPEG, GIF, or PNG image is pretty straightforward when using the visual page editor click the "File" button and upload the image. Or in Wikitext, use <code><nowiki>[[image:filename]]</nowiki></code> or <code><nowiki>[[file:filename]]</nowiki></code>. Also SVG images are supported (<code><nowiki>[[file:some.svg]]</nowiki></code>), they are automatically transformed into PNG images by the MediaWiki software, because not all Browsers come with native SVG support. A possible problem can arise when the image uses fonts that are not available on the wiki server. To prevent such errors, you can transform text into graphic objects before uploading the image here.
Inserting a JPEG, GIF, or PNG image is pretty straightforward&mdash;when using the visual page editor, click the "File" button and upload the image. Or in Wikitext, use <code><nowiki>[[image:filename]]</nowiki></code> or <code><nowiki>[[file:filename]]</nowiki></code>. Also SVG images are supported (<code><nowiki>[[file:some.svg]]</nowiki></code>), they are automatically transformed into PNG images by the MediaWiki software, because not all Browsers come with native SVG support. A possible problem can arise when the image uses fonts that are not available on the wiki server. To prevent such errors, you can transform text into graphic objects before uploading the image here.


=== Maths formulas ===
=== Maths formulas ===
… can be used {{w|Help:Displaying a formula|like in Wikipedia}}. For inline math, start it with <code><nowiki><math></nowiki></code> and end it with <code><nowiki></math></nowiki></code>. For example: <math>V =\frac{4}{3} \pi r^3</math>. For display-style math, open and close the formulas with both <code><nowiki>$$</nowiki></code>; this will render it centered in a new line.  
… can be used {{w|Help:Displaying a formula|like in Wikipedia}}. For inline math, start it with <code>{{^(}}math{{)^}}</code> and end it with <code>{{^(}}/math{{)^}}</code>. For example: <math>V =\frac{4}{3} \pi r^3</math>. For display-style math, open and close the formulas with both <code><nowiki>$$</nowiki></code>; this will render it centered in a new line.  


Here is a browser-based formula editor that may be helpful: [https://editor.codecogs.com/ Equation Editor]
Here is a browser-based formula editor that may be helpful: [https://editor.codecogs.com/ Equation Editor]
Line 160: Line 151:


=== References ===
=== References ===
A reference mark is added by <code><nowiki><ref></nowiki></code> and <code><nowiki></ref></nowiki></code> parenthesising the reference text. The reference texts are shown in the bottom of the article by default; you can optionally insert <code><nowiki><references/></nowiki></code> where you wish to show them.
A reference mark is added by <code>{{^(}}ref{{)^}}</code> and <code>{{^(}}/ref{{)^}}</code> parenthesising the reference text. The reference texts are shown in the bottom of the article by default; you can optionally insert <code>{{^(}}references /{{)^}}</code> where you wish to show them.


== Article structure ==
== Article structure ==
 
* Articles should start with an introduction (summary, synopsis) that help to get a basic understanding what it is about. Don't introduce another heading for the introduction&mdash;t's already provided by the h1 heading of the lemma itself.
* Articles should start with an introduction (summary, synopsis) that help to get a basic understanding what it is about. Don't introduce another heading for the introduction: it's already provided by the h1 heading of the lemma itself.
* After this section (about one to five sentences), subheadings may follow to deepen the concept.  
* After this section (about one to five sentences), subheadings may follow to deepen the concept.  
* The end of the article is typically for see-also suggestions and external links.
* The end of the article is typically for see-also suggestions and external links.
Line 184: Line 174:


A category may have its own content (and category)
A category may have its own content (and category)
:''see [https://en.xen.wiki/w/Special:AllPages?from=&to=&namespace=14 Pages in the namespace '''Category''']''
: ''See [https://en.xen.wiki/w/Special:AllPages?from=&to=&namespace=14 Pages in the namespace '''Category''']''
or not yet (despite being used to categorize other pages):
or not yet (despite being used to categorize other pages):
:''see [[Special: WantedCategories]]''
: ''See [[Special: WantedCategories]]''


Some more examples:
Some more examples:


* [[:Category: Todo:add definition]] – here a term needs to be defined
* [[:Category:Todo:add definition]] – here a term needs to be defined
* [[:Category: Todo]] – category of categories that flag articles
* [[:Category:Todo]] – category of categories that flag articles


== Social aspects ==
== Social aspects ==
In this wiki, you can use talk pages and [[user talk]] pages.  
In this wiki, you can use talk pages and [[user talk]] pages.  


Line 207: Line 196:


== See also ==
== See also ==
* [[Xenharmonic Wiki: Conventions]]
* [[Xenharmonic Wiki:Conventions]]
* [[Xenharmonic Wiki: Article guidelines]]
* [[Xenharmonic Wiki:Article guidelines]]
* [[Help: Help]]
* [[Help:Help]]
* [[Help: Visual editor]] – especially helpful for new users, that's why it's enabled by default
* [[Help:Visual editor]] &mdash; Especially helpful for new users, that's why it's enabled by default


[[Category:Help]]
[[Category:Help]]