Quick Links: Download Gideros Studio | Gideros Documentation | Gideros Development Center | Gideros community chat
Fixing broken links in Wiki (Articles Tutorials) - Page 6 - Gideros Forum

Fixing broken links in Wiki (Articles Tutorials)

12346

Comments

  • @MoKaLux said he had made a page called FBInstant and he has... but that page is still just a link inside the originally reported broken page (Facebook_Instant_Games). It's all rather messy. The content of the new FBInstant page should actually be on the Facebook_Instant_Games page because that is where it belongs... to comform to the structure of all of the other pages.

    Really, I'm over the "do it yourself" mentality around here. If you created it.. take ownership I say :D
  • Not DIY, more like everyone try muck in to get the job done. ;)

    Likes: MoKaLux

    +1 -1 (+1 / -0 ) Share on Facebook
  • MoKaLuxMoKaLux Member
    edited December 2019
    antix said:

    @MoKaLux said he had made a page called FBInstant and he has... but that page is still just a link inside the originally reported broken page (Facebook_Instant_Games). It's all rather messy. The content of the new FBInstant page should actually be on the Facebook_Instant_Games page because that is where it belongs... to comform to the structure of all of the other pages.

    @antix I can make the facebook instant games looks like the liquidfun page or the react3dphysics page. What do you think?

    edit: ok I did it https://wiki.giderosmobile.com/index.php/Facebook_Instant_Games
    @antix Is this what you expected? :/

    Likes: SinisterSoft

    +1 -1 (+1 / -0 ) Share on Facebook
  • The description initialisation and core should be in the main Facebook Instants Games page instead I think, it lets you know a bit about it and also has the methods.
  • The description initialisation and core should be in the main Facebook Instants Games page instead I think, it lets you know a bit about it and also has the methods.

    I would have liked to do it this way but FBInstant has too many functions and the FBInstant.context FBInstant.payments FBInstant.player would be lost inside it imho.

    I just leave it this way for now. At least it is more consistent with the other pages (cf: liquidfun, reactphysics3D).

    Likes: SinisterSoft

    +1 -1 (+1 / -0 ) Share on Facebook
  • @MoKaLux no. The content on this page (https://wiki.giderosmobile.com/index.php/FBInstant) should be mashed into this page (https://wiki.giderosmobile.com/index.php/Facebook_Instant_Games).

    This would make the pages behavior consistent over the other API Reference documents :)
  • MoKaLux said:

    I would have liked to do it this way but FBInstant has too many functions and the FBInstant.context FBInstant.payments FBInstant.player would be lost inside it imho.

    I just leave it this way for now. At least it is more consistent with the other pages (cf: liquidfun, reactphysics3D).

    @antix it is not ordinary, it is like liquidfun, reactphysics3D pages :/
  • @MoKaLux you are right, kind of :)

    The "Facebook_Instant_Games" page has a bunch of methods listed but those don;t seem to be methods, they seem to be namespaces of their own.

    Its confusing to me and I'm just going to ignore it :D
  • hgy29 said:

    It is far much easier to write the docs along the code than to switch to another tool to insert the doc. On the wiki, you have to create a page per function, which is tedious.

    I've been thinking about this and maybe it would be better to have each class have its own separate page which contained ALL methods, events, and constants that are related to that class.

    Adding new stuff to a class would be as easy as adding a new DIV in the HTML code.

    When the user clicks on a method in the navigation bar all you need to do it hide every DIV on the page, except the one that the user wants to see.

    Does that sound feasible?
  • MoKaLuxMoKaLux Member
    edited December 2019
    antix said:

    The "Facebook_Instant_Games" page has a bunch of methods listed but those don;t seem to be methods, they seem to be namespaces of their own.

    You are right. In ReactPhysics3D page it is not written Methods but Classes :) I am going to change this for Facebook Instant Games and Liquidfun DONE.
  • MoKaLuxMoKaLux Member
    edited December 2019
    antix said:

    hgy29 said:

    It is far much easier to write the docs along the code than to switch to another tool to insert the doc. On the wiki, you have to create a page per function, which is tedious.

    I've been thinking about this and maybe it would be better to have each class have its own separate page which contained ALL methods, events, and constants that are related to that class.

    Adding new stuff to a class would be as easy as adding a new DIV in the HTML code.

    When the user clicks on a method in the navigation bar all you need to do it hide every DIV on the page, except the one that the user wants to see.

    Does that sound feasible?
    PROS:
    -That would be very nice for hgy29 so he doesn't have to create a page for each method.
    CONS:
    -Some pages would be very very long, others very short.
    -navigating the methods would be hard too

    Likes: SinisterSoft

    +1 -1 (+1 / -0 ) Share on Facebook
  • @MoKaLux Great work so far, but maybe this text should be moved to the initial facebook instants page - so as to explain what it is and how to use it:

    "
    You need to do two things to target Facebook Instant Games:

    Tick the Facebook Instant Game tickbox when exporting to HTML5, you can also specify the percentage indicator that the game will show it has loaded before you take control.
    Require the FBInstant library code, see the example below.

    You can upload, debug and test your game by creating a player and uploading to Facebook servers as a game. The player will interact with the Gideros Studio similar to any other player.


    The only restriction with the player is that it only works on the computer viewing the html5 game (localhost) - this would normally rule out actual phones but there is a workaround for Android:

    Connect your Android phone to your computer using ADB.
    Type in this command in a command console shell (Windows) or terminal (Mac): adb reverse tcp:15001 tcp:15001
    The Android device now will see the Gideros Studio when testing the game when a player is launched from within Facebook Messenger.

    Please refer to the https://developers.facebook.com/docs/games/instant-games/getting-started/quickstart original Facebook documentation for more information about testing and uploading.


    Please note that the official Facebook documentation mentions having to wait for initializeAsync, with Gideros this has already been done for you before your game starts.

    "

    Likes: MoKaLux

    +1 -1 (+1 / -0 ) Share on Facebook
  • @MoKaLux In my opinion navigation is very easy when you have everything on one page.

    If you look at any of the Gideros classes... there's really nothing that is overly large.

    A decent editing system (which I can create) would make it very easy to edit pages.. unlike the current wiki thing which I find terribly cumbersome and inefficient.
  • MoKaLuxMoKaLux Member
    edited December 2019
    @SinisterSoft thank you ;) + I'll do the changes ASAP DONE.
    @antix : https://wiki.giderosmobile.com/index.php/Application or https://wiki.giderosmobile.com/index.php/Matrix or https://wiki.giderosmobile.com/index.php/B2.Body ...

    We don't know how to efficiently use mediawiki!
    I discovered how to work with templates and it is quite amazing.

    And I like the new way of navigating, I think it is quite efficient!?

    Viva gideros! Viva mediawiki!

    PS: the emoji heart symbol doesn't work anymore :*

    Likes: SinisterSoft

    +1 -1 (+1 / -0 ) Share on Facebook
  • antixantix Member
    edited December 2019
    @MoKaLux By "new navigation system" do you mean including links to all other pages at the bottom of every page? that's really sub optima and basically pretty dumb. sorry if I offend and I don't mean to. That just adds to page size and you still have to scroll down to the bottom of a page to click to other places.

    Viva Gideros! Death to MediaWiki :D

    I just cannot see how nobody in this community besides myself would like a navigation bar on the left hand side to make navigating the API reference easier.

    @hgy29, could you fix your script or could you give me some access so I can do it myself?
  • MoKaLuxMoKaLux Member
    edited December 2019
    antix said:

    @MoKaLux By "new navigation system" do you mean including links to all other pages at the bottom of every page? that's really sub optima and basically pretty dumb. sorry if I offend and I don't mean to. That just adds to page size and you still have to scroll down to the bottom of a page to click to other places.

    no @antix I'm not offended at all, I am only trying to help here :)

    For the navigation I find it easier than before (ex: https://wiki.giderosmobile.com/index.php/EventDispatcher:dispatchEvent) and I am not alone :) I have to admit that it should not be on the main class. I wanted to remove it but feeling lazy right now :/ I have started deleting the links at the bottom on the main classes. DONE
    antix said:

    I just cannot see how nobody in this community besides myself would like a navigation bar on the left hand side to make navigating the API reference easier.

    don't you have a navigation on the left hand side? It is not optimal yet but it is there.
    +1 -1 (+2 / -0 ) Share on Facebook
  • @MoKaLux I see them down the left-hand side, they can be clicked on to extend like a tree. It all seems to work well to me.

    Likes: MoKaLux

    +1 -1 (+1 / -0 ) Share on Facebook
  • @MoKaLux I have discovered the left side bar. Unfortunately this is only visible when the browser window is at least a certain width. Below that width wikimedia stupidly collapses the bar into a menu that then appears horizontally along the top of the page. Really it's pretty lame, and a very good example why the "mobile first" mentality that pervades the web design world is not such a great thing in some cases.

    When I view the nav bar it does seem to kind of work but when you actually get to a page it collapses down to nothing and you have to re expand everything to find where you were. This makes even more unsuitable than the current hyperlink jumble.

    Maybe you can improve it over time but really, since it only works when the browser window is very large, it's useless... for me anyways LOL

    I understand you are trying to help and you are doing a great job... I feel however wikimedia is NOT the right tool to use for documenting an API.

    I've now got my web app scraping the different pages on the wiki and extracting all of the information required to create a navigation tree. Unfortunately it is very slow because it has to use XMLHttpRequests to download each page (to create the tree) and it needs to download a total of 41 pages to get the information required.

    The script that @hgy29 created is very fast but also very broken. If he would fix it or if I was able to fix it myself that would solve this issue.

    After the navigation tree has been created my app can download any page and reformat it to look how I like...


    Personally that actually looks like a functional API Reference, with pretty everything you need to see in view, and easy to operate.
    image.png
    842 x 823 - 57K
  • MoKaLuxMoKaLux Member
    edited December 2019
    @antix that is beyond my permissions I am afraid. Let's see what other people say.
    Your project looks great, I love it. When it's live people can choose between the wiki and your site, that's very good for gideros :)
    PS: I tried shrinking the page and indeed the menu appears at the top but that doesn't break the navigation.
  • @MoKaLux Whilst the navigation might not be technically "broken" it becomes stupid to use. Suddenly a left side navigation pane has become a dropdown menu.... what the???

    Please have a wee look at the following web page...
    https://en.wikipedia.org/wiki/User_experience_design

    It doesn't take a rocket scientist to realize that the Gideros API Reference is a VERY BAD example of UX.

    This kind of system (the wiki) is what drives away new users who are expecting usable friendly interfaces that have been well thought out and designed to be nice to use.
  • MoKaLuxMoKaLux Member
    edited December 2019
    @antix I hope the wiki is more user-friendly than it was before!? As far as I understand people seem to like it better. We are trying to make it as cool as possible and there is a lot to do :s .
    Let's vote:
    +1 this post if you like the new wiki
    -1 this post if you don't like the new wiki

    Likes: talis, SinisterSoft

    Dislikes: antix

    +1 -1 (+2 / -1 ) Share on Facebook
  • @MoKaLux I'm not trying to be mean and I do appreciate your hard efforts but the wikimedia API Reference is "not fit for purpose".

    Of course that's just my opinion and others may somehow find it very user friendly.
  • hgy29hgy29 Maintainer
    antix said:


    @hgy29, could you fix your script or could you give me some access so I can do it myself?

    What is broken again in the script ? From what you said earlier it seemed more like the wiki content was broken (missing api tags or badly formed ones)
  • @hgy29 oh, I thought the script was broken. I have no idea. I give up!
  • @MoKaLux thanks for the effort, in my opinion wiki seems really good now. Thanks again for the hard-work. As far as the wiki content is correct hgy29's script will also work correctly.
    So in any case first step is to correct wiki. In addition for the new comers, wiki seems more interesting rather than the script. Maybe for the advance users or coders of course other methods can be used.
    +1 -1 (+2 / -0 ) Share on Facebook
  • I think the wiki is now way better than it used to be. I have to thank @MoKaLux for his hard work. It looks amazing now.

    The sidebar disappearing maybe a little early is most likely a CSS issue and could (most likely) be fixed by altering a width set in the style sheet. (@antix - what screen size are you viewing the wiki on? So we know what the minimum should be before the stylesheet forces the change).

    I'm sure if the wiki pages that are broken (there are hidden tags that say what specific pieces of text are) then the scripts to fill in the guide made by @antix will work too.

    Likes: MoKaLux

    +1 -1 (+1 / -0 ) Share on Facebook
  • @SinisterSoft I agree, now the wiki has become sexual <3 @MoKaLux -deserved the honorary title of archivist :|
    my games:
    https://play.google.com/store/apps/developer?id=razorback456
    мій блог по гідерос https://simartinfo.blogspot.com
    Слава Україні!
    +1 -1 (+3 / -0 ) Share on Facebook
  • MoKaLuxMoKaLux Member
    edited December 2019
    @all thank you.
    antix said:

    @hgy29 oh, I thought the script was broken.

    @antix I have added GIDEROSOBJ:UrlLoader to the urlloader page, as it seemed to be missing. Now you should be able to scrape the UrlLoader methods ;) .

    Let me know if you have other thing missing, I'll try to add them.

    Plus I have added this page: don't know if it is useful https://wiki.giderosmobile.com/index.php/All_Classes_and_more
    +1 -1 (+2 / -0 ) Share on Facebook
Sign In or Register to comment.