Difference between revisions of "RockpiS/contribute"

Latest revision as of 08:43, 26 March 2020

About this wiki

Radxa wiki is the place gathering info, guides and tutorial of Radxa products. The wiki is open to register and maintained by the community and Radxa team. Feel free to add/edit radxa product's related info on the wiki page. Most of the pages can be edited without permission, some pages the team think important are protected.

How to edit

1. You must create an account to edit, check the top menu Edit -> Personal -> Create account. The forum account won't work.
2. After logging in, you can edit the wiki page by clicking Edit -> Edit in the top menu.
3. For the wiki syntax, please refer to wiki formatting
4. Always preview your edit before saving

Special templates

1. Nav Bar

Each product has its own nav bar for the user to find the content easier. To add that, include the following at the first line of the page:

    {{rockpiS_header}}

The content of rockpiS_header template is as below:

<div class="col-md-12">
<div class="col-sm-12">
      <ul class="nav nav-pills nav-tabs-lighter">
        <li>[[rockpiS| Main]]</li>
        <li>[[rockpiS/getting_started | Getting Started]]</li>
        <li>[[rockpiS/hardware | Hardware]]</li>
        <li>[[rockpiS/downloads | Downloads]]</li>
        <li>[[rockpiS/FAQs | FAQs]]</li>
      </ul>
</div>
</div>

It looks like below:

You can also add the nav bar for other language by adding a new template, Template:RockpiS_header_es and Template:RockpiS_header_zh_cn is an example.

2. Multiple Language

The wiki supports multiple language by using the language template. If you want to add your language, edit language template first. It's content as below:

<div class="col-md-12">
<div class="btn btn-primary pull-right"><i class="fa fa-language"></i> [[{{{1|:{{NAMESPACE}}:{{BASEPAGENAME}}}}}|{{#language:en}}]]</div> 
<div class="btn btn-primary pull-right"><i class="fa fa-language"></i> [[{{{1|:{{NAMESPACE}}:{{BASEPAGENAME}}}}}/zh_cn|{{#language:zh-cn}}]]</div> 
<div class="btn btn-primary pull-right"><i class="fa fa-language"></i> [[{{{1|:{{NAMESPACE}}:{{BASEPAGENAME}}}}}/es_es|{{#language:es}}]]</div> 
<div class="btn btn-primary pull-right"><i class="fa fa-language"></i> [[{{{1|:{{NAMESPACE}}:{{BASEPAGENAME}}}}}/de_DE|{{#language:de}}]]</div> 
<div class="btn btn-primary pull-right"><i class="fa fa-language"></i> [[{{{1|:{{NAMESPACE}}:{{BASEPAGENAME}}}}}/pt_BR|{{#language:pt-br}}]]</div>
<div class="box-Title"></div>
</div>

Add your language code as above and save the template.

Each page with multiple language support must include the template at the second line, next to the Nav Bar. The page name must be passed to the template after the | sign, example of the getting started page of ROCK Pi S:

{{Languages|rockpi4/getting_started}}

It will looks like this:

Then click the language button to create/goto the ROCK Pi S getting started page of corresponding language.

Note:

When you translate a page, which has link to other page on the same wiki, you should add the country code in the url, so that the user will always jump to the destination page of the same language.

In English version, link to getting started page is [[RockpiS/getting_started]]

For the Simplified Chinese version, the link should be changed to  [[RockpiS/getting_started/zh_cn]].

Remember:

• Germany content page url always ends with de_DE
• Simplified Chinese content page url always ends with zh_cn
• Spanish content page url always ends with es_es
• ...

3. Breadcrumb

If the page depth is deeper than 2, a breadcrumb should be added to the beginning of the page for the user to go back to the upper level page.

    [[rockpiS | ROCK Pi S]] > [[rockpiS/install | Install]] > [[rockpiS/install/microSD | Install on MicroSD]]

It looks like this:

    ROCK Pi S >  Install >  Install on MicroSD

Community Contributions

• HANLLEL translated the Spanish page.
• Beachtier translated the Germany page.