texi2www.texi

RTEMS (Real-Time Executive for Multiprocessor Systems) is a free open source real-time operating sys

This extension provides a method for inserting a gif file in both the
html and printed document.  For example, here are my arrow icons:
@*
prev: @gif{prev-arrow.gif},
up: @gif{up-arrow.gif},
and next: @gif{next-arrow.gif}

@subsection @code{@@gif@{@}} and @var{texi2www}

@var{texi2www} copies @var{pict.gif} to the destination directory.

@subsection @code{@@gif@{@}} and @var{texi2dvi}

@href{@var{texi2dvi},texi2dvi} converts @var{pict.gif} to a font and
uses this font to insert the picture in the document.  This conversion
to a font requires that the pbmplus and bm2font utilities be installed on
your system:

@table @asis
@item pbmplus
      A suite of utilities for manipulating images.  @var{texi2dvi} uses
      @var{giftopnm}, @var{pnmscale}, @var{pnmnlfilt}, @var{ppmquant},
      and @var{ppmtogif}.  These utilities can be obtained from
      @href{@code{
         <ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.tar.gz>},,,
          ftp://ftp.x.org/contrib/utilities/netpbm-1mar1994.tar.gz}.

  
@item bm2font
      @var{bm2font} converts a bitmap images (including ``@code{.gif}''
      images) to a font that can be used in a @TeX{} document.
      @var{bm2font} can be obtained from
      @href{@code{<ftp://ftp.shsu.edu/tex-archive/graphics/bm2font.tar.gz>},,,
                   ftp://ftp.shsu.edu/tex-archive/graphics/bm2font.tar.gz}.
@end table

@comment **************************************************** CHAPTER
@node Known Bugs
@chapter Known Bugs

@enumerate

@item The @href{@code{@@center},titlefont center sp,texinfo} command
      doesn't work since HTML doesn't support centering yet. 

@item The @href{@code{@@noindent},noindent,texinfo} and
      @href{@code{@@exdent},exdent,texinfo} commands don't work since
      HTML doesn't include any facility to control indentation.

@item Mark specifications in the @href{@code{@@itemize},itemize,texinfo}
      command are ignored since HTML doesn't include any facility to
      specify the tag in itemized lists.

@item The @href{emacs texinfo files need to be tweaked,
                problems with emacs} to work with @var{texi2www}.

@item One @href{@code{@@gif},gif} command is allowed per line.

@end enumerate

@unnumberedsec Fixed Bugs

@enumerate 

@item Previous versions didn't handle nested tables correctly.  The
      @@item following an inner @@table would be drawn in the wrong
      font.  @var{(tsingle, Jan 2 1996)}
   
@item Previous versions didn't capitalize
      @href{@code{@@sc@{@}},Smallcaps,texinfo} text.  (There's still
      the problem of HTML not supporting true smallcaps, however).
      @var{(tsingle, Sep 6 1995)}

@item Previous versions of @var{texi2www} didn't correctly index
      @href{@code{@@ftable} and @code{@@vtable},ftable vtable,texinfo}
      items; this bug has been fixed! @var{(tsingle, Aug 17 1995)}

@end enumerate

@node problems with emacs
@section emacs.texi @result{} HTML problems

The file @var{man/commands.texi} distributed with GNU Emacs version
version 19.25 contains, near the top of the file:

@example
@@c See file emacs.texi for copying conditions.
@@iftex
@@chapter Characters, Keys and Commands

  This chapter explains the character set used by Emacs for input commands
and for the contents of files, and also explains the concepts of
@@dfn@{keys@} and @@dfn@{commands@} which are necessary for understanding how
your keyboard input is understood by Emacs.
@@end iftex
@@node User Input, Keys, Screen, Top
@@section Keyboard Input
@end example

Texi2www doesn't see the @@chapter since it's inside an @@iftex block;
this confuses texi2www's chapter numbering.  My fix was to change this
section to:

@example
@@c See file emacs.texi for copying conditions.
@@node User Input, Keys, Screen, Top
@@chapter Characters, Keys and Commands
@@iftex

  This chapter explains the character set used by Emacs for input commands
and for the contents of files, and also explains the concepts of
@@dfn@{keys@} and @@dfn@{commands@} which are necessary for understanding how
your keyboard input is understood by Emacs.
@@end iftex
@@section Keyboard Input
@end example

@var{killing.texi}, @var{misc.texi}, and @var{trouble.texi} have similar
problems.

@comment **************************************************** CHAPTER
@node Demo
@appendix Sample output

This document itself is a pretty good example of what texi2www supports
and produces.  Following are some examples to really make things clear;
to fully appreciate these examples compare the source and printed output
to your html viewer.

@menu
* Fonts::  @@var@{@}, etc.
* Glyphs:: @@result@{@}, etc.
* Blocks:: @@example ... @@end example, etc.
* Tables and Lists:: @@table .. @@end table, etc.
@end menu

@comment **************************************************** SECTION
@node Fonts
@unnumberedsec Text markup

Texi2www supports:

@table @asis

@item @@b@{@var{bold text}@} @result{} @b{bold text}
Here is @b{some text} in the @@b font.

@item @@cite@{@var{reference}@} @result{} @cite{reference}
Indicate the name of a book.
Here is @cite{some text} in the @@cite font.

@item @@code@{@var{sample-code}@} @result{} @code{sample-code}
Indicate text that is a literal example of a piece of a program.
Here is @code{some text} in the @@code font.

@item @@dfn@{@var{term}@} @result{} @dfn{term}
Indicate the introductory or defining use of a term.
Here is @dfn{some text} in the @@dfn font.

@item @@dmn@{@var{text}@} @result{} @dmn{text}
Here is @dmn{some text} in the @@dmn font.

@item @@emph@{@var{text}@} @result{} @emph{text}
Here is @emph{some text} in the @@emph font.

@item @@file@{@var{file-name}@} @result{} @file{file-name}
Indicate the name of a file.
Here is @file{some text} in the @@file font.

@item @@i@{@var{italic text}@} @result{} @i{italic text}
Here is @i{some text} in the @@i font.

@item @@kbd@{@var{keyboard-characters}@} @result{} @kbd{keyboard-characters}
Indicate keyboard input.
Here is @kbd{some text} in the @@kbd font.

@item @@key@{@var{key-name}@} @result{} @key{key-name}
Indicate the conventional name for a key on a keyboard.
Here is @key{some text} in the @@key font.

@item @@math@{@var{ax^2+b}@} @result{} @math{ax^2+b}
Here is @r{some text} in the @@math font.

@item @@r@{@var{roman font text}@} @result{} @r{roman font text}
Here is @r{some text} in the @@r font.

@item @@samp@{@var{text}@} @result{} @samp{text}
Indicate text that is a literal example of a sequence of characters.
Here is @samp{some text} in the @@samp font.

@item @@sc@{@var{text}@} @result{} @sc{text}
Here is @sc{some text} in the @@sc font.

@item @@strong@{@var{text}@} @result{} @strong{text}
Here is @strong{some text} in the @@strong font.

@item @@t@{@var{fixed-width text}@} @result{} @t{fixed-width text}
Here is @t{some text} in the @@t font.

@item @@titlefont@{@var{text}@} @result{} @titlefont{text}
Here is @titlefont{some text} in the @@titlefont font.

@item @@var@{@var{metasyntactic-variable}@} @result{} @var{metasyntactic-variable}
Indicate a metasyntactic variable.
Here is @var{some text} in the @@var font.

@end table


@comment **************************************************** SECTION
@node Glyphs
@unnumberedsec Glyphs

@table @asis

@item @@TeX@{@}       @result{} @TeX{}
@item @@bullet@{@}    @result{} @bullet{}
@item @@copyright@{@} @result{} @copyright{}
@item @@dots@{@}      @result{} @dots{}
@item @@equiv@{@}     @result{} @equiv{}
@item @@error@{@}     @result{} @error{}
@item @@expansion@{@} @result{} @expansion{}
@item @@minus@{@}     @result{} @minus{}
@item @@point@{@}     @result{} @point{}
@item @@print@{@}     @result{} @print{}
@item @@result@{@}    @result{} @result{}
@item @@today@{@}     @result{} @today{}

@end table

@comment **************************************************** SECTION
@node Blocks
@unnumberedsec Blocks

@example
@cartouche
@@example
@@cartouche
Here's two lines
of text
@@end cartouche
@@end example
@end cartouche
@end example

@display
@@display
Here's two lines
of text
@@end display
@end display

@example
@@example
Here's two lines
of text
@@end example
@end example

@format
@@format
Here's two lines
of text
@@end format
@end format

@lisp
@@lisp
Here's two lines
of text
@@end lisp
@end lisp

@quotation
@@quotation
Here's two lines
of text
@@end quotation
@end quotation

@smallexample
@@smallexample
Here's two lines
of text
@@end smallexample
@end smallexample

@comment **************************************************** SECTION
@node Tables and Lists
@unnumberedsec Tables and Lists

@example
@@table @@code
@@item code-one
@@table @@var
@@item var-one
@@table @@samp
@@item samp-one
Hmmm.
@@item samp-two
Mmmmh.
@@end table
@@item var-two
Huh?
@@end table
@@item code-two
Duh?
@@end table
@end example

@table @code
@item code-one
@table @var
@item var-one
@table @samp
@item samp-one
Hmmm.
@item samp-two
Mmmmh.
@end table
@item var-two
Huh?
@end table
@item code-two
Duh?
@end table


@comment **************************************************** CHAPTER
@node texi2dvi
@appendix texi2dvi & texinfo.tex

Versions of ``@code{texi2dvi}'' and ``@code{texinfo.tex}'' are included
with this package.  These are compatible with the
@href{texi2www extensions,Extensions}.

@appendixsec texi2dvi

@appendixsec texinfo.tex

``@code{texinfo.tex}'' is a @TeX{} macro used during the @var{texinfo}
@result{} @var{dvi} conversion.  




@comment **************************************************** CHAPTER
@node Index
@unnumbered Index
@printindex cp

@contents
@bye