Jibble

Author Topic: Still not made open source: The help project files :-)  (Read 3309 times)

Monsieur OUXX

  • Mittens Half Initiate
    • I can help with proof reading
    • I can help with translating
    • I can help with voice acting
    • Monsieur OUXX worked on one or more games that won an AGS Award!
    •  
    • Monsieur OUXX worked on one or more games that was nominated for an AGS Award!
Chris, how could you do that to the community? How could you not release the most important part of the AGS source code? The most intricate and critical part of the project? Is this what you dare calling an open-source project?

At this stage, everybody has understood I was talking about the Help project files -- the files meant for Microsoft's HTML Help workshop.  :=
Well, I suppose that's the tool you used to generate the .chm file. Am I correct? If so, did I miss the subfolder where the files are kept?

With the current technology, a .chm file is easily decompiled, but not easily recompiled.
 

monkey0506

  • SEND PIZZA.
    • Best Innovation Award Winner 2017, for his work to help AGS games reach the widest possible audience - through popular distribution platforms (Steam, Galaxy) as well as other operating systems (Android, Linux)
    • monkey0506 worked on one or more games that won an AGS Award!
    •  
    • monkey0506 worked on one or more games that was nominated for an AGS Award!
Re: Still not made open source: The help project files :-)
« Reply #1 on: 13 Jun 2012, 15:09 »
Liar. Stop spreading your filthy words against CJ. The manual has been open sourced for some time. Did you even bother looking in the SVN? :P

Calin Leafshade

  • Long live King Cat!
    • I can help with making music
    • I can help with voice acting
    • Calin Leafshade worked on one or more games that won an AGS Award!
    •  
    • Calin Leafshade worked on one or more games that was nominated for an AGS Award!
Re: Still not made open source: The help project files :-)
« Reply #2 on: 13 Jun 2012, 18:25 »
The manual needs rewriting. CHM is lol.

Off you go frenchy.

Monsieur OUXX

  • Mittens Half Initiate
    • I can help with proof reading
    • I can help with translating
    • I can help with voice acting
    • Monsieur OUXX worked on one or more games that won an AGS Award!
    •  
    • Monsieur OUXX worked on one or more games that was nominated for an AGS Award!
Re: Still not made open source: The help project files :-)
« Reply #3 on: 13 Jun 2012, 21:08 »
The manual has been open sourced for some time. Did you even bother looking in the SVN? :P

You call me a liar? Your mom! Actually that's exactly where I looked. I checked out the non-native stuff (it was a checkout from several months ago) and performed a search on "*.hhp". I'll look again.
EDIT : found it immediately. I don't know what on earth was in my other checkout, maybe just the Editor source. (I can't check, it's on another computer in another house :-D). Also I'm impressed that the .hhp is generated on the fly.

The manual needs rewriting. CHM is lol. Off you go frenchy.

The advantage of this format is that it's all-in-one (thesaurus + index + search). But a change is welcome, and it's the right time, because I've read many reports of hhc.exe crashing on Windows 7. Any recommendations for a [compact enough] web-based equivalent?
EDIT: actually I'll create a new thread for that.
« Last Edit: 13 Jun 2012, 21:28 by Monsieur OUXX »
 

Monsieur OUXX

  • Mittens Half Initiate
    • I can help with proof reading
    • I can help with translating
    • I can help with voice acting
    • Monsieur OUXX worked on one or more games that won an AGS Award!
    •  
    • Monsieur OUXX worked on one or more games that was nominated for an AGS Award!
Re: Still not made open source: The help project files :-)
« Reply #4 on: 13 Jun 2012, 22:47 »
To anyone who has commit access to the repository : Here is an enhanced version of trunk/Manual/run.cmd

If does 2 new things :
  • All output is put into a "output" subfolder (otherwise it produces a hundred files in the same folder)
  • At the end it asks you explicitly if you want to run hhc.exe

