Angband.oook.cz
Angband.oook.cz
AboutVariantsLadderForumCompetitionComicScreenshotsFunniesLinks

Go Back   Angband Forums > Angband > Development

Reply
 
Thread Tools Display Modes
Old June 9, 2011, 21:13   #1
qwerty
Rookie
 
Join Date: Dec 2010
Posts: 21
qwerty is on a distinguished road
Making pdf of help files

From:
http://angband.oook.cz/forum/showthread.php?t=4494
Quote:
Originally Posted by Magnate
Turn the help files into HTML and PDF - ok so this does require knowledge of HTML, but not C.
I decided to give this a go using tex and have made all the files into a pdf. I have made a github repository for all the files located here: https://github.com/qwerty16/Angband-Help----PDF

The pdf file is named angbmanual.pdf, all the rest of the files are used to create the pdf using latex. There are instructions on how to make the pdf from the other files in the README.

Any comments, suggestions or spotted errors are most welcome.
qwerty is offline   Reply With Quote
Old June 9, 2011, 22:26   #2
jens
Swordsman
 
Join Date: Apr 2011
Location: Göteborg, Sweden
Posts: 348
jens is on a distinguished road
This is great :-) Now if someone can update the content as well :-)
jens is offline   Reply With Quote
Old June 10, 2011, 12:52   #3
Nolendil
Adept
 
Nolendil's Avatar
 
Join Date: May 2007
Location: Paris, France
Posts: 171
Donated: 10 euro
Nolendil is on a distinguished road
It looks good, nice job.
__________________
A(3.2.0) C "Angdiira II" DP L:36 DL:44(2200') A+ R+ Sp w:Whip of Westernesse(+10,+10)(+2)
A Mx H- D c-- f- PV+ s- d P++ M+
C- S-- I So B++ ac GHB- SQ+ RQ++ V+
Nolendil is offline   Reply With Quote
Old June 11, 2011, 10:31   #4
Magnate
Angband Devteam member
 
Join Date: May 2007
Location: London, UK
Posts: 5,057
Magnate is on a distinguished road
Send a message via MSN to Magnate Send a message via Yahoo to Magnate
Quote:
Originally Posted by jens View Post
This is great :-) Now if someone can update the content as well :-)
@qwerty: many thanks for your work - this has kick-started four years of stalled progress!

For more up-to-date content, please see http://rephial.org/wiki/UserManual. I'm not sure how much of this would be useful in a PDF - but I'm sure the current content could be enhanced a little. (Apologies for not putting this link into the initial tasks thread.)
Magnate is offline   Reply With Quote
Old June 11, 2011, 15:54   #5
fph
Knight
 
Join Date: Apr 2009
Location: Berlin / Italy
Posts: 783
fph is on a distinguished road
Quote:
Originally Posted by Magnate View Post
For more up-to-date content, please see http://rephial.org/wiki/UserManual. I'm not sure how much of this would be useful in a PDF - but I'm sure the current content could be enhanced a little. (Apologies for not putting this link into the initial tasks thread.)
I think I could contribute to this project, too, especially on the LaTeX formatting enhancement side. However, I feel that we should before:
(1) decide which documentation is going to be ported to PDF
(2) decide, after the conversion, that the LaTeX/PDF version is the "final one" and that all subsequent changes should be made to that one and then converted back to raw text or HTML if needed.

Otherwise I fear we will end up with two separate diverging versions of the documentation. Dealing with diff's and patches in the documentation isn't very practical, since LaTeX conversion involves some regexp substitution in the process (e.g., escaping all lower-than and greather-than symbols).
fph is offline   Reply With Quote
Old June 11, 2011, 16:49   #6
d_m
Angband Devteam member
 
d_m's Avatar
 
Join Date: Aug 2008
Location: Philadelphia, PA, USA
Age: 39
Posts: 1,516
d_m is on a distinguished road
I think I would be fine with having LaTex be the primary documentation, providing that the conversions to HTML and TXT are good. I've worked with LaTex and like it pretty well.

While Takkaria and the devteam probably need to communicate our intentions about what we want updated/added/changed in the documentation, whoever takes this on will get substantial leeway (and responsibility) to decide these things themselves.

EDIT: Sorry I obliquely answered your question about which documentation to update. Honestly, I don't have a good perspective on which is the best place to start.
__________________
linux->xterm->screen->pmacs
d_m is offline   Reply With Quote
Old June 11, 2011, 19:07   #7
Derakon
Prophet
 
