Difference between revisions of "Editing guide"

From Barion Documentation
Jump to navigation Jump to search
Line 5: Line 5:
 
*For syntax highlighting use JSON syntax
 
*For syntax highlighting use JSON syntax
 
*use <nowiki><tt></tt></nowiki> tag for keywords or code fragments
 
*use <nowiki><tt></tt></nowiki> tag for keywords or code fragments
*use Title template, as automatic page title is hidden  <nowiki>{{PageTitle|title=Barion API endpoint list}}</nowiki>
+
*use Title template, as automatic page title is hidden   
*E-mail addresses should have subject and in this format [mailto:[email protected]?subject=Localisation-request [email protected]]
+
<syntaxhighlight>
 +
{{PageTitle|title=Barion API endpoint list}}</nowiki>
 +
</syntaxhighlight>
 +
 
 +
*E-mail addresses should have subject and in this format  
 +
<syntaxhighlight>
 +
[mailto:[email protected]?subject=Localisation-request [email protected]]
 +
</syntaxhighlight>
  
 
*Page title and TOC
 
*Page title and TOC
Line 16: Line 23:
 
| __TOC__
 
| __TOC__
 
|}
 
|}
</syntaxhighlight >
+
</syntaxhighlight>

Revision as of 22:21, 5 February 2017

Editing guide

  • Don't use underscores in page names
  • Name pages as if titles: Going Live -> Going-Live
  • 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
  • use Title template, as automatic page title is hidden
{{PageTitle|title=Barion API endpoint list}}</nowiki>
  • E-mail addresses should have subject and in this format
[mailto:[email protected]?subject=Localisation-request [email protected]]
  • Page title and TOC

We shoudl use a template for TOC as well...

{{PageTitle|title= Getting started - overview of Barion payments}}

{| style="margin-left:2em;" align="right"
| __TOC__
|}