texinfo figure environment

[email protected] (Karl Berry) Sun, 16 Nov 2003 12:34:33 -0500
Newsgroups gmane.comp.tex.texinfo.pretest
Message-ID <[email protected]>
One longstanding lack in Texinfo has been having no environment for
displayed, xref-able, figures/tables/examples/etc.

Arnold (Robbins), Alper, and I have been discussing this.  Here's our
current best effort.  Comments, criticisms, suggestions?

Thanks,
k

@figure [Figure|Table|Example|...]   # arbitrary text; default is Figure
@anchor{somelabel}                   # no default -> no numbering
@caption{This is the caption.}
... arbitrary commands/text to produce the actual figure ...
@end figure

Then @ref{somelabel} would produce "Figure 3.1" (or "Table 3.1" or
whatever type was used in the @figure command).  Always
<chapternum|appendix>.<sequencenumber>.  If in an @unnumbered, just
<sequencenumber>.  Each figure "type" has its own sequence number, reset
at chapter-level.

And a way to produce the "Lists of ..." contents-like pages, a la
@printindex:

  @node List of Tables
  @unnumbered List of Tables
  
  @listof Table

As noted, if the @anchor is omitted, the figure would not get a number
and would not be included in the "Lists of" lists.


We are not especially happy with the name @figure, since it conflates
the generic concept of "displayed environment" with the specific
instance of "Figure".  On the other hand, we haven't been able to think
of anything better.  @displayedenv seems pretty clunky/non-intuitive.

Ditto for the name @listof, which seems pretty generic.  maybe
@listoffigures (or @listofdisplayedenvs).

Eventually, we could implement a way to specify the location of the
figure ("here", "top", etc.), but for the first round, I was just going
to ignore that and always put it "here".  Implementing floating figures
would be a lot of additional work.
_______________________________________________
Texinfo home page: http://www.gnu.org/software/texinfo/
[email protected]
http://ff0.org/mailman/listinfo/texinfo-pretest
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.