Author Topic: Wiki manual pages out of date  (Read 1370 times)

Crimson Wizard

  • AGS Project Tracker Admins
    • Best Innovation Award Winner 2013, for spearheading the AGS 3.3.0 project
    •  
    • Lifetime Achievement Award Winner
    •  
    • Crimson Wizard worked on a game that was nominated for an AGS Award!
      Crimson Wizard worked on a game that won an AGS Award!
Re: Wiki manual pages out of date
« Reply #20 on: 18 Mar 2018, 04:06 »
I pmed this to AGA, but will duplicate it here too.

So, today I tried to upload new manual content to the website, but some issues were found, so had to revert.

1. Pages on website use styles from external css file. While pages generated in repository have embedded css, and they are different (background, font, etc).
2. Pages on website have some additional script for toolbar display.
3. Website manual has additional html pages for contents, index etc. Manual in repository does not generate html pages for these. This means that even if I upload new topic pages, the contents tree will remain 3.2.1, and links won't match.

Would it be possible to find out who have created this online manual, and how?
« Last Edit: 20 Mar 2018, 16:00 by Crimson Wizard »

selmiak

  • ǝsıɔɹǝxǝ ʞɔǝu puɐ uıɐɹq
    • I can help with play testing
    •  
    • I can help with proof reading
    •  
    • I can help with translating
    •  
    • I can help with web design
    •  
    • selmiak worked on a game that was nominated for an AGS Award!
Re: Wiki manual pages out of date
« Reply #21 on: 18 Mar 2018, 08:06 »
a link would be helpful?
to all pages, the old page on ags, the new page on ags, the new page on git please.

Crimson Wizard

  • AGS Project Tracker Admins
    • Best Innovation Award Winner 2013, for spearheading the AGS 3.3.0 project
    •  
    • Lifetime Achievement Award Winner
    •  
    • Crimson Wizard worked on a game that was nominated for an AGS Award!
      Crimson Wizard worked on a game that won an AGS Award!
Re: Wiki manual pages out of date
« Reply #22 on: 18 Mar 2018, 08:12 »
to all pages, the old page on ags, the new page on ags, the new page on git please.

Existing manual: http://www.adventuregamestudio.co.uk/manual/
Random page on existing manual: http://www.adventuregamestudio.co.uk/manual/ags1.htm

Current manual source on git: https://github.com/adventuregamestudio/ags/tree/master/Manual
To build html pages: run run.cmd (may have to install Python 2.7).

Archive containing both versions for comparison: https://www.dropbox.com/s/v958t0938w76cyk/AGS--manualpages.zip?dl=0
« Last Edit: 18 Mar 2018, 08:44 by Crimson Wizard »

selmiak

  • ǝsıɔɹǝxǝ ʞɔǝu puɐ uıɐɹq
    • I can help with play testing
    •  
    • I can help with proof reading
    •  
    • I can help with translating
    •  
    • I can help with web design
    •  
    • selmiak worked on a game that was nominated for an AGS Award!
Re: Wiki manual pages out of date
« Reply #23 on: 18 Mar 2018, 09:22 »
wohah, there is also an outdated manual on the ags server... all the time I was thinking you were talking about this manual-wiki: http://www.adventuregamestudio.co.uk/wiki/Contents_(manual)
which is hosted on the same domain but even more outdated! This is a mess, time for some spring clean up :D

So my opinion on this is, one of the 2 manuals  on adventuregamesudio.co.uk has to go. Whichever one is easier to update from one source should stay, so probably the static manual you just linked to should stay, if at all. we need _one definite source_ for the manual. There the wiki I just linked would be great as everyone can edit and update with a forum account. But then all the changes would have to be transfered to git again. So my conclusion is, the definite source for the manual should be on github, where it is already and where the binaries of the engine are too. This also means, all these wikipages in the http://www.adventuregamestudio.co.uk/wiki/ domainrange either just disappear or redirect to... either the manual on http://www.adventuregamestudio.co.uk/manual/ or to the manual on github. oh the messy confusion... :-D
It is kind of bitter and if some interested person wants to write some good changes to the manual, this person first needs to make a github account. This could be a barrier for some, but if you really want to help make the AGS manual better this should not stop you. my opinion, not a fact. it sure is convenient to have the option to write changes to the wiki with a forum account, but who does that anyways, so imho github is the main source...


just out of curiosity, how would you change stuff in the manual on git? How do you edit this:
https://github.com/adventuregamestudio/ags/blob/master/Manual/htmlfiles/acintro.htm
and is there a way to display the html on github as it would show in the browser or within the AGS helpwindow?

Crimson Wizard

  • AGS Project Tracker Admins
    • Best Innovation Award Winner 2013, for spearheading the AGS 3.3.0 project
    •  
    • Lifetime Achievement Award Winner
    •  
    • Crimson Wizard worked on a game that was nominated for an AGS Award!
      Crimson Wizard worked on a game that won an AGS Award!
Re: Wiki manual pages out of date
« Reply #24 on: 18 Mar 2018, 09:35 »
wohah, there is also an outdated manual on the ags server... all the time I was thinking you were talking about this manual-wiki:

I clearly stated what I was talking about, posting the link several times, starting since very first posts in this thread.


just out of curiosity, how would you change stuff in the manual on git?

By learning how to use github and text editor.


https://github.com/adventuregamestudio/ags/blob/master/Manual/htmlfiles/acintro.htm

These are some unused files that should have been deleted. The actual manual source is in file called "ags.tex" which is a LaTeX document.

selmiak

  • ǝsıɔɹǝxǝ ʞɔǝu puɐ uıɐɹq
    • I can help with play testing
    •  
    • I can help with proof reading
    •  
    • I can help with translating
    •  
    • I can help with web design
    •  
    • selmiak worked on a game that was nominated for an AGS Award!
