Difference between revisions of "Helping With Documentation"
m (Text replacement - "<source" to "<syntaxhighlight") |
|||
| Line 32: | Line 32: | ||
======language related====== | ======language related====== | ||
| − | < | + | <syntaxhighlight lang="lua"> |
__TOC__ | __TOC__ | ||
__NOTOC__ | __NOTOC__ | ||
| Line 39: | Line 39: | ||
======file linking related====== | ======file linking related====== | ||
| − | < | + | <syntaxhighlight lang="lua"> |
<gallery widths=350px heights=250px perrow=1> | <gallery widths=350px heights=250px perrow=1> | ||
studio_1.png| | studio_1.png| | ||
| Line 47: | Line 47: | ||
</source> | </source> | ||
| − | '''<nowiki>< | + | '''<nowiki><syntaxhighlight>GiderosiPhonePlayer.xcodeproj</source></nowiki>''' = to open a linked document |
======text related====== | ======text related====== | ||
| − | < | + | <syntaxhighlight lang="lua"> |
* Bulleted list item | * Bulleted list item | ||
# Numbered list item | # Numbered list item | ||
| Line 60: | Line 60: | ||
======block related====== | ======block related====== | ||
| − | < | + | <syntaxhighlight lang="lua"> |
<div style="column-count:2;-moz-column-count:2;-webkit-column-count:2"> | <div style="column-count:2;-moz-column-count:2;-webkit-column-count:2"> | ||
*<translate><!--T:6--> Android and iOS platform support</translate> | *<translate><!--T:6--> Android and iOS platform support</translate> | ||
| Line 71: | Line 71: | ||
======gideros template related====== | ======gideros template related====== | ||
| − | < | + | <syntaxhighlight lang="lua"> |
{{GIDEROS IMPORTANT LINKS}} | {{GIDEROS IMPORTANT LINKS}} | ||
{{Gideros deco stars01}} | {{Gideros deco stars01}} | ||
| Line 89: | Line 89: | ||
Create a new category and add this code: | Create a new category and add this code: | ||
*LUA API MENU ('''example'''): | *LUA API MENU ('''example'''): | ||
| − | < | + | <syntaxhighlight lang="lua"> |
#REDIRECT [[Coroutine]] | #REDIRECT [[Coroutine]] | ||
[[Category:Lua API]] | [[Category:Lua API]] | ||
| Line 95: | Line 95: | ||
*MAIN API MENU ('''example'''): | *MAIN API MENU ('''example'''): | ||
| − | < | + | <syntaxhighlight lang="lua"> |
#REDIRECT [[Accelerometer]] | #REDIRECT [[Accelerometer]] | ||
[[Category:Main API]] | [[Category:Main API]] | ||
| Line 101: | Line 101: | ||
*PLUGINS MENU ('''example'''): | *PLUGINS MENU ('''example'''): | ||
| − | < | + | <syntaxhighlight lang="lua"> |
#REDIRECT [[Ads]] | #REDIRECT [[Ads]] | ||
[[Category:Plugins]] | [[Category:Plugins]] | ||
| Line 140: | Line 140: | ||
=== D- A TYPICAL GIDEROS TEMPLATE === | === D- A TYPICAL GIDEROS TEMPLATE === | ||
| − | < | + | <syntaxhighlight lang="lua"> |
---- | ---- | ||
| Line 163: | Line 163: | ||
====== SOME VARIATIONS OF A TYPICAL GIDEROS TEMPLATE ====== | ====== SOME VARIATIONS OF A TYPICAL GIDEROS TEMPLATE ====== | ||
| − | < | + | <syntaxhighlight lang="lua"> |
{{Gideros deco stars01}} | {{Gideros deco stars01}} | ||
********************************* | ********************************* | ||
| Line 178: | Line 178: | ||
We include a template in a page using: | We include a template in a page using: | ||
| − | < | + | <syntaxhighlight lang="lua"> |
{{templateName}} | {{templateName}} | ||
</source> | </source> | ||
Revision as of 14:28, 13 July 2023
To help with documentation please contact one of the following members of the Gideros Forum for access. You will need to give them a valid e-mail address and be a trusted member of the forum.
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).
You cannot save edits until you have proper access.
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:
https://www.mediawiki.org/wiki/Help:Formatting
In the markup language documentation it shows internal links with double square brackets:
[[link to other page]]
But because we have translation you have to do it a slightly different way:
[[Special:MyLanguage/link to other page|<translate>link to other page</translate>]]
This will pass along the language you see from one page to another and also mark the link text for translation. If you have links within a block that is marked with a translate 'tag' then there is no need to also put the translate tag in the actual link (it's not allowed).
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
<syntaxhighlight lang="lua">
</source>
<syntaxhighlight lang="lua">
</source>
<syntaxhighlight>GiderosiPhonePlayer.xcodeproj</source> = to open a linked document
<syntaxhighlight lang="lua">
* Bulleted list item # Numbered list item bold -- = TAB ----- = draw a line
= line break
</source>
<syntaxhighlight lang="lua">
*Android and iOS platform support
</source>
<syntaxhighlight lang="lua">
----
</source>
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:
[[Category:Reference Manual]]
Example:
https://wiki.giderosmobile.com/index.php?title=Category:Plugins
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
</source>
- MAIN API MENU (example):
<syntaxhighlight lang="lua">
- REDIRECT Accelerometer
</source>
- PLUGINS MENU (example):
<syntaxhighlight lang="lua">
- REDIRECT Ads
</source>
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: https://wiki.giderosmobile.com/index.php?title=Template:
+ the name of the class you want to create a template for.
For example: https://wiki.giderosmobile.com/index.php?title=Template:R3d.World
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: {{Special:PrefixIndex/...}}
This will list all the pages starting with a given name. For example:
{{Special:PrefixIndex/Bitmap}}
D- A TYPICAL GIDEROS TEMPLATE
<syntaxhighlight lang="lua">
</source>
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: ---- this add a nice formatted line
- 3rd line: {{Special:PrefixIndex/...}} this will create a list of all the pages starting with a class name, ex: {{Special:PrefixIndex/Bitmap}}
- 4th line: <br/> a line break
- 5th line: a return character (ENTER)
- 6th line: {{Gideros deco stars01}} this includes another template (gideros deco stars01). Its only purpose is to add some more deco. In this case another nicely formatted line (----) as seen above.
That's it!
SOME VARIATIONS OF A TYPICAL GIDEROS TEMPLATE
<syntaxhighlight lang="lua">
[[]]
- some text here
</source>
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"> Template:TemplateName </source>
For example, we need to add the {{Bitmap}} template at the bottom of every function pages of the Bitmap class.
That's it!