Code: Adventure Game Studio
  1.  
  2. rem version 1.4
  3.  
  4. @echo off
  5. if not exist output mkdir output
  6. if not exist .\output\images mkdir .\output\images
  7.  
  8. echo _  
  9. echo ===========
  10. echo The output will be placed in folder "output".
  11. echo ===========
  12. echo _
  13. pause
  14. @echo on
  15.  
  16. copy .\images\*.* .\output\images\.
  17. copy .\*.gif .\output\.
  18.  
  19. start /WAIT tex2rtf.exe ags.tex .\output\ags.html -html -sync
  20. move *.con .\output\.
  21.  
  22. striphdr htmlfiles\actutor.htm .\output\ags29.htm
  23. striphdr htmlfiles\actutor2.htm .\output\ags30.htm
  24.  
  25. copy procdocs.exe .\output\procdocs.exe
  26. cd output
  27. procdocs.exe
  28. del procdocs.exe
  29.  
  30. cd ..
  31. cd htmlfiles
  32. for %%i in (acintro*.htm) do ..\striphdr %%i ..\output\%%i
  33.  
  34. cd ..\output
  35. for %%i in (acintro*.htm) do echo %%i >>ags.hhp
  36. echo ..\images\*.jpg >>ags.hhp
  37. echo ..\images\*.gif >>ags.hhp
  38.  
  39. @echo off
  40. echo _
  41. echo ===========
  42. echo You must now choose if you want to compile the project into a .CHM file.
  43. echo It will use the old "hhc.exe" utility.
  44. echo (it might not always work if HTML Help workshop 4.74.8702.0
  45. echo is not installed on this machine and/or if you use windows 7).
  46. echo ===========
  47. echo _
  48.  
  49. :decide
  50.         set /p choice=Do you want to compile? (Y/N)
  51.          
  52.         if "%choice%"=="Y" goto compile
  53.         if "%choice%"=="y" goto compile
  54.         if "%choice%"=="N" goto nocompile
  55.         if "%choice%"=="n" goto nocompile
  56. goto decide
  57.  
  58. :nocompile
  59.         @echo off
  60.         echo _
  61.         echo You skipped compiling.
  62.         echo _
  63. goto askclean
  64.  
  65.          
  66. :compile
  67.         rem current folder = ./output
  68.         @echo on
  69.         copy ..\hhc.exe .
  70.         copy ..\hha.dll .
  71.         hhc ags.hhp
  72.         del hhc.exe
  73.         del hha.dll
  74. goto askclean
  75.    
  76.    
  77. :askclean
  78.         @echo off
  79.         echo _
  80.         echo ===========
  81.         echo Do you want to clean the temporary files?
  82.         echo  - Choose No if you plan on compiling the .hhp file with
  83.         echo    an alternative tool such as Precision Helper.
  84.         echo  - Choosing Yes will leave only the .CHM help file (if it
  85.         echo    has been compiled) in the "output" folder.
  86.         echo ===========
  87.         echo _
  88.            
  89.            
  90. :decide2
  91.         set /p choice=Do you want to clean temporary files? (Y/N)
  92.          
  93.         if "%choice%"=="Y" goto clean
  94.         if "%choice%"=="y" goto clean
  95.         if "%choice%"=="N" goto noclean
  96.         if "%choice%"=="n" goto noclean
  97. goto decide2
  98.  
  99.  
  100. :clean
  101.         echo You decided to clean.
  102.         @echo on
  103.         rem current folder = ./output
  104.         del *.htm
  105.         del *.con
  106.         del ags.hh*
  107.         del ags.htx
  108.         del ags.ref
  109.         del *.gif
  110.         rmdir /s /q images
  111. goto end
  112.  
  113. :noclean
  114.         @echo off
  115.         echo _
  116.         echo You skipped cleaning.
  117.         echo _
  118. goto end
  119.    
  120. :end
  121.         @echo off
  122.         echo _
  123.         echo Finished.
  124.         echo _
  125.         echo ===========
  126.         echo IMPORTANT NOTES:
  127.         echo If you compile the .hhp file with Precision Helper,
  128.         echo    1) Don't forget to sort the Index alphabetically
  129.         echo       using the GUI.
  130.         echo    2) If you build a HTML help, don't forget to copy
  131.         echo       the "images" folder into the folder where 'index.htm'
  132.         echo       is located.
  133.         echo ===========
  134.         echo _
  135.         pause
  136.  
  137.  
  138.  
  139.  