Re: Wiki manual pages out of date
« Reply #25 on: 18 Mar 2018, 10:44 »
sorry, my fault, I just assumed you were talking about this /wiki manual and didn't know that /manual was something different but somehow the same and just didn't click the link. sorry for wasting your time and making you post the links once more.


The ags.tex has (WARNING) very long loading times.
Is this the WHOLE MANUAL delivered with the AGS editor in ONE FILE??? That is nice and a great source. But then you'd have to know or learn LaTeX to edit the manual, which is another barrier, but it's like that it seems.

selmiak

  • ǝsıɔɹǝxǝ ʞɔǝu puɐ uıɐɹq
    • I can help with play testing
    •  
    • I can help with proof reading
    •  
    • I can help with translating
    •  
    • I can help with web design
    •  
    • selmiak worked on a game that was nominated for an AGS Award!
Re: Wiki manual pages out of date
« Reply #26 on: 18 Mar 2018, 10:55 »
« Last Edit: 18 Mar 2018, 10:59 by selmiak »

Crimson Wizard

  • AGS Project Tracker Admins
    • Best Innovation Award Winner 2013, for spearheading the AGS 3.3.0 project
    •  
    • Lifetime Achievement Award Winner
    •  
    • Crimson Wizard worked on a game that was nominated for an AGS Award!
      Crimson Wizard worked on a game that won an AGS Award!
Re: Wiki manual pages out of date
« Reply #27 on: 18 Mar 2018, 10:57 »
Is this the WHOLE MANUAL delivered with the AGS editor in ONE FILE??? That is nice and a great source. But then you'd have to know or learn LaTeX to edit the manual, which is another barrier, but it's like that it seems.

I do not know if this was sarcasm, but having it in one file does not really make it a great source, because it makes it difficult to search and edit.
For that reason the solution that was proposed and discussed long time ago was to change format to something else, even if plain html.
Here is a link to related discussion: http://www.adventuregamestudio.co.uk/forums/index.php?topic=51340.0
This is where we discussed possible formats, having manual source only in one place, automatic upload to site, and so on.

Since that thread exists I did not want to discuss it here again, because I practically have to repeat myself multiple times. I was posting here for only one reason: trying to update online manual to the latest 3.4.1 version.

Wiki is a separate question. I would not care about it much if lots of people would not rely on it thus sticking to outdated material.

what about this for a start?
http://www.adventuregamestudio.co.uk/wiki/Credits_(manual)
What about it?
« Last Edit: 18 Mar 2018, 10:59 by Crimson Wizard »

selmiak

  • ǝsıɔɹǝxǝ ʞɔǝu puɐ uıɐɹq
    • I can help with play testing
    •  
    • I can help with proof reading
    •  
    • I can help with translating
    •  
    • I can help with web design
    •  
    • selmiak worked on a game that was nominated for an AGS Award!
Re: Wiki manual pages out of date
« Reply #28 on: 18 Mar 2018, 11:00 »
what about this for a start?
http://www.adventuregamestudio.co.uk/wiki/Credits_(manual)
What about it?

the forum software screwed up the link, click it again in my edited post...

Crimson Wizard

  • AGS Project Tracker Admins
    • Best Innovation Award Winner 2013, for spearheading the AGS 3.3.0 project
    •  
    • Lifetime Achievement Award Winner
    •  
    • Crimson Wizard worked on a game that was nominated for an AGS Award!
      Crimson Wizard worked on a game that won an AGS Award!
Re: Wiki manual pages out of date
« Reply #29 on: 18 Mar 2018, 11:04 »
You probably should not be editing each page individually. As cat mentioned in her post above, there is a template for "manual entry" which supposed appears on every page in manual category:
http://www.adventuregamestudio.co.uk/wiki/Template:Manual_entry

But, wiki is not interesting to me, I do not want to decide anything about it.
« Last Edit: 18 Mar 2018, 11:05 by Crimson Wizard »

selmiak

  • ǝsıɔɹǝxǝ ʞɔǝu puɐ uıɐɹq
    • I can help with play testing
    •  
    • I can help with proof reading
    •  
    • I can help with translating
    •  
    • I can help with web design
    •  
    • selmiak worked on a game that was nominated for an AGS Award!
Re: Wiki manual pages out of date
« Reply #30 on: 18 Mar 2018, 11:06 »
Is this the WHOLE MANUAL delivered with the AGS editor in ONE FILE??? That is nice and a great source. But then you'd have to know or learn LaTeX to edit the manual, which is another barrier, but it's like that it seems.

I do not know if this was sarcasm, but having it in one file does not really make it a great source, because it makes it difficult to search and edit.
not really sarcasm, just too quick to post, it is a great source as it is all in one place, but somehow I clicked send before writing down what you wrote down. split it in parts to make it load faster and easier to edit and all the format changes from the other threads... but for that, the other thread is there, push it to restart the discussion or do something, I have no idea about LaTeX or .chm formats or whatelse is out there ;)

selmiak

  • ǝsıɔɹǝxǝ ʞɔǝu puɐ uıɐɹq
    • I can help with play testing
    •  
    • I can help with proof reading
    •  
    • I can help with translating
    •  
    • I can help with web design
    •  
    • selmiak worked on a game that was nominated for an AGS Award!
Re: Wiki manual pages out of date
« Reply #31 on: 18 Mar 2018, 11:18 »
You probably should not be editing each page individually. As cat mentioned in her post above, there is a template for "manual entry" which supposed appears on every page in manual category:
http://www.adventuregamestudio.co.uk/wiki/Template:Manual_entry

But, wiki is not interesting to me, I do not want to decide anything about it.
direct links would be more convenient, but there you go, the manual entry template now also links to the /manual