Editing guide: Difference between revisions

From Barion Documentation
Jump to navigation Jump to search
No edit summary
No edit summary
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)

Revision as of 12:07, 6 February 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
  • For syntax highlighting use JSON syntax
  • 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=Hello|text=This is a notification!|color=#1993c7}}
Hello
This is a notification!


  • 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.