NOWEB(7) NOWEB(7) NNAAMMEE nowebstyle - _L_a_T_e_X package for _n_o_w_e_b SSYYNNOOPPSSIISS \\uusseeppaacckkaaggee{{nnoowweebb}} DDEESSCCRRIIPPTTIIOONN When _n_o_w_e_a_v_e generates code for _L_a_T_e_X, the nnoowweebb package is required. In addition to the necessary arcana, it defines a wweebbccooddee environment in which you can place frag- ments of code, and in which only backslash and curly braces have their special meanings; all other characters are taken literally. It also defines a nnoowweebb pagestyle. Finally, it defines a \\nnoowweebbooppttiioonnss{{......}} command that can be used to tinker with the appearance of the output. Options are separated by commas and include: mmaarrggiinnttaagg Put the sub-page number (tag) of each code-chunk definition in the left margin. (Default) nnoommaarrggiinnttaagg Don't use margin tags. sshhiifftt Shift text to the left so that long code lines won't extend off the right-hand side of the page. ssmmaallllccooddee Set code in _L_a_T_e_X \\ssmmaallll font instead of \\nnoorrmmaall-- ssiizzee.. Similar options exist for all the _L_a_T_e_X size-changing commands. lloonnggxxrreeff,, sshhoorrttxxrreeff,, nnooxxrreeff Choose a style for chunk cross-reference. Long style uses small paragraphs after each chunk, as in Knuth. Short style uses symbols on the defini- tion line, as in Hanson. nnooxxrreeff provides no chunk cross-reference. Defaults to sshhoorrttxxrreeff.. aallpphhaassuubbppaaggee,, nnuummssuubbppaaggee,, nnoossuubbppaaggee Number chunks by the number of the page on which they appear, followed by an alphabetic (numeric, not used) ``sub-page'' indicator. Defaults to aallpphhaassuubbppaaggee.. nnoossuubbppaaggee implies nnoommaarrggiinnttaagg.. wweebbnnuummbbeerriinngg Number chunks consecutively, in _W_E_B style, instead of using sub-page numbers. ssuubbssccrriippttiiddeennttss,, nnoossuubbssccrriippttiiddeennttss,, hhyyppeerriiddeennttss,, nnoohhyyppeerrii-- ddeennttss Controls subscripting of identifiers in code, including quoted code. Selecting ssuubbssccrriippttiiddeennttss means an identifier appearing in a code chunk (or in quoted code within a documentation chunk) will be subscripted with the chunk number of its defini- tion. hhyyppeerriiddeennttss means such identifiers will be hyperlinked to their definitions, provided of course that a hypertext package like hhyyppeerrrreeff is loaded. nnoossuubbssccrriippttiiddeennttss and nnoohhyyppeerriiddeennttss are equivalent, and they turn off such markings. The default is hhyyppeerriiddeennttss.. ssuubbssccrriippttqquuootteeddiiddeennttss,, nnoossuubbssccrriippttqquuootteeddiiddeennttss,, hhyyppeerr-- qquuootteeddiiddeennttss,, nnoohhyyppeerrqquuootteeddiiddeennttss Controls linking of identifiers as above, but applies only to uses of identifiers in quoted code. hhiiddeeuunnuusseeddddeeffss Omit defined but unused identifiers from the local identifier cross-reference (Preston Briggs). nnooiiddeennttxxrreeff Omit the local identifier cross-reference which follows each code chunk. eexxtteerrnnaalliinnddeexx Use an index generated with _n_o_i_n_d_e_x_(_1_) (q.v.). lloonnggcchhuunnkkss When expanding \\nnoowweebbcchhuunnkkss,, show page numbers of definitions and uses of each chunk. eenngglliisshh,, ffrreenncchh,, ggeerrmmaann,, ppoorrttuuggeess Write cross-reference information in the language specified. Defaults to eenngglliisshh.. CCOONNTTRROOLL SSEEQQUUEENNCCEESS The noweb package describes a gazillion special control sequences. Only a few are listed here. \\nneexxttcchhuunnkkllaabbeell{{ll}} Associates label ll with the sub-page reference of the next code chunk. Can be used in for concise chunk cross-reference with, e.g., cchhuunnkk~~\\ssuubb-- ppaaggeerreeff{{ll}}. \\nnwwaanncchhoorrttoo{{UURRLL}}{{aanncchhoorr tteexxtt}} Creates a link to the given URL with the given anchor text. Implemented in _l_a_t_e_x_(_1_) using foot- notes, but _s_l_2_h_(_1_) translates this to <>aanncchhoorr tteexxtt<> \\nnwwaanncchhoorrnnaammee{{nnaammee}}{{aanncchhoorr tteexxtt}} Creates an anchor point for a hyperlink. Imple- mented in _l_a_t_e_x_(_1_) using \\llaabbeell ,, but _s_l_2_h_(_1_) translates this to <>aanncchhoorr tteexxtt<> \\iiffhhttmmll ...... \\ffii Text between \\iiffhhttmmll and \\ffii is ignored by _l_a_t_e_x_(_1_)_, but _s_l_2_h_(_1_) and the _l_2_h noweb filter translate the text into HTML. SSEEEE AALLSSOO _n_o_w_e_a_v_e(1), _n_o_w_e_b(1) VVEERRSSIIOONN This man page is from _n_o_w_e_b version 2.10c. AAUUTTHHOORR Norman Ramsey, Harvard University. Internet address nnrr@@eeeeccss..hhaarrvvaarrdd..eedduu. Noweb home page at hhttttpp::////wwwwww..eeeeccss..hhaarrvvaarrdd..eedduu//~~nnrr//nnoowweebb. local 3/28/2001 NOWEB(7)