Gideros 2018.9 - Studio addons

SinisterSoft · September 2018

The new docs are starting to shape up, if anyone wants to help with translation, etc then please contact myself or @hgy29 .

Here is the location of the new docs:

http://wiki.giderosmobile.com/index.php/Welcome!

Eventually the docs in the install download will be removed and it will link to that page instead.

oleg · September 2018

@SinisterSoft
there are many outdated things in the documentation

example:
"AdMob integration for Android"

they should be noted: -so as not to confuse newcomers
"AdMob integration for Android (outdated )"

keszegh · September 2018

@SinisterSoft , there was a discussion earlier about how the api docs should look like.
now i'm not sure that was taken in account when you started to make this new reference guide. while i agree that easy editability is a huge pro, the wiki page is much less convenient in some ways than the current reference guide.
some reasons:
-multiple column lists are harder to read
-going from one function to the other one has to go back to the root of the html tree first, so the number of clicks doubles

all in all i like the interactivity of the current one more than the static approach of a wiki page. i don't know if there is a chance to make the wiki behave a bit more like the current one.

overall i appreciate the lot of work that goes into making a unified docs gideros wiki.

SinisterSoft · September 2018

I'm sure given time we will be able to add things to the wiki for it to be more convenient.

It may be possible to embed some of the tables at the bottom or side of existing tables.

Apollo14 · September 2018

oleg said:
@SinisterSoft
there are many outdated things in the documentation

example:
"AdMob integration for Android"

they should be noted: -so as not to confuse newcomers
"AdMob integration for Android (outdated )"

Now we can update outdated stuff ourself, let's do it

oleg · September 2018

Apollo14 said:

Now we can update outdated stuff ourself, let's do it

old materials are also useful
I am against removing them

*I do not know how to write articles in English

I can not add articles in Ukrainian

I can only translate already written articles

SinisterSoft · September 2018

The first stage is to get all of the existing information into the new wiki as fast as possible, if anything is obviously wrong then it can be edited as it's copied.

Then open it up to a few people to correct. We could also put a note in how it used to be done if things have changed if people like.

English should be in initial language, then the translation system will work properly for other languages.

Normally with the wiki to add a new page just put the title of the page surrounded by 2 square brackets, eg: [[Something new]]
then save, if you click the 'something new' text then you will go to the new page that has the title 'something new'.

Things get a little complicated though because of translation.

Instead of [[Something new]] you have to write it like this:

[[Special:MyLanguage/Something new|Something new]]

That will say to the system, pass the language along to the link called Something new, translate the text 'Something new' to the users language.

If a link is in a paragraph of text then do something like this:

This is my text and in this text is a link to a [[Special:MyLanguage/Graphics Tutorial|graphics]] page

That would show:
This is my text and in this text is a link to a graphics page

And would link to the 'Graphics Tutorial' on the word 'graphics', it would also pass along the users language and also be translated if the text was available.

SinisterSoft · September 2018

The old stuff could possibly be left in place and a link given - so if you really needed the old docs then you could click a link to look at them.

oleg · September 2018

SinisterSoft said:
The old stuff could possibly be left in place and a link given - so if you really needed the old docs then you could click a link to look at them.

you misunderstood me
to links to wikipedia articles about obsolete features, add a note, for example ("old")

pie · September 2018

SinisterSoft said:
The first stage is to get all of the existing information into the new wiki as fast as possible, if anything is obviously wrong then it can be edited as it's copied.

Then open it up to a few people to correct. We could also put a note in how it used to be done if things have changed if people like.

English should be in initial language, then the translation system will work properly for other languages.

Normally with the wiki to add a new page just put the title of the page surrounded by 2 square brackets, eg: [[Something new]]
then save, if you click the 'something new' text then you will go to the new page that has the title 'something new'.

Things get a little complicated though because of translation.

Instead of [[Something new]] you have to write it like this:

[[Special:MyLanguage/Something new|Something new]]

That will say to the system, pass the language along to the link called Something new, translate the text 'Something new' to the users language.

If a link is in a paragraph of text then do something like this:

This is my text and in this text is a link to a [[Special:MyLanguage/Graphics Tutorial|graphics]] page

That would show:
This is my text and in this text is a link to a graphics page

And would link to the 'Graphics Tutorial' on the word 'graphics', it would also pass along the users language and also be translated if the text was available.

This could be one of the first entries: [[ how to add entries to this wiki]]

oleg · September 2018

@pie http://wiki.giderosmobile.com/index.php/Helping_With_Documentation

SinisterSoft · September 2018

@oleg Ahh - sorry - I know what you mean now. Good idea.

I added this to the end of those two links re Admob:

 <span style="color:red">(<translate>Outdated!</translate>)</span>

SinisterSoft · September 2018

Revised it so the articles are moved to the bottom - to an 'out of date' section:

