Editing guide: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (15 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{PageTitle|title=Contributor's guide}} | {{PageTitle|title=Contributor's guide}} | ||
Here you can find the basic guidelines to use when editing any article of the Barion documentation. Please stand to these in order to minimize confusion and create a consistent syntax throughout the wiki. | |||
* Use whitespace when creating page titles (it will be converted into underscores in the URL) | * Use whitespace when creating page titles (it will be converted into underscores in the URL) | ||
* Do not leave redirects when moving pages | * Do not leave redirects when moving pages | ||
* Upload images in 200DPI resolution, embed in 1000px wide, set preference to 1024 | * Upload images in 200DPI resolution, embed in 1000px wide, set preference to 1024 | ||
* | * Use <nowiki><tt></tt></nowiki> tag for keywords or code fragments | ||
* Do not use TOC on Main Page | |||
* use | |||
* Use the <tt>PageTitle</tt> template to display article heading (automatic title is not displayed) | |||
<syntaxhighlight> | <syntaxhighlight> | ||
{{PageTitle|title=Barion API endpoint list}} | {{PageTitle|title=Barion API endpoint list}} | ||
</syntaxhighlight> | </syntaxhighlight> | ||
* E-mail addresses should have subject and in this format | * E-mail addresses should have subject and in this format | ||
| Line 16: | Line 21: | ||
[mailto:[email protected]?subject=Localisation-request [email protected]] | [mailto:[email protected]?subject=Localisation-request [email protected]] | ||
</syntaxhighlight> | </syntaxhighlight> | ||
* Page title and TOC | * Page title and TOC | ||
<pre><nowiki> | <pre><nowiki> | ||
{{PageTitle|title= Getting started - overview of Barion payments}} | {{PageTitle|title= Getting started - overview of Barion payments}} | ||
{{TableOfContents}} | {{TableOfContents}} | ||
</nowiki></pre> | </nowiki></pre> | ||
* | |||
* Use the <tt>NotificationBox</tt> template to display notifications | |||
<pre><nowiki>{{NotificationBox|title=NOTE|text=This is generic notification!|color=#1993c7}}</nowiki></pre> | |||
{{NotificationBox|title=Hello|text=This is a notification!|color=#1993c7}} | |||
<pre><nowiki>{{NotificationBox|title=IMPORTANT|text=This is an important tip or notification,but not a warning!|color=#FF7A3D}}</nowiki></pre> | |||
{{NotificationBox|title=IMPORTANT|text=This is an important tip or notification,but not a warning!|color=#FF7A3D}} | |||
<pre><nowiki>{{NotificationBox|title=WARNING|text=This is a warning!|color=#c20000}}</nowiki></pre> | |||
{{NotificationBox|title=WARNING|text=This is a warning!|color=#c20000}} | |||
* Mark incomplete articles with the <tt>IncompletePage</tt> template | |||
<pre><nowiki>{{IncompletePage}}</nowiki></pre> | |||
{{IncompletePage}} | |||
* For syntax highlighting, use JSON language | |||
<pre><nowiki><syntaxhighlight lang="json"> ... </syntaxhighlight></nowiki></pre> | |||
*[[PaymentAttachments|Payment Attachments - planned API]] | |||
Latest revision as of 12:13, 9 September 2017
Contributor's guide
Here you can find the basic guidelines to use when editing any article of the Barion documentation. Please stand to these in order to minimize confusion and create a consistent syntax throughout the wiki.
- Use whitespace when creating page titles (it will be converted into underscores in the URL)
- Do not leave redirects when moving pages
- Upload images in 200DPI resolution, embed in 1000px wide, set preference to 1024
- Use <tt></tt> tag for keywords or code fragments
- Do not use TOC on Main Page
- Use the PageTitle template to display article heading (automatic title is not displayed)
{{PageTitle|title=Barion API endpoint list}}
- E-mail addresses should have subject and in this format
[mailto:[email protected]?subject=Localisation-request [email protected]]
- Page title and TOC
{{PageTitle|title= Getting started - overview of Barion payments}}
{{TableOfContents}}
- Use the NotificationBox template to display notifications
{{NotificationBox|title=NOTE|text=This is generic notification!|color=#1993c7}}
Hello
This is a notification!
{{NotificationBox|title=IMPORTANT|text=This is an important tip or notification,but not a warning!|color=#FF7A3D}}
IMPORTANT
This is an important tip or notification,but not a warning!
{{NotificationBox|title=WARNING|text=This is a warning!|color=#c20000}}
WARNING
This is a warning!
- Mark incomplete articles with the IncompletePage template
{{IncompletePage}}
WARNING
This article is incomplete. It may change significantly without any notice, so don't rely on any content you find here yet. Please check back later.
- For syntax highlighting, use JSON language
<syntaxhighlight lang="json"> ... </syntaxhighlight>