Expand the sample configuration file a little and prevent it from
going past the right margin in Guidebook.txt.
Replace all instances of "config file" with "configuration file".
Reformat the "notes" at the end of the table of map symbols.
Unfortunately Guidebook.pdf from Guidebook.ps from Guidebook.mn
puts a page break between the header line "notes" and the two
actual notes.
Value 1 for 'mouse_support' was not just exceeding the margin of
Guidebook.txt but wrapping to the next line. Shorten it.
Guidebook.tex had a typo "in the foler" (where 'folder' was meant)
and Guidebook.mn didn't have that phrase at all.
Remove a few trailing spaces.
Guidebook.tex not tested. The \, in the continuation of S_stone is
a narrow space in LaTeX. It should be \hspace{ width of '(' } but
I don't remember how to measure something in LaTeX or TeX.
Guidebook.mn is getting two small changes: I forgot about the
guideline that each sentence be on its own line. Also, this adds the
fix for wide lines in the dungeoneers list although the reordering
accompanying a recent change might have made that moot (unless some
future reordering puts wide names on the same line again, assuming
that was the issue).
The table listing symset entries was ok for ps/pdf output but for
plain text output it was wrapping to a second line for S_xan,
S_pet_override, and S_player_override and also going past the right
margin for some others. I've shortened the text for those three
and narrowed the first column to give more room for the third column,
bringing all the lines within their margin.
The entry for S_stone was rather surprising: "dark part of a room".
It now says "solid rock or unexplored terrain or dark part of a room"
and needed to span two lines.
The first column has been labeled "Default" but that was why that
column was wider than necessary. It now has a label of two spaces
and is left justified instead of being centered. It is also now
forcing constant-width Roman as the font and every character in that
column should be the same size so one reason for centering is removed.
The title used to be centered but always looked a bit off due to the
fact that the three columns have differing widths and/or because of
the over-wide lines changing the location of "center". It is now
left justified and looks a little bit like it's labeling the first
column. Perhaps it needs a blank line separating it from the rest.
Guidebook.tex is lagging again.
This sample comment attending the sample SYMBOLS statement fit ok in
the pdf output but wrapped to another line in the plain text output,
so shorten it.
S_xan, S_pet_override, and S_player_override still wrap, but by a bit
less than before. Their width causes the line of dashes at the top
of the table to wrap too.
Guidebook.tex is still lagging behind.
I think it was issued by tbl but it wasn't about any of the tables.
warning: numeric expression expected (got 'R')
was complaining about
.lp SYMBOLS, ROGUESYMBOLS
Exclosing the paragraph label within quotes to make it one argument
to the lp macro or command would have fixed this, but I've split
them into two paragraphs. And reordered several of the paragraphs
which were alphabetized just enough to make the out of order ones
seem like mistakes.
Guidebook.tex needs to catch up.
A few symbol-related modifications:
- fulfill a request from a blind player to allow them to
specify a unique/recognizable character for all pets and/or
the player in the config file for use when using a screen
reader (S_player_override, S_pet_override). Requires sysconf
setting ACCESSIBILITY to be set to have an effect, although
they can still be specified in the config file.
- Config file SYMBOLS entries were not working properly on
the rogue level. Allow ROGUESYMBOLS as well as SYMBOLS to be
specified in the config file independently.
- When values are moved into showsyms[], the overriding SYMBOLS
or ROGUESYMBOLS entry from the config file is used if there is
one; if there is no overriding value for a particular symbol,
the loaded symset value is used; if there is no symset entry
loaded for the symbol then a default symbol is used.
Fixes#200
The Guidebook claims that there's no symbol for 'S_strange_object'
which is literally true, but there is one for S_strange_obj. It has
been in place longer than the paragraph claiming that there's no way
to customize that symbol. I'm not sure why variant spelling was used.
Also, files.c doesn't use loadsyms[], it calls a routine which returns
a pointer to a specific element in that array.
Extend support for highlight rules that specify percentages from HP
and spell power to experience level and experience points. For both
of those, the percentage is based on progress from the start of the
current Xp level to the start of the next Xp level. 100% isn't
possible so is used to enable highlighting a special case: 1 point
shy of next level, most likely to occur after losing a level.
This is something I had in mind a long time ago and then forgot all
about until fiddling with the final disclosure of experience points
recently. It turned out to be trickier than expected because it needs
to check whether Xp should have a status update when it hasn't changed
but Exp has gone up. The latter might hit a percentage threshold that
switches to another highlight rule. Fortunately changes to Exp, at
least that aren't part of level gain or loss (which always trigger
status updating), are all funnelled through a single place (I hope).
Tweak the status hilites section. Add a bit of detail about how to
specify both color and attribute and/or multiple attributes. Also,
change the Guidebook's table of status fields to be column-oriented.
With the exception of 'score', reading down the three columns now
matches going across the status lines. The previous ordering started
row-oriented but then became scrambled compared to the usual display.
As usual, Guidebook.tex is best guess....
The expansion of the extended commands list to include every command
has made picking extended commands out of X11's menu become tedious.
This uses the existing 'extmenu' option (previously tty-only) to
control whether all the commands are present or just the traditional
subset not bound to non-meta keystrokes ('adjust', 'chat', 'loot', &c).
Implement the 'statuslines' option for tty. 2 and 3 line status are
similar to curses. Tty's version doesn't include insertion of extra
spaces for enhanced readability, or ignoring 'showexp' when space is
needed for other fields, or right justifying 'score' and suppressing
it when there isn't room for the entire number. It continues to have
abbreviated condition and encumbrance descriptions that curses lacks
which get used when the normal ones take up too much space.
'statuslines' can be set with 'O' so it is feasible to switch back
and forth between 2 and 3 lines on the fly. But only if the display
is at least 25 lines (actually ROWNO+4) or else CLIPPING is enabled
at build time.
This fixes the bug where after resorting to abbreviated condition
values it sometimes (always?) wouldn't switch back after more room
became available. Abbreviated encumbrance values had problems too
(lack of leading space and not changing value if encumbrance changed
to anything other than unencumbered) and this fixes that as well.
curses uses 'reversed' (LIFO) style when displaying previous messages.
Use the existing (previously tty-only) 'msg_window' option to also
support 'full' (FIFO). The actual code needed as just a couple of
lines; tweaking options parsing and the documentation was more work.
More groundwork for overhauling the status display for curses, plus
a few functional changes. It was doing a full status update for
every changed field (except conditions), instead of waiting for a
flush directive after gathering multiple changes at a time. Since
it already does gather every change, the fix to wait is trivial.
This decouples 'hitpointbar' from 'statushilites'. When highlighting
is off, it uses inverse video only. When on, it behaves as before:
using inverse video plus the most recent color used to highlight HP
(which can vary if that has rules to highlight changes or percentage
thresholds) but ignoring any HP attribute(s). This also enables the
latent 'statuslines' option and changes 'windowborders' option from
being settable at startup only to changeable during play.
'statuslines' can have a value of 2 (the default) or 3 and applies to
'align_status:bottom' or 'top'; it's ignored for 'left' and 'right'.
At the moment, setting it to 3 only allows status condition overflow
to wrap from the end of line to 2 to the beginning of line 3, and if
window borders are drawn they'll clobber the last character on line 2
and first one on line 3. There's no point in trying to fix that
because it will go away when the main status overhaul changes go in.
Condition wrapping for vertical orientation (left or right placement)
was already subject to the same phenomenon and will be superseded too.
This also changes the meaning of the 'windowborders' value so could
impact players using source from git (or possibly beta binaries for
Windows, but not for OSX where curses interface wasn't included).
Old:
0 = unspecified, 1 = On, 2 = Off, 3 = Auto (On if display is big
enough, Off otherwise; reevaluated after dynamic resizing);
Unspecified got changed to 3 during curses windowing initialization.
New:
0 = Off, 1 = On, 2 = Auto;
0 gets changed to 2 for default value at start of options processing.
So old value of 2 is changing meaning and explicit old value of 3 is
becoming invalid. Implicit 3 changes to default 2. Explicit 3 could
be the subject of a fixup but there isn't much point since 2 can't
have a similar fix. Users who are using old 2 or explicit 3 will need
to update their run-time config files.
This adds 'statuslines' to the Guidebook and moves some other recently
added documentation of curses options from among the general options
(section 9.4) to "Window Port Customization options" (section 9.5).
None of them have been added to dat/opthelp which seems to be missing
all the wincap options.
Originally I made a lot of changes (mostly moving C99 declarations to
start of their blocks) to the old '#if 0' code at end of cursstat.c,
but have tossed those, except for one subtle bug that assumed 'int'
and 'long' are the same size.
number_pad got removed from Guidebook.tex when mouse_support was added
by cc0e7a8750fd4e07d3a44592c38f5912d4e603de; put it back. Evidently
a cut-and-paste mishap when copy-and-paste was intended, probably
provoked by '\numbox{}'.
Remove \numbox{} from mouse_support; it isn't needed there since the
choices aren't trying to line up with '-1'.
Both Guidebook.mn and Guidebook.tex:
Remove number_pad's "for backward compatibility" from mouse_support
since the latter is brand new.
New petattr list of uppercase letters seemed intrusive when rendered
with a bold font, so switch to lowercase. (Option processing already
supports either case.)
Mention the '=' prefix for hilite_status 'absolute' threshold.
[As usual, the Guidebook.tex changes haven't been tested.]
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.)
