Move some 'roff macros from Guidebook.mn to new file tmac.nh.
Header for tmac.nh is not being updated, even after explicitly adding
it to .gitattributes. I'm not sure what I've done wrong. (I'm using
'git nhadd doc/' here rather than explicit 'git nhadd doc/tmac.nh'.)
In Guidebook.mn, change the ``setenv NETHACKOPTIONS'' example so that
it fits within one line in Guidebook.txt. (I looked at 3.4.3's
edition of that file and the example went not just beyond the margin
of the formatted text but beyond 80 columns, so wrapped in an ugly
fashion.) I had previously changed 'autoquiver' to 'color' to shorten
it, now have changed '!autopickup' to '!leg' to show an example of
truncated option name as well as shorten, and also 'fruit:papaya' to
'fruit:lime' to squeeze out the last two columns needed to fit within
the text margin while retaining 'name:Blue Meanie' as requested.
Guidebook.txt shows both NETHACKOPTIONS examples with indentation
suppressed, Guidebook.ps uses normal indentation (evidently using a
narrower font, even with \f(CR (constant-width Roman) to approximate
TeX's \tt, since the indented example fits fine and looks better).
Some Guidebook.tex catchup. I suspect that lots of bits and bobs
don't match between Guidebook.mn and Guidebook.tex these days.
Particularly quoting and variant font (italics, bold, \tt) usage.
Also the recently added box around the sample screenshot. This
modifies the screenshot to match Guidebook.mn's, reflecting change
in status field spacing by STATUS_HILITES.
Change the extended command section from a mixture of
|#cmd This is a short-named command.
|#command
| This is a long-named command.
to every command having its descriptive text start on the next line
|#cmd
| This is a short-named command.
|#command
| This is a long-named command.
which results in a longer document but the extended commands section
is much easier to read.
No change to Guidebook.txt, where the previous command name padding
was wide enough to accomplish the same for fixed-width tty font.
There is an update to that though; a previous change omitted it.
Change instances of 'C' and ``C'' to `C'.
Change a few double quotes, "..." to ``...''.
Remove some trailing spaces (for Guidebook.mn too).
One tweak in wording: for #offer, ``use `m' to skip items on altar''
followed by ``you'll need to find an altar'' sounded strange. Move the
``skip items on altar'' sentence after the ``need an altar'' sentence.
Replace `C' and 'C' with \(oqC\(cq (open and close single quote).
For plain text output, the new form generates the first form. Most
single quotes were using that, but there was quite a bit of C-style
char quoting that was somewhat inconsisent.
There are several text changes too, mostly small. The few I can
remember are
replacing several ``#twoweapon'' with `X';
pets: change 'cat' to 'kitten' and mention that horses are
vegetartian where it claims that pets usually feed themselves;
NETHACKOPTIONS: add `bash' to the shells mentioned,
describe `NETHACKOPTIONS=@filename' better,
shorten the example (it's still too long for Guidebook.txt);
Configuring Status Hilites: expand the `behavior' descriptions
to mention the value limits for percentage and absolute, and
include post-3.6.1 '<=' and '>=' for them,
add omitted fields `hunger' and `title' to text match.
I also changed a bunch of examples in the option configuation section
from bold font to constant-width Roman which more closely resembles
the \tt font in TeX. Probably a whole bunch of other bold items
ought to follow suit.
Issues:
title for section 9.3 (NETHACKOPTIONS) is too close to the sample
config file at the end of section 9.2;
as mentioned above, the sample ``setenv NETHACKOPTIONS foo'' is
much too long for Guidebook.txt, and ``NETHACKOPTIONS=foo'' is
slightly too long; they're ok in Guidebook.ps (assuming default
page size);
does `WIZKIT=~/wizkit.txt' actually work? That's the example shown.
I started out updating Guidebook.mn to use \(oq and \(cq for single
quotes but ended up including some new text. I've separated that
part out (there are a few instances of altered quoting in the midst
of it--the separation wasn't 100%) to commit separately.
Add verbiage to "choosing race" and several commands: f, s, S, t,
w, and ^X.
Change `E-' and `w-' to use minus sign instead of hyphen. The TeX
edition uses \tt font for those which has the same effect of making
those dashes be more prominent.
Fix typo/thinko in `IX': Guidebook.mn and Guidebook.txt said that
displayed inventory items whose bless/curse state is "known".
Guidebook.tex had it right, "unknown".
Putting a box around the simulated screenshot has a side-effect of
forcing it to the next page if there isn't room on the current page.
And it looks at least as good as the old top and bottom horizontal
lines, if not better. This also eliminates the blank left-most
column (relative to those lines) which isn't part of the screenshot.
There are issues:
1) for Guidebook.ps, the "Figure 1" label underneath seems to be
too close to the box; I didn't try to force a blank line in front
of it because that increases the risk of pushing it to the next
page if the figure lands at the bottom;
2) for Guidebook.txt, the "Figure 1" label actually overwrites the
bottom line of the box, and the embedded space allows the line
to show through: "---Figure-1---"; I tried using "\ Figure\ 1\ "
to see if that might hide the issue by making it seem that the
label in intended to be on that line, but it didn't help--
unbreakable-space evidently does not imply always-visible-space;
3) the box is one column wider than the rest of the document (the
previous horizontal lines were two or three columns wider, so
this is actually a tiny imrovement); squeezing out some whitespace
to make the status lines narrower didn't help--or at least not
enough; squeezing some spaces was needed to match STATUS_HILITES-
era status formatting anyway.
4] if there was a footnote (we have some for trademarks) on the same
page as the screenshot, either the footnote or the table would
probably become confused, perhaps both. I think we just pretend
that that will never come up....
5} I've made no attempt to alter Guidebook.tex to try to match.
I'm throwing in the towel. Fixing this up is way beyond my limited
'roff/tbl capability. (There's probably a much more straightforward
way to achieve what we want.)
Reported for Windows beta3 but turns out to be present in 3.6.1
distribution.
| #wait
| Rest one move while doing nothing. Default key is '.', and '
| ' if rest_on_space is on.
where the line split occurs in the middle of "' '". We should
switch from the ascii single quote to the 'nroff open and close
single quote escapes but I haven't gotten around to that.
Preceding the space with backslash prevents a line break there.
Replace ``foo'' with \(lqfoo\(rq (many instances) so that the
plain text Guidebook will use ". Also a few `bar' with \(lqbar\(rq
(mostly `#enhance' and `#twoweapon') to be consistent with other
command names that all use double quotes. And replace a few strings
in actual double quotes with corresponding \(lq or \(rq.
Replace command descriptions using ^X with \(haX to get the larger
circumflex character (aka 'hat') instead of the smaller circumflex
punctuation. (Not noticeable with plain text output.)
Changed one DOS and a few MSDOS to MS-DOS to match the spelling in
the trademark line at the end.
Start each sentence on its own line for the paragraphs which were
being subjected to the above changes.
Also a much smaller subset for Guidebook.tex (not tested...).
Does not address the "wrapped to next line in middle of ' '" issue.
\#H7448 - option 'dark_room' showed incorrect default value.
\#H7446 - persistence of objects section was missing a word in
its second paragraph.
Also, fix up some clumsy wording in the first paragraph of that
same section.
This was discussed two years ago then nothing happened. Make
autodescribe for feedback when moving the cursor to pick something
default to on instead of off.
Demote #monpolycontrol and #wizdebug_traveldisplay from commands to
simple boolean options. The former has the same name, the latter
is called travel_debug. Rename #wizdebug_bury to #wizbury; it
shouldn't matter that it goes away when compiled without DEBUG.
There are now five wizard-mode boolean options: monpolycontrol,
sanity_check, and wizweight are documented in the Guidebook;
menu_tab_sep and travel_debug are commented out there.
Guidebook.mn has been tested; Guidebook.tex has not.
Bug report #H7156 listed three items, all relating to perm_invent:
1) it shouldn't persist across save/restore since restore might be
on a system which doesn't have enough room to display it (report
actually complained that config file setting was ignored when
restoring old games, which is an expected side-effect for options
that persist across save/restore);
2) permanent inventory wasn't updated when using scroll of charging;
3) attempts to update permanent inventory during restore could lead
to crash if it tries to access shop cost for unpaid items.
Items (2) and (3) have already been fixed. This fixes (1).
Replace 'flags.perm_invent' with a dummy flag, preserving save files
while removing it from flags. Add 'iflags.perm_invent' to hold the
value of the perm_invent option.
The win32 files that are updated here haven't been tested. Whichever
branch contains the curses interface needs to be updated; ditto for
any other pending/potential interfaces which support perm_invent.
I noticed that the description of ^O still referred to the 3.6.0
behavior (either #wizwhere or #overview depending upon play mode)
rather than the 3.6.1 behavior (unconditional #overview).
While updating that I changed a bunch of "Wizard-mode" references
to "Debug mode" which is the proper end-user name.
I slightly expanded the descriptions of #wizdetect, #wizgenesis,
\#wizintrinsic, WIZKIT, and Debug mode, and removed at least one
out of date reference to debug mode being a conditional feature.
And for most of the stuff I was looking at, I changed the nroff
source to honor the roff guideline of having each sentence start
on its own line (and also the latex source to use those same line
breaks even though they don't need it).
Not done: a lot of quoted single characters use 'c' instead of `c'
(pair of ticks rather than back-tick and normal tick). One form
or the other should be changed so that they're all consistent.
I'm pretty this was mentioned the last time it was formatted for
the web site.
Guidebook.mn has been tested, Guidebook.tex has not.
Mostly add a paragraph clarifying the classification of WONTFIX for
a reported bug ('I' unseen monster clobbers remembered object at the
location). It felt like it needed a parallel paragraph for monsters.
A couple of \e to \\ changes, a whole bunch of ^ to \(ha changes
(similar character but bigger so easier to see), ~ to \(ti (ditto),
and - to \- (first is a hyphen, second is a minus sign which is
bigger; see the difference for "- and | The walls of a room...").
As well as horizontal walls, open doors, top and bottom of swallow
and explode octagons, I changed command line switches -s, -X, and -D
to use minus sign. I was unsure whether the umpteen M-C should be
changed too. Since it was less work to leave them as-is, that's
what I did. I also left ^C with smaller circumflex punctation
instead of changing to bigger circumflex character for same reason.
The [much smaller] Guidebook.tex changes need testing.
Not fixed:
I think the sentence "you can type 'nethack -s all' on most versions"
is very misleading. Using 'versions' to refer to the various ports
rather than different releases is iffy, but my complaint is that
"typing something" sounds like an action you would perform while in
the game. Access to a command line and figuring out how to invoke
nethack from there is probably not something where "most versions"
applies any more. But I don't know how to rephrase that succinctly.
If I did, I would have just changed it....
The sample map was being rendered in a proportional-width font for
Guidebook.mn -> Guidebook.ps -> Guidebook.pdf so looked awful. It
is quite hard to believe that no one ever noticed this. I wasn't
sure how to force tty font, but it is straightforward to pick
constant-width variant of Roman which seems to be 'roff's universal
font.
Prevent ".nethackrc" from being hyphenated and split across lines.
Ditto for other file names in the same section even though they
hadn't been positioned in spots where they got split. I put same
thing into Guidebook.tex but I don't know whether their embedded
dots will become a problem there.
Loads of unmatched double quotes were confusing Emacs' nroff-mode
(which unlike tex-mode for Guidebook.tex, wasn't being activated
by default for Guidebook.mn). Supply missing closing quote for a
bunch of things, convert literal '"' to '\(dq' for ones that aren't
intended to have matching close quote. And change a bunch of
instances of "text" to ``text'' for rendering as quoted strings.
(There are a lot of single-quoted characters 'c' which should
probably be `c' instead, but I haven't touched those.)
There were several '\e' to render the 'escape' character, but that
is something which can be changed at will. Use '\\' to explicitly
show backslash instead. Change several ' - ' and '--' to '\(em'
for M-sized dash. Right now they all have <space>\(em<space> but
the spaces probably shouldn't be there.
Change instances of 'number_pad' to '.op number_pad' to have it
rendered as an option name.
Remove the obsolete sentence which said that "Elbereth" might be
conditionally excluded. (This change also made in Guidebook.tex.)
Split some wide lines (wide in the source, not after rendering),
although this wasn't done exhaustively. For the re-split lines,
put each sentence on its own line as suggested by 'roff' man page.
Fix the alignment of three short tables which use 'key dash meaning'
so that the dashes line up using Keni's .PS/.PL/.PE macros. (There
might be others that need this.)
Center the "- - - -" separator which precedes the list of dungeoneers
at the end. (Thinking about it now, possibly it should be forced to
have zero paragraph indentation prior to centering rather than tacking
on some trailing spaces to shift the non-blank part to the left. The
title for the table of display symbols might be in the same boat here.
But I'm roff'd out for the time being.)
Try to explain object filtering for commands that can take multiple
object classes combined with multiple BUCX states (and/or 'unpaid').
At the moment it is attached to the 'D' command where it is most
likely to be used, but probably ought to have its own subsection in
the Objects chapter so that it doesn't bog down the command list.
The filtering paragraph ought to be duplicated in Guidebook.tex, but
there's enough quoting going on that I didn't trust myself to attempt
an untested change.
Instead of modifying tmac.n's '.ux' macro, replace usage of it with
clone '.UX' (inline in Guidebook.mn in order to avoid modifying tmac.n
according to the author's wishes). '.ux' was used in several places
and neglected in a few others. Now all "UNIX" references use '.UX'
(unless I missed some...). Only the first generates a trademark
footnote. Also only the first adds the (r) superscript for registered
trademark; it would be better if that macro always showed (r) while
continued to show the footnote only once.
I made the mistake of making a bunch of small revisions all at once
and am not going to try to separate them out for separate commit.
I'm not sure they all got reviewed closely; I didn't spot any glaring
errors while scrolling through the formatted file.
The table of display symbols wasn't quoting the backslash used for
thrones so that symbol showed erroneously as blank. hbeam, vbeam,
lslant, and rslant (used for zap animations) were mislabeled as
"wall". (drawing.c used to have the same bug but it got fixed about
two years ago. Guidebook.tex still needs to have this fixed.)
In the section 'using a configuration file', the file name ".nethackrc"
ended up as a hyphenated split across two lines. That needs to be
fixed; the presence of a dash makes the spelling of the name become
ambiguous.
Several small tables that use <something><space+dash+space><something>
don't line up their dashes correctly.
I replaced most blank lines and also lines which begin with whitespace.
One notable exception is the sample map excerpt. It seems to format
as intended so I didn't try to tinker with it.
Remove trailing spaces from doc/fixes36.1 (only a couple),
doc/Guidebook.mn (several), and doc/Guidebook.tex (many). I re-split
some lines made wider by embedded formatting directives, but tried to
avoid getting carried away with that.
I think I added one missing period to Guidebook.mn and one missing
comma to Guidebook.tex. Aside from that, they should format the same
as they did before this patch.
