Fixing broken links in Wiki (Articles Tutorials)

MoKaLux · December 2019

that looks scary

I found this link https://mediawiki2latex.wmflabs.org/file/284.pdf
it can produce pdf but that doesn't work too well with gideros wiki!

hgy29 · December 2019

antix said:

After messing about for a few minutes I came up with this... https://wiki.giderosmobile.com/api.php?action=parse&page=Application&format=json

The output is basically the web content shoehorned into a JSON structure. Parsing it to enable it to be actually useful like having some semi-sane navigation functionality looks to be quite tricky.

Use the original wikitext instead of html, it should be easier to parse since to it retains tags:
https://wiki.giderosmobile.com/api.php?action=parse&page=Application&format=json&prop=wikitext|sections

MoKaLux · December 2019

antix said:
This is what I use because I hate the wiki and clicking my mouse a million times just to find some information (it was part of my own badly received attempt at revamping the Gideros website).

@antix do you like it better?
https://wiki.giderosmobile.com/index.php/Application:canOpenUrl

please say yes

SinisterSoft · December 2019

Looks great.

plicatibu · December 2019

@MoKaLux I liked it.

MoKaLux · December 2019

@plicatibu thank you

I am doing what I can to help make gideros user friendly

plicatibu · December 2019

Guys, I have almost everything ready to fix Complete Games -> Square Dodge.

My problem is that when I try to submit the zip file that contains the full project provided by the author, the following exception happens:

[acad2a9a56c8c576c2417e88] Exception caught: No specifications provided to ArchivedFile constructor.

Any idea how to solve this?

Regards.

plicatibu · December 2019

plicatibu said:
Guys, I have almost everything ready to fix Complete Games -> Square Dodge.

My problem is that when I try to submit the zip file that contains the full project provided by the author, the following exception happens:

[acad2a9a56c8c576c2417e88] Exception caught: No specifications provided to ArchivedFile constructor.

Any idea how to solve this?

Regards.

The same error is happening when I tried to upload the ZIP file for tutorial Sounds and Music -> Intro to sounds.

After solving these issues all 9 broken links in Article Tutorials will be solved.

rrraptor · December 2019

@plicatibu maybe it better to use github and post a link to repo?

plicatibu · December 2019

@rrraptor @hgy29 had enabled the upload of ZIP files to wiki and I uploaded some of them successfully.

I have no idea about what's going on now.

But I'm considering use github as you suggested.

Regards.

antix · December 2019

MoKaLux said:

antix said:
This is what I use because I hate the wiki and clicking my mouse a million times just to find some information (it was part of my own badly received attempt at revamping the Gideros website).
@antix do you like it better?
https://wiki.giderosmobile.com/index.php/Application:canOpenUrl

please say yes

@MoKaLux
Sorry man, for me personally its not usable... there are NO links to any other thing there (Bitmap, or TexturePack for example). I still don't get how nobody here seems to think that having an actual navigation bar is not a good idea.

@hgy29 on the surface that does look nicer. Whilst it is possible to parse these files it will be much more difficult to actually find the links to these pages. The actual files that need to be scraped are fragmented over two separate sections... "API Reference" and "Lua Reference". that would immediately need to change, but then there is always the issue if somebody edits the page and moves them about again.

I'll stop now because nobody seems to grasp how a real API Reference is actually implemented in the real world.

hgy29 · December 2019

Lots of ideas in this thread, it is great to see the community so active. I personnaly don't use the API ref too much, so I'll let you guys debate about it while I pull my hairs off trying to compile next Gideros release. So many things were broken by latest emscripten update that I regret I updated...

Don't hesitate to ping me if you need access to something.

talis · December 2019

MoKaLux said:

antix said:
This is what I use because I hate the wiki and clicking my mouse a million times just to find some information (it was part of my own badly received attempt at revamping the Gideros website).
@antix do you like it better?
https://wiki.giderosmobile.com/index.php/Application:canOpenUrl

please say yes

I also liked it, thanks for the effort.

antix · December 2019

@hgy29 one issues is that bad documentation (including poor accessibility via inferior navigation) is something that drives away NEW USERS, and Gideros wants many new users eh?

Gideros needs to present information that novice coders can easily access and use. When evaluating frameworks, IDEs, etc, if the documentation is lame... I don't bother.

Gideros has a stupidly fantastic forum with small but great community support but that alone can't make up for poor documentation.

The only way to be able to scrape the current documentation would be to have some page that had links to the documentation pages that would be locked, so not able to be edited by the general public. A scraper program really would need this "certain information available so it could reliably scrape documentation and reformat it.

Maybe it is possible for there to be an API Reference main page which only maintainers are able to modify? After-all the users can still modify the actual documentation.. just not the contents.

antix · December 2019

Could we also remove the giant "API Reference" bit from the front page too?

MoKaLux · December 2019

@antix I am testing things out! new layout, better navigation and stuff.
Imho main api should be directly visible and accessible on the front page until we have this damn sidebar menu working.

MoKaLux · December 2019

@antix do you find this xml export useful?

plicatibu · December 2019

Now both the eightеth and ninth broken links were fixed. They are:

Sounds and Music -> Intro to sounds

