Go Back   Angband Forums > Angband > Development

Thread Tools Display Modes
Prev Previous Post   Next Post Next
Old August 29, 2011, 22:11   #1
Join Date: Apr 2009
Location: Berlin / Italy
Posts: 805
fph is on a distinguished road
RST help files

(well, this time I decided to open a new thread instead of keep on going OT on this old one)

There is still some minor work to be done, but I think I have an usable version of the RST online help. Apart from the converted help files, there is:
-"make manual.html" and "make manual.pdf" that create HTML and PDF version
-the online help viewer skips "RST directives" (only when they are one-liners, for now, though)
-some modifications to files.c to parse menu and link targets directly from (a very limited subset of) RST.

What still needs to be done:
1. beautify the output: a better CSS and LaTeX preamble, maybe a couple of images.
2. instruct the online help viewer to render a couple of RST constructs in a more readable version (namely, |something| and "\ ", "\\").
3. skip RST directives as whole paragraphs.
4. there's a couple of warnings, that I think are due to outdated information in the docs (do we still have view_special_light and view_granite_light?). I could easily remove them, but I'd like someone to confirm me that they can go.
5. how can I get "make clean" to work properly, without mkmk complaining? The previous help files managed, but I can't understand what did the trick in the Makefile.
6. pressing ? at the right moment during character creation should lead directly to the classes and races description, but this doesn't work in the master branch either -- can you confirm that?
7. at some point, a weird bug in my editor removed some lower-case "s" letters at word start (e.g.: similar -> imilar). I think I have now fixed all the damage, but if you're skimming through the help files please keep your eyes open for words (not) beginning with "s".

The help file branch is online at After we fix items 4 and 5 (I need a quick consult for that), probably I can issue a pull request. Items 1, 2, 3 and 6 can be a later goal (there is no obvious regression).
Dive fast, die young, leave a high-CHA corpse.
You read a scroll labeled 'lol gtfo' of Teleport Level.
fph is offline   Reply With Quote

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
Pref files relic Vanilla 11 August 9, 2011 21:40
Help with dubtrain sound files please Magnate Vanilla 8 December 31, 2010 23:19
Updating help files fizzix Vanilla 23 August 3, 2010 05:19 files konijn_ Development 2 December 8, 2009 23:43
edit files? tummychow Vanilla 2 September 13, 2009 21:38

All times are GMT +1. The time now is 21:57.

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