Contribution Guide

In order to keep an concise and consistent wiki the following guidelines should be adhered to when editing the Banano Wiki.

The goal of the Banano Wiki is to document all things relevant to the Banano cryptocurrency and its community.

Please read this contribution guide in full before creating or editing existing pages.

Editing[]

Creating a new page[]

Before creating a new page make use of the search function on the wiki to check for a existing page about the topic you want to write about, this could be articles with alternate spellings or capitalization.

After you have checked there are no existing pages about the topic feel free to create one by pressing the menu to the top right corner and selecting "Add new page". This will open a window where you enter the name (title) of the article page page you want to create. Now you will be brought to the visual editor, this editor works very well for most edits including text based edits, adding images or inserting templates. NOTE: Not all templates will format correctly until you save a page.

Editing an existing page[]

Editing an existing page is as simple as pressing edit on the top right corner of the article, this will bring you to the visual editor just like when creating a new page. Now one thing to consider is that most pages on the Banano Wiki use one or more templates to display content. These templates are used to provide a consistent look and structure across pages of a similar topic as well as speed up editing and creation of new and excising pages. This can make it slightly harder to edit a page but is necessary to keep the wiki consistent. To edit template variables with the visual editor simply press on a template and press edit, this should open a screen where you can see all template variables and what values they accept together with a description. Now simply add or edit the information for the variables and press apply and the template will update. NOTE: Not all templates will format correctly until you save a page.

Editing templates[]

NOTE: Editing templates takes special consideration as all pages using the template will be updated with the changes you make.

With that said editing templates might sometimes be necessary to fix a issue or add more content as examples. This is done using the source editor as it is the only editor to support the templating system. Templates are different from normal pages and require a special syntax to work properly. The syntax that should be used on templates are as follows:

<includeonly>TEMPLATE CODE HERE</includeonly>
<noinclude>{{Documentation}} RELEVAT CATEGORY FOR THE TEMPLATE HERE</noinclude>

This insures that only the template code is loaded when someone is using the template on another page and that the templates own documentation and categories aren't transcluded.

Template documentation[]

When editing a template make sure to also edit the documentation for that template. The template documentation should include a description, syntax, template data and example usage of the template, in that order. This is necessary so other people know how to use the template in the future as well as to keep the template data up to date so the variables have names and descriptions so they can be used in the visual editor more easily.

Template documentation pages should adhere to the following layout for consistency across all template documentation.

==Description==
Description text

==Syntax==
:Syntax example

==Template data==
<templatedata>
</templatedata>

==Examples==
Sample usage of the template

<noinclude>[[Category:Template documentation]]</noinclude>

Categories[]

All pages including templates and even categories them selves should be categorized probably with relevant categories. This will help with organization and discovery of pages. For example a infobox template should have the category Infobox templates while a page about a exchange should have the category Exchanges.

Infoboxes[]

Most pages have an infobox for general information on the topic. View Infobox templates to see all infoboxes available.

Each infobox has a documentation page containing description, syntax, template data and output.

Style guide[]

Dates[]

Dates should always use the template {{Date|<ISO 8601 date>}}.

Crypto addresses[]

When using a crypto addresses in text or templates you would most likely want to truncate them most of the time. This can be done with the template {{Crypto address|<Address>|<Network>}} which will create a truncated crypto address that links to the appropriate block explorer.

Interlanguage linking[]

General linking[]

Currently, these wiki are linked:

ZH-TW, VI, EN, JA

To link wiki another wiki, you need to add [[language code:article name]] to the article through source editor.

For example, if you want to link ZH-TW and EN wiki to VI wiki, you have to add the following interlanguage links:

[[zh-tw:蛋白質折疊_(Banano_miner)]]
[[en:Banano_Miner]]

As the article vi:Banano_Miner share the same title with English version, you can also use {{PAGENAME}} instead of filling the name again. Otherwise, each field must be manualy filled.

[[zh-tw:蛋白質折疊_(Banano_miner)]]
[[en:{{PAGENAME}}]]

When the link is established among the pages across wiki in different languages, there will be a drop-down language option on the top of the page.

Creating inline links[]

The rules can be applied to this kind of linking. The difference is the colon.

Example:

[[:vi:Banano_Miner]]

will generate

vi:Banano_Miner