Derakon's Avatar
 
Join Date: Dec 2009
Posts: 8,918
Derakon is on a distinguished road
The LaTeX version, exported to PDF, would certainly be more convenient than the in-game help -- you can search it more readily, and you can easily switch back and forth between your game and a specific point in the help. I vote for it being the primary help docs. In fact we could simply refer the user to the PDF when they hit '?' and do away with the in-game help altogether. Online HTML help should probably still be made though.
Derakon is offline   Reply With Quote
Old June 11, 2011, 20:27   #8
takkaria
Veteran
 
takkaria's Avatar
 
Join Date: Apr 2007
Posts: 1,936
Donated: $40
takkaria is on a distinguished road
Quote:
Originally Posted by Derakon View Post
The LaTeX version, exported to PDF, would certainly be more convenient than the in-game help -- you can search it more readily, and you can easily switch back and forth between your game and a specific point in the help. I vote for it being the primary help docs. Online HTML help should probably still be made though.
The thing that gets the most hits past the front few pages on rephial.org is the manual, so I'd consider it essential to have good-quality HTML help too. And if we just shipped as PDF, I'd feel sorry for all the people who are going to be using Acrobat Reader on Windows.

My original plan, as outlined on the ticket, was to make HTML documentation primary and use Prince to convert it to PDF, but that seems to be even more of a specialist thing than LaTeX.

Quote:
In fact we could simply refer the user to the PDF when they hit '?' and do away with the in-game help altogether.
I agree. The help tickets are all about getting rid of in-game help – I've been wanting to kill that code for so many years now...
__________________
takkaria whispers something about options. -more-

Last edited by takkaria; June 11, 2011 at 20:34.
takkaria is offline   Reply With Quote
Old June 11, 2011, 20:39   #9
takkaria
Veteran
 
takkaria's Avatar
 
Join Date: Apr 2007
Posts: 1,936
Donated: $40
takkaria is on a distinguished road
Quote:
Originally Posted by Magnate View Post
@qwerty: many thanks for your work - this has kick-started four years of stalled progress!

For more up-to-date content, please see http://rephial.org/wiki/UserManual. I'm not sure how much of this would be useful in a PDF - but I'm sure the current content could be enhanced a little. (Apologies for not putting this link into the initial tasks thread.)
I think there needs to be some discussion around what should be in documentation and what shouldn't. I think it should aim to explain how the game works while still leaving surprises. The online docs have a few too many lists of game content by this measure and they should definitely be left out, IMO.
__________________
takkaria whispers something about options. -more-
takkaria is offline   Reply With Quote
Old June 11, 2011, 21:01   #10
Magnate
Angband Devteam member
 
Join Date: May 2007
Location: London, UK
Posts: 5,057
Magnate is on a distinguished road
Send a message via MSN to Magnate Send a message via Yahoo to Magnate
Quote:
Originally Posted by takkaria View Post
The thing that gets the most hits past the front few pages on rephial.org is the manual, so I'd consider it essential to have good-quality HTML help too. And if we just shipped as PDF, I'd feel sorry for all the people who are going to be using Acrobat Reader on Windows.
http://www.foxitsoftware.com/products/reader/
Quote:
I agree. The help tickets are all about getting rid of in-game help – I've been wanting to kill that code for so many years now...
I thought you wanted the HTML help to be available in-game? Isn't that what the desire for context-sensitive help is about? Did you mean you just wanted to get rid of the help menu?
Magnate is offline   Reply With Quote
Reply


Currently Active Users Viewing This Thread: 1 (0 members and 1 guests)
 
Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off

Forum Jump

Similar Threads
Thread Thread Starter Forum Replies Last Post
Making the game harder, take three Magnate Vanilla 104 April 26, 2011 04:56
Making devices useful Philip Vanilla 21 February 5, 2011 08:42
YASD in the making PowerDiver AAR 10 July 6, 2010 08:21
Winner in the making? Nero AAR 17 May 22, 2010 23:44
making a semi-variant (more talk about modifying the /edit .txt files) will_asher Variants 20 December 2, 2007 11:38


All times are GMT +1. The time now is 08:31.


Powered by vBulletin® Version 3.8.11
Copyright ©2000 - 2019, vBulletin Solutions Inc.