http://wiki.giderosmobile.com/index.php/Article_Tutorials

keszegh · September 2018

guys, I checked the bottom of main gideros page. fb page banner looks baad. also fb and Twitter should be updated at least for new version announcements.

SinisterSoft · September 2018

I have no idea who is in charge of those. Anyone know?

SinisterSoft · September 2018

@keszegh A breadcrumbs system has been added by @hgy29 . It works really well.
See http://wiki.giderosmobile.com

keszegh · September 2018

@SinisterSoft , that's better indeed, although hard to notice.
optimal would be if hovering on an element in the breadcrumbs system would pop-up its children (and hovering on them its subchildren etc).

oleg · September 2018

@SinisterSoft you need to combine methods, events, and constants on one page, rather than splitting them apart

SinisterSoft · September 2018

@keszegh It's a plugin, I'm not too sure how it works. It's possible that it could be improved over time.

@oleg There is a template system that may be possible to do this. I'm not sure.

The system we are using is 'MediaWiki', if you see any plugins for this that will do what you want then let us know.

SinisterSoft · September 2018

The other thing is that for something like Sprite, keeping it all on one page would be a huge problem. Ideally people will add more and more examples for each method, so each method's page could also eventually have a lot of information.

Maybe for now the breadcrumb system is enough?

oleg · September 2018

SinisterSoft said:
The other thing is that for something like Sprite, keeping it all on one page would be a huge problem. Ideally people will add more and more examples for each method, so each method's page could also eventually have a lot of information.

Maybe for now the breadcrumb system is enough?

I'm talking only about APIs that are automatically added to the wiki

oleg · September 2018

SinisterSoft said:

@oleg There is a template system that may be possible to do this. I'm not sure.

The system we are using is 'MediaWiki', if you see any plugins for this that will do what you want then let us know.

https://www.mediawiki.org/wiki/Extension:Cite#cite_ref-multiple_4-0

SinisterSoft · September 2018

I've suggested it to @hgy29

SinisterSoft · September 2018

"I'm talking only about APIs that are automatically added to the wiki"

I'm not sure what you mean.

oleg · September 2018

SinisterSoft said:
"I'm talking only about APIs that are automatically added to the wiki"

I'm not sure what you mean.

------>

SinisterSoft said:
"Don't mess with any of the API pages and hgy29 has a script that is updating that from the current help."

SinisterSoft · September 2018

Ahh - Yes - but in the future they won't be automatic. That is just a script to move from the current system to the new system. The new system will then be the way to enter the documentation and enhance it - including the API.

oleg · September 2018

@SinisterSoft very long pages can be divided, but most api pages are short

example :

==Accelerometer==
Description
The Accelerometer class is used to access accelerometer data. 
Examples
Example
 
 ==Methods==
 
== <ref group="Accelerometer.isAvailable" == 
Example</ref>
== <ref group="Accelerometer.new"  ==
Example</ref>
== <ref group="Accelerometer:getAcceleration" ==
Example</ref>
==  <ref group="Accelerometer:start"  ==
Example</ref>
== <ref group="Accelerometer:stop" ==
Example</ref>
 
 
==References==
 <references  group="Accelerometer.isAvailable" />
 <references group="Accelerometer.new" />
 <references group="Accelerometer:getAcceleration"/>
 <references group="Accelerometer:start"  />
 <references  group="Accelerometer:stop" />

SinisterSoft · September 2018

Yes, it's possible we could edit them to single pages or something later. It depends on the examples and other stuff.

Currently the transfer is automatic because there are so many API commands, it would take far too long to do it manually.

SinisterSoft · September 2018

One of the problems may be though - if we edit them into single pages then one of the ideas @hgy29 had for being able to get help by clicking on an api command wouldn't work. The command would be quite easy to find with the way it is now because the page would exist that matches the api command exactly.

oleg · September 2018

SinisterSoft said:
One of the problems may be though - if we edit them into single pages then one of the ideas @hgy29 had for being able to get help by clicking on an api command wouldn't work. The command would be quite easy to find with the way it is now because the page would exist that matches the api command exactly.

the wiki has a redirect
https://www.mediawiki.org/wiki/Help:Redirects

example:
when moving to a page

<a href="http://wiki.giderosmobile.com/index.php/Accelerometer.isAvailable" rel="nofollow">http://wiki.giderosmobile.com/index.php/Accelerometer.isAvailable</a>

will open

<a href="http://wiki.giderosmobile.com/index.php/Accelerometer" rel="nofollow">http://wiki.giderosmobile.com/index.php/Accelerometer</a>

Howdy, Stranger!

Categories

In this Discussion

Top Posters

Gideros 2018.9 - Studio addons

Comments

Howdy, Stranger!

Quick Links

Categories

In this Discussion

Top Posters

Gideros 2018.9 - Studio addons

Comments