|
|
| Line 1: |
Line 1: |
| − | __NOTOC__
| + | To help with documentation please contact one of the following members of the [http://giderosmobile.com/forum/ Gideros Forum] for access. You will need to give them a valid e-mail address and be a trusted member of the forum. |
| | | | |
| − | To help with documentation please contact one of the following members of the [http://giderosmobile.com/forum/ Gideros Forum] for access. You will need to give them a valid e-mail address and be a trusted member of the forum.
| + | For consistency all documentation should be in English, translations can then be made to other languages. |
| | + | |
| | + | You cannot save edits or add translations until you have proper access. |
| | | | |
| | === Forum members who can give you create/edit access to the documentation: === | | === Forum members who can give you create/edit access to the documentation: === |
| − | * @'''SinisterSoft'''
| |
| − | * @'''hgy29'''
| |
| − |
| |
| | | | |
| − | For consistency all documentation should be in English ('''translations are not recommended because they are often started but never completed''').
| + | * @SinisterSoft |
| | + | * @Hgy29 |
| | | | |
| − | You cannot save edits until you have proper access.
| + | === Editing a page and dealing with the translation system: === |
| | | | |
| − | == Editing a page and dealing with the translation system: ==
| |
| | The system uses a markup system language to show things like headers, lists, etc. Here is some help with how to use the markup language: | | The system uses a markup system language to show things like headers, lists, etc. Here is some help with how to use the markup language: |
| | | | |
| Line 28: |
Line 27: |
| | | | |
| | Once a page has been made and it has the translate tags on it then you will see a 'mark for translation' link. | | Once a page has been made and it has the translate tags on it then you will see a 'mark for translation' link. |
| − |
| |
| − | == SOME WIKI TAGS ==
| |
| − |
| |
| − | ======language related======
| |
| − | <syntaxhighlight lang="lua">
| |
| − | __TOC__
| |
| − | __NOTOC__
| |
| − | <languages/>
| |
| − | </syntaxhighlight>
| |
| − |
| |
| − | ======file linking related======
| |
| − | <syntaxhighlight lang="lua">
| |
| − | <gallery widths=350px heights=250px perrow=1>
| |
| − | studio_1.png|
| |
| − | </gallery>
| |
| − |
| |
| − | [[File:Iphoneplayer.png]]
| |
| − | </syntaxhighlight>
| |
| − |
| |
| − | '''<nowiki><syntaxhighlight>GiderosiPhonePlayer.xcodeproj</syntaxhighlight></nowiki>''' = to open a linked document
| |
| − |
| |
| − | ======text related======
| |
| − | <syntaxhighlight lang="lua">
| |
| − | * Bulleted list item
| |
| − | # Numbered list item
| |
| − | '''bold'''
| |
| − |   -- = TAB
| |
| − | ----- = draw a line
| |
| − | <br/> = line break
| |
| − | </syntaxhighlight>
| |
| − |
| |
| − | ======block related======
| |
| − | <syntaxhighlight lang="lua">
| |
| − | <div style="column-count:2;-moz-column-count:2;-webkit-column-count:2">
| |
| − | *<translate><!--T:6--> Android and iOS platform support</translate>
| |
| − | </div>
| |
| − |
| |
| − | <span line-height: 1.3em;">
| |
| − | {{Special:PrefixIndex/TextureBase.}}
| |
| − | </span>
| |
| − | </syntaxhighlight>
| |
| − |
| |
| − | ======gideros template related======
| |
| − | <syntaxhighlight lang="lua">
| |
| − | {{GIDEROS IMPORTANT LINKS}}
| |
| − | {{Gideros deco stars01}}
| |
| − | </syntaxhighlight>
| |
| − |
| |
| − |
| |
| − | == TO ADD A CATEGORY TO THE LEFT MENU (ADVANCED/AUTHORIZED USERS ONLY) ==
| |
| − | Create a category (for example: Plugins) then add this code to the new category:
| |
| − |
| |
| − | <nowiki>[[Category:Reference Manual]]</nowiki>
| |
| − |
| |
| − | Example:
| |
| − |
| |
| − | <nowiki>https://wiki.giderosmobile.com/index.php?title=Category:Plugins</nowiki>
| |
| − |
| |
| − | === TO ADD LINKS TO A CATEGORY IN THE LEFT MENU ===
| |
| − | Create a new category and add this code:
| |
| − | *LUA API MENU ('''example'''):
| |
| − | <syntaxhighlight lang="lua">
| |
| − | #REDIRECT [[Coroutine]]
| |
| − | [[Category:Lua API]]
| |
| − | </syntaxhighlight>
| |
| − |
| |
| − | *MAIN API MENU ('''example'''):
| |
| − | <syntaxhighlight lang="lua">
| |
| − | #REDIRECT [[Accelerometer]]
| |
| − | [[Category:Main API]]
| |
| − | </syntaxhighlight>
| |
| − |
| |
| − | *PLUGINS MENU ('''example'''):
| |
| − | <syntaxhighlight lang="lua">
| |
| − | #REDIRECT [[Ads]]
| |
| − | [[Category:Plugins]]
| |
| − | </syntaxhighlight>
| |
| − |
| |
| − | == TEMPLATES ==
| |
| − | === A - WHAT IS A TEMPLATE ===
| |
| − | Templates can save duplicating work already done.
| |
| − |
| |
| − | In our case, a template retrieves all the pages which start with a class name (for example all the pages which start with Bitmap).
| |
| − |
| |
| − | This will be our navigation helper for when we navigate the wiki classes.
| |
| − |
| |
| − | This will go at the bottom of every pages except the main class page which already contains all the methods (otherwise that will create duplicates).
| |
| − |
| |
| − | === B- TEMPLATE CREATION ===
| |
| − | How do we create a template?
| |
| − |
| |
| − | In the address bar type:
| |
| − | <nowiki>https://wiki.giderosmobile.com/index.php?title=Template:</nowiki>
| |
| − |
| |
| − | + the name of the class you want to create a template for.
| |
| − |
| |
| − | For example: <nowiki>https://wiki.giderosmobile.com/index.php?title=Template:R3d.World</nowiki>
| |
| − |
| |
| − | '''That's it!'''
| |
| − |
| |
| − | === C- WHAT DOES A TEMPLATE PAGE CONTAIN? ===
| |
| − | The template page can contain anything really.
| |
| − |
| |
| − | In gideros we use it for easy navigation so we add links to other functions of the same class.
| |
| − |
| |
| − | To do this we use the wikimedia function: '''<nowiki>{{Special:PrefixIndex/...}}</nowiki>'''
| |
| − |
| |
| − | This will list all the pages starting with a given name. For example:
| |
| − |
| |
| − | <nowiki>{{Special:PrefixIndex/Bitmap}}</nowiki>
| |
| − |
| |
| − | === D- A TYPICAL GIDEROS TEMPLATE ===
| |
| − | <syntaxhighlight lang="lua">
| |
| − |
| |
| − | ----
| |
| − | {{Special:PrefixIndex/Bitmap}}
| |
| − |
| |
| − | {{Gideros deco stars01}}
| |
| − |
| |
| − | {{GIDEROS IMPORTANT LINKS}}
| |
| − |
| |
| − | [[Category:Bitmap]]
| |
| − | </syntaxhighlight>
| |
| − |
| |
| − | ==== Let's describe an original gideros template ====
| |
| − | *'''1st line''': a return character (ENTER) to add more room between the end of the function page and the navigation list of all related functions
| |
| − | *'''2nd line''': <nowiki>----</nowiki> this add a nice formatted line
| |
| − | *'''3rd line''': <nowiki>{{Special:PrefixIndex/...}}</nowiki> this will create a list of all the pages starting with a class name, ex: <nowiki>{{Special:PrefixIndex/Bitmap}}</nowiki>
| |
| − | *'''4th line''': <nowiki><br/></nowiki> a line break
| |
| − | *'''5th line''': a return character (ENTER)
| |
| − | *'''6th line''': <nowiki>{{Gideros deco stars01}}</nowiki> this includes another template (gideros deco stars01). Its only purpose is to add some more deco. In this case another nicely formatted line <nowiki>(----)</nowiki> as seen above.
| |
| − |
| |
| − | '''That's it!'''
| |
| − |
| |
| − | ====== SOME VARIATIONS OF A TYPICAL GIDEROS TEMPLATE ======
| |
| − | <syntaxhighlight lang="lua">
| |
| − | {{Gideros deco stars01}}
| |
| − | *********************************
| |
| − | [[]]
| |
| − |
| |
| − | <div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
| |
| − | *some text here
| |
| − | </div>
| |
| − | <br/>
| |
| − | </syntaxhighlight>
| |
| − |
| |
| − | === E- TEMPLATE INTEGRATION ===
| |
| − | Ok, we have created our template now we need to put it in every function pages of a particular class, at the very bottom of the page.
| |
| − |
| |
| − | We include a template in a page using:
| |
| − | <syntaxhighlight lang="lua">
| |
| − | {{templateName}}
| |
| − | </syntaxhighlight>
| |
| − |
| |
| − | For example, we need to add the <nowiki>{{Bitmap}}</nowiki> template at the bottom of every function pages of the Bitmap class.
| |
| − |
| |
| − | '''That's it!'''
| |
| − |
| |
| − | {{GIDEROS IMPORTANT LINKS}}
| |