EDIT: The file above has been updated to version 1.1
EDIT: The file above has been updated to version 1.2
EDIT: The file above has been updated to version 1.4
« Last Edit: 15 Jun 2012, 11:53 by Monsieur OUXX »
 

Monsieur OUXX

  • Mittens Half Initiate
    • I can help with proof reading
    • I can help with translating
    • I can help with voice acting
    • Monsieur OUXX worked on one or more games that won an AGS Award!
    •  
    • Monsieur OUXX worked on one or more games that was nominated for an AGS Award!
Re: Still not made open source: The help project files :-)
« Reply #5 on: 18 Jun 2012, 02:47 »
Bump.
 

monkey0506

  • SEND PIZZA.
    • Best Innovation Award Winner 2017, for his work to help AGS games reach the widest possible audience - through popular distribution platforms (Steam, Galaxy) as well as other operating systems (Android, Linux)
    • monkey0506 worked on one or more games that won an AGS Award!
    •  
    • monkey0506 worked on one or more games that was nominated for an AGS Award!
Re: Still not made open source: The help project files :-)
« Reply #6 on: 18 Jun 2012, 20:00 »
What's the point of updating this if the HAT is being replaced anyway?

Spoiler: ShowHide
There, I responded. -_-

Monsieur OUXX

  • Mittens Half Initiate
    • I can help with proof reading
    • I can help with translating
    • I can help with voice acting
    • Monsieur OUXX worked on one or more games that won an AGS Award!
    •  
    • Monsieur OUXX worked on one or more games that was nominated for an AGS Award!
Re: Still not made open source: The help project files :-)
« Reply #7 on: 19 Jun 2012, 16:45 »
What's the point of updating this if the HAT is being replaced anyway?

Is the HAT replaced yet? :-)
At the moment even the new HTML-based help is generated from the .hhp project. It's human-error prone. And as you can see the new .cmd gives useful advice.
 

Re: Still not made open source: The help project files :-)
« Reply #8 on: 21 Jun 2012, 15:39 »
If you want this to be included in the git repository send a pull request or ask JJS to give you commit access.

Crimson Wizard

  • Local Moderator
    • Best Innovation Award Winner 2013, for spearheading the AGS 3.3.0 project
    • Lifetime Achievement Award Winner
    • Crimson Wizard worked on one or more games that won an AGS Award!
    •  
    • Crimson Wizard worked on one or more games that was nominated for an AGS Award!
Re: Still not made open source: The help project files :-)
« Reply #9 on: 02 Jan 2014, 21:01 »
If you want this to be included in the git repository send a pull request or ask JJS to give you commit access.
I guess this was never submitted to git repository?

Both points Monsieur OUXX mentioned sound right (especially moving all the clutter to other folder).

Crimson Wizard

  • Local Moderator
    • Best Innovation Award Winner 2013, for spearheading the AGS 3.3.0 project
    • Lifetime Achievement Award Winner
    • Crimson Wizard worked on one or more games that won an AGS Award!
    •  
    • Crimson Wizard worked on one or more games that was nominated for an AGS Award!
Re: Still not made open source: The help project files :-)
« Reply #10 on: 07 Jan 2014, 16:51 »
Does anyone have an idea what program should be normally used to edit the "ags.tex" file?
I tried couple of TeX editing applications (LaTeX and LyX), but either I do something wrong, or these are not what I need; in LaTeX I can only see the text source as I do in any notepad (with various markup tags) and LyX, while allows some kind of "WYSIWYG" preview, fails to parse the format properly, as it seems, or the format is incorrect, because on many occasions there's an inconsistent formatting applied.

Re: Still not made open source: The help project files :-)
« Reply #11 on: 07 Jan 2014, 23:42 »
Yes, tex files are just text files and edited with text editors. They are source code for generating documents in other formats. Personally I use pdflatex (available in any Linux distribution) to generate pdfs from tex files.

This tex file is in another TeX or LaTeX dialect that works only with tex2rtf as far as I know. You can generate the htm files from the ags.tex on Linux with the compile_documentation_unix.sh I created and on Windows it should somehow work with the tex2rtf.exe that is included in the same folder.

EDIT: Ah yes the Windows equivalent to compile_documentation_unix.sh is run.cmd, but I never tested it.
« Last Edit: 07 Jan 2014, 23:54 by BigMc »