and

Complete Games -> Square Dodge

that in wiki page Articles Tutorial were pointing to

- Playing Music And Sound Effects (original URL: http://bluebilby.com/2013/04/18/gideros-mobile-tutorial-playing-music-and-sound-effects/)

and to

- Creating Your First Game (original URL: http://bluebilby.com/2013/05/08/gideros-mobile-tutorial-creating-your-first-game/)

respectively. Both of them were created by Jason Oakley.

So there is no more broken links in Articles Tutorial.

Regards.

antix · December 2019

@MoKaLux Nah, not really. I can download the pages and parse the JSON but now I find that some pages have corner cases where they have extraneous characters that break my filtering. It's a total shambles LOL

oleg · December 2019

plicatibu said:
Now both the eightеth and ninth broken links were fixed. They are:

Sounds and Music -> Intro to sounds
.

It's outdated information
In Gideros there is such an addon^

plicatibu · December 2019

@oleg I see.. but the initial purposr was to make all old tutorials be available.

A new tutorial must be done eventually and a note in the old one be added to it pointing to new infomation.

Probably when I learn more about Gideros I'll do it.

Regards.

oleg · December 2019

plicatibu said:
@oleg I see.. but the initial purposr was to make all old tutorials be available.

A new tutorial must be done eventually and a note in the old one be added to it pointing to new infomation.

Probably when I learn more about Gideros I'll do it.

Regards.

Also this command is outdated and will not work:

gametune:play(100,5)

plicatibu · December 2019

@oleg Before publishing the old tutorials I made the projects and tested each one of them. And I got very impressed by seen such old codes still working.

But as you're saying the code doesn't work I will recheck them. Maybe I forgot to type this line.

Thanks for the heads up.

Apollo14 · December 2019

plicatibu said:
@oleg Before publishing the old tutorials I made the projects and tested each one of them. And I got very impressed by seen such old codes still working.

Gideros is reliable like AK-47

oleg · December 2019

Apollo14 said:

plicatibu said:
@oleg Before publishing the old tutorials I made the projects and tested each one of them. And I got very impressed by seen such old codes still working.
Gideros is reliable like AK-47

Bad comparison

hgy29 · December 2019

antix said:

The only way to be able to scrape the current documentation would be to have some page that had links to the documentation pages that would be locked, so not able to be edited by the general public. A scraper program really would need this "certain information available so it could reliably scrape documentation and reformat it.

@antix, I 100% agree with you, but please don’t ask me to solve every issue in gideros. I am more involved than most people here, and I pay the hosting bills, but I am not responsible for it, we are all.

Beside this, you may not be aware of it but such a scraper tool already exists, for the sole purpose of building the auto completion list in gideros studio. It just queries the entire wiki database and search for specific tags in the pages to collect methods/objects/events. I can easily make another version of this tool that would report all object pages.

SinisterSoft · December 2019

@antix The wiki isn't open for anyone to edit. Only people we allow to edit can do so, the Wiki system also tracks their edits and they can be reversed, etc...

Without having more people adding API examples, general docs, bad link fixes, etc it would never get done. @hgy29 is doing far more than his fair share, I help out as much as I can, but we really do need the help of as many of you as possible to get the docs to the same quality as Gideros itself.

antix · December 2019

@hgy29 I'm not personally asking you to solve anything. I've joined the conversation and asked the community if they think the current API Reference is "fit for purpose" and asking what might be some possible solutions. I totally don't think it's up to you to solve every issue

I had no idea a tool such as that existed

@SinisterSoft I understand what you are saying, but if the API Reference is rather "useless" for new users and turns them away from Gideros... how is that good?

I've suggested what I think is the best way to present the API Reference, and whether that method is adapted really isn't up to me because I have no control over what happens with Gideros.

So just to be crystal clear.. I feel that the API Reference should be stored in some generic format (JSON or XML) that can be scraped and used as required (for reformatting or printing or whatever). I also feel strongly that the API Reference should be presented with a navigation bar on the left side of the screen for... ease of use.

SinisterSoft · December 2019

I think that if the API docs were in the source, so they could be scrapped then that would be good - but it will be a lot of work to do this (I think). Unless it could be done via a script initially (from what we have now).

Then as things get added actual api docs can be added there and then more easily, it would also help document the source code.

After that they could be scrapped from the source to some standard system or into a database that a php file could be made to cross-reference.

antix · December 2019

@SinisterSoft that sounds good but somebody has to take the existing documentation and mash it into the source code. To me, this makes that solution not viable, even though it's a good one because I don't think there is anyone besides the overworked @hfgy29 that is qualified to do it $:\$

One other aspect of that system would be that whomever wanted to add or edit documentation would have to trawl through the source code and I guess that would be @hgy29 again hehehe.

I'd like to know more about the tool @hgy29 mentioned and how it might be used to get the documentation into some usable format.

Howdy, Stranger!

Categories

In this Discussion

Top Posters

Fixing broken links in Wiki (Articles Tutorials)

Comments

Howdy, Stranger!

Quick Links

Categories

In this Discussion

Top Posters

Fixing broken links in Wiki (Articles Tutorials)

Comments