noweave - Online in der Cloud

PROGRAMM:

NAME/FUNKTION

notangle, noweave, nountangle - noweb, ein Programmierwerkzeug für Alphabetisierung

ZUSAMMENFASSUNG

kein Winkel [-RStammname ...] [-Filter Befehl] [-L[Format]] [Datei] ...
Nicht-Winkel [-ml|-m3|-c|-c++|-Ach|-tex|-f77|-f90|-lispeln|-matlab] [-RStammname ...] [-Filter
Befehl] [-wBreite] [Datei] ...
jetzt [Optionen] [Datei] ...

BESCHREIBUNG

Noweb ist ein Programmierwerkzeug wie das von Knuth NETZ, nur einfacher. EIN noweb Datei
enthält Programmquellcode, der mit Dokumentation verschachtelt ist. Wann kein Winkel kann man
noweb Datei, schreibt es das Programm auf die Standardausgabe. Wann jetzt kann man noweb Datei,
es liest die noweb Quelle und produziert auf Standardausgabe, Latex, TeX, troff oder HTML
Quelle für Schriftsatzdokumentation. Nicht-Winkel wandelt ein gebildetes Programm in ein gewöhnliches um
Programm, indem Sie verschachtelte Dokumentation in Kommentare umwandeln. Der Dateiname `-' bezieht sich auf
Standardeingabe.

FORMAT OF JETZT WEB DATEIEN

A noweb Datei ist eine Folge von Stücke, die in beliebiger Reihenfolge erscheinen können. Ein Stück kann enthalten
Code oder Dokumentation. Dokumentationsblöcke beginnen mit einer Zeile, die mit einem at-Zeichen beginnt
(@) gefolgt von einem Leerzeichen oder Zeilenumbruch. Sie haben keine Namen. Codeblöcke beginnen mit
<<Brocken Name>> =
auf einer Linie für sich. Die doppelte linke spitze Klammer (<<) muss in der ersten Spalte stehen.
Chunks werden am Anfang eines anderen Chunks oder am Ende der Datei beendet. Wenn das erste
Zeile in der Datei markiert nicht den Anfang eines Chunks, es wird angenommen, dass es die erste ist
Zeile eines Dokumentationsblocks.

Dokumentationsblöcke enthalten Text, der von . ignoriert wird kein Winkel und wörtlich kopiert nach
Standardausgabe von jetzt (mit Ausnahme des angegebenen Codes). jetzt kann damit arbeiten Latex, einfach
TeX, troff or HTML. Mit schlichtem TeX, fügt es eine Referenz auf a . ein TeX Makropaket, nwmac,
das definiert Befehle wie \Kapitel und \Sektion.

Code-Chunks enthalten Programmquellcode und Verweise auf andere Code-Chunks. Mehrere Codes
Chunks können denselben Namen haben; kein Winkel verkettet ihre Definitionen zu einem einzigen
stück, genauso wie Wirrwarr(1). Code-Chunk-Definitionen sind wie Makrodefinitionen;
kein Winkel extrahiert ein Programm durch Erweitern eines Chunks (standardmäßig wird der Chunk namens <<*>>).
Die Definition dieses Chunks enthält Verweise auf andere Chunks, die selbst sind
erweitert und so weiter. kein Winkel's Ausgabe ist lesbar; es behält die Einrückung von
erweiterte Chunks in Bezug auf die Chunks, in denen sie erscheinen.

Code kann innerhalb von Dokumentationsblöcken zitiert werden, indem doppelte eckige Klammern ([[...]])
um es herum. Diese doppelten eckigen Klammern werden ignoriert von nichtwinkel, aber sie können verwendet werden von
jetzt um dem Code eine besondere typografische Behandlung zu geben, zB Hypertext-Links. Wenn zitiert
Code endet mit drei oder mehr eckigen Klammern, jetzt wählt das am weitesten rechts stehende Paar, so dass
zum Beispiel, [[ein[i]]] richtig geparst wird. Die Namen von Code-Chunks können innerhalb von . erscheinen
zitierter Code, es sei denn, dieser zitierte Code ist selbst Teil des Namens eines Code-Chunks.

Im Code behandelt noweb ungepaarte doppelte linke oder rechte spitze Klammern als Literal << und >>.
Um zu erzwingen, dass solche Klammern, auch gepaarte Klammern oder Klammern in der Dokumentation,
als wörtlich behandelt, verwenden Sie ein vorangestelltes at-Zeichen (zB @<).

Einige Programmier- oder Formatierungssprachen erfordern möglicherweise eine einzelne @ in der ersten Spalte unterschreiben.
Noweb-Benutzer können diesen Effekt erzielen, indem sie eine doppelte @@ in der ersten Spalte; in diesem
nur Position, es steht für eine einzelne @ Schild.

VERWIRRUNG

kein Winkel und Nicht-Winkel akzeptieren die gleichen Optionen, obwohl einige Optionen Auswirkungen haben
nur auf dem einen oder anderen. Die Optionen sind:

-RName Erweitern Sie die <<Name>> Code-Stück. Die -R Option kann wiederholt werden, in diesem Fall jede
Chunk wird in die Ausgabe geschrieben. Wenn nein -R Option gegeben ist, erweitere den Chunk namens
<<*>>.

-LFormat
Geben Sie Zeilennummernanzeigen an Blockgrenzen aus. Eine Zeilennummernanzeige
identifiziert die Quelle der darauf folgenden Zeile. In Format, %F zeigt die
Name der Quelldatei, %L gibt die Zeilennummer der Quelldatei an, %N
zeigt einen Zeilenumbruch an, und %% zeigt ein Prozentzeichen an. Ein Vorzeichen und eine Ziffer können sein
zwischen dem Prozentzeichen und dem ` . eingefügtL', in diesem Fall wird die Zeilennummer
um diesen Betrag angepasst werden. Wenn Format weggelassen wird, ist das Standardformat das
vom C-Präprozessor akzeptiert: `#Leitung %L "%F"%N'. Bei Verwendung des -LFormat Option,
kein Winkel stellt sicher, dass der gesamte Text bei Eingabe und Ausgabe in derselben Spalte angezeigt wird.
Nicht-Winkel ignoriert diese Option.

Zu den gängigen Formatzeichenfolgen gehören:
C -L'#line %L "%F"%N'
Sonne FORTRAN -L'\# %L "%F"%N'
Icon -L'#line %-1L "%F"%N'
Modula-xnumx -L'<*LINE %L "%F" *>%N'
SML / NJ -L'(*#Zeile %L "%F"*)'

Um das umgekehrte Problem zu lösen, also noweb dazu zu bringen, etwas Vernünftiges damit zu tun
#Leitung in seiner Eingabe finden Sie die scharfe Linie Filter im Beispielverzeichnis.

-tk Kopieren Sie unberührte Tabs von der Eingabe in die Ausgabe und verwenden Sie Tabs zum Einrücken, vorausgesetzt
stoppt jeden k Säulen. Standardmäßig werden Tabs alle 8 Zoll auf Leerzeichen mit Stopps erweitert
Säulen.

-Filter cmd
Filtern Sie die noweb Quelle durch cmd nach der Konvertierung in Werkzeugform und davor
verheddern. kein Winkel schaut nach cmd zuerst auf die des Benutzers PATH, dann in /usr/lib/noweb.
Solche Filter können verwendet werden, um Funktionen hinzuzufügen kein Winkel; für ein Beispiel siehe
/usr/lib/noweb/emptydefn. Nur für Experten.

-Markup Parser
Nutzen Sie Parser um die Eingabedatei zu parsen. Ermöglicht die Verwendung von noweb-Tools für Dateien in anderen
Formate; zum Beispiel die Nummernmarkup Parser versteht nuweb(1) Format. Sehen
nowebfilter(7) für weitere Informationen. Nur für Experten.

-Ach | -c | -icn | -Symbol | -ml | -m3 | -paskal | -f77 | -f90 | -tex
Wann Nicht-Winkel wandelt Dokumentationsblöcke in Kommentare um, verwenden Sie den Kommentar
Format der genannten Sprache. -c ist die Vorgabe. kein Winkel ignoriert diese Optionen.

-wn Wann Nicht-Winkel wandelt Dokumentationsblöcke in Kommentare um, erstellt Kommentare zu
Linien der Breite n. kein Winkel ignoriert diese Option.

WEBEREI

Ausgabe von jetzt kann verwendet werden in TeX dokumentiert das \Eingang nwmac, in Latex Unterlagen
die verwenden die noweb Paket (siehe nowebstyle(1)), und in HTML Dokumente zum Durchsuchen
Mosaik(1). Jetzt behandelt Code-Chunks etwas wie Latex Liste Umgebungen. Wenn das ``@
'', das einen Code-Chunk beendet, wird unmittelbar von Text gefolgt, dieser Text folgt dem
Codeblock ohne Absatzumbruch. Wenn der Rest der Zeile leer ist, jetzt setzt TeX
in den ``vertikalen Modus'' und späterer Text beginnt einen neuen, eingerückten Absatz.

Es treten keine Seitenumbrüche in der Mitte von Codeblöcken auf, es sei denn, dies ist erforderlich, um eine Überfüllung zu vermeiden
vbox. Der Dokumentationsblock, der einem Codeblock unmittelbar vorangeht, wird auf derselben Seite angezeigt
als dieser Code-Chunk, es sei denn, dies würde gegen die vorherige Regel verstoßen.

Jetzt fügt keine zusätzlichen Zeilenumbrüche in seine . ein TeX ausgegeben, also die Zeilennummern in TeX
Fehlermeldungen sind die gleichen wie in der Eingabedatei.

jetzt hat Optionen, die die Wahl des Formatierers diktieren und unterschiedliche Formatierungen unterstützen
Redewendungen und Werkzeuge. Grundlegende Optionen werden hier beschrieben; Optionen in Bezug auf Index und Cross-
Referenzinformationen werden im Abschnitt INDEXIERUNG UND QUERVERWEIS beschrieben.

-Latex LaTeX ausgeben, einschließlich Wrapper in Artikel Stil mit dem noweb Paket und Seite
Stil. (Standard)

-tex Emittieren Sie reines TeX, einschließlich Wrapper mit nwmac Makros.

-html Geben Sie HTML aus, indem Sie den HTML-Wrapper verwenden. Die Ausgabe ist uninteressant ohne -Index or -x.
Die Tags und , in eigenen Zeilen, erstellen Sie eine Liste von
Chunks und einen Index von Bezeichnern. Wenn diese Tags nicht vorhanden sind,
Liste und Index werden am Ende der Datei platziert.

-latex+html
Angenommen, Dokumentations-Chunks sind LaTeX, aber generieren Sie HTML für Code-Chunks, geeignet
markiert so Konvertierung mit latex2html(1) ergibt eine vernünftige Ausgabe. Ein LaTeX-Wrapper
ist impliziert, kann aber mit ausgeschaltet werden -n. Nutzen Sie of fehlen uns die Worte. ganz ohne irgendetwas tun oder drücken zu müssen. is veraltet; -
-html mit -Filter 2h stattdessen.

-troff Emittieren troff(1) Markup (ohne Wrapper). Das Ergebnis sollte mit verarbeitet werden
noroff(1). Fehlerberichte für -troff zu Aharon Robbins <[E-Mail geschützt] >.

-n Verwenden Sie keinen Wrapper (Header oder Trailer). Diese Option ist nützlich, wenn jetzt's
Die Ausgabe ist Teil eines größeren Dokuments. Siehe auch -verzögern.

-Filter cmd
Filtert die noweb Quelle durch cmd nach der Konvertierung in Werkzeugform und davor
umwandeln in TeX. jetzt schaut nach cmd zuerst auf die des Benutzers PFAD, dann in
/usr/lib/noweb. Solche Filter können verwendet werden, um Funktionen hinzuzufügen jetzt; für ein
Beispiel siehe /usr/lib/noweb/noxref.krom. Jetzt unterstützt bis zu vier Filter; einer
kann zum Beispiel durch Muscheltricks mehr bekommen, -Filter "icon.filter | noidx"dem „Vermischten Geschmack“. Seine
-autodefs, -x, -Index und -indexvon Optionen sind als Filter implementiert. Filter
werden mit der Shell ausgeführt eval Befehl, also cmd sollte entsprechend zitiert werden.

-Markup Parser
Nutzen Sie Parser um die Eingabedatei zu parsen. Ermöglicht die Verwendung von noweb-Tools für Dateien in anderen
Formate; zum Beispiel die Nummernmarkup Parser versteht nuweb(1) Format. Sehen
nowebfilter(7) für weitere Informationen. Nur für Experten.

-Möglichkeit wählen
Fügt \noweboptions{wählen} zu den Latex Header. Sehen nowebstyle(1) für Werte von opt.
Normalerweise nur mit dem -Latex Option, aber -Möglichkeit lange xref funktioniert schwarze Magie
mit -html.

-verzögern Standardmäßig jetzt fügt Dateiname und andere Informationen in die Ausgabe vor dem
ersten Programmteil. -verzögern verzögert diese Information bis nach der ersten
Dokumentationsblock, der sich ein bisschen wie der WEB ``Limbo.'' Die Option ist
Wird normalerweise verwendet, um es einem Benutzer zu ermöglichen, ein spezialisiertes Latex \documentclass Befehl
und anderes Präambelmaterial im ersten Dokumentationsblock (d. h., bevor die
erstes Anzeichen). Diese Option erzwingt auch nachfolgende Querverweisinformationen zu
direkt vor dem letzten Abschnitt ausgegeben werden, anstatt am Ende des Dokuments; das
der letzte Teil wird voraussichtlich enthalten \end{Dokument}. Die -verzögern Option impliziert die
-n .

-tk Erweitern Sie Tabs mit Stopps alle k Säulen. (Standardmäßig wird alle 8 Spalten erweitert.)

-t Kopieren Sie Registerkarten in die Ausgabe.

-v Drucken Sie die Pipeline- und RCS-Informationen bei Standardfehlern.

INDIZIERUNG UND QUERVERWEIS

Bei Verwendung mit Latex, troff oder HTML, jetzt kann Indexierung und Querverweise bereitstellen
Informationen für Chunks und für Programmiersprachenbezeichner. Bezeichnerdefinitionen
kann von Hand mit Backticks (`) markiert werden; das -Filter btdefn Option erkennt diese
Markierungen. Bei einigen Sprachen werden Definitionen möglicherweise automatisch mithilfe der -autodefs
Möglichkeit. In diesem Abschnitt werden die Indizierungs- und Querverweisoptionen beschrieben; es könnte gut sein
beim ersten Lesen übersprungen.

-x Für Latex, füge jedem Chunk-Namen eine Seitenzahl hinzu, die den Speicherort dieses Namens identifiziert
Chunk-Definition und geben Querverweisinformationen zu Definitionen aus und
Verwendet. Zum HTML, Erstellen Sie Hypertext-Links zwischen Verwendungen und Definitionen von Chunks.
Wann jetzt -x wird verwendet mit Latex, der Kontrollablauf \nowebchunks erweitert zu a
sortierte Liste aller Code-Chunks.

-Index Erstellen Sie Querverweisinformationen (oder Hypertext-Links) für definierte Bezeichner.
Definitionen finden sich in den Eingabedateien von -autodefs Sprache oder von
-Filterbtdefn. Erfordert Latex or HTML. -Index impliziert -X; einschließlich beider wird
eine seltsam aussehende Ausgabe erzeugen. jetzt erzeugt keine Querverweise auf
Bezeichner, die in Anführungszeichen erscheinen (@[[...@]]), aber es erzeugt Hypertext
Links. Wann jetzt -Index wird verwendet mit Latex, der Kontrollablauf \nowebindex
wird zu einem Index von Bezeichnern erweitert.

-indexvon Index
Like -Index, aber die zu indexierenden Identifikatoren werden aus der Datei entnommen Index. Sehen
noindex(1).

-autodefs lang
Bezeichnerdefinitionen automatisch erkennen. Code in Blöcken muss in Sprache sein
lang. Zulässig langs variieren, können aber enthalten tex or klicken. Ohne nutzlos -Index,
denen es vorausgehen muss.

-autodefs anzeigen
Werte von anzeigen lang verwendbar mit -autodefs.

ERROR MITTEILUNGEN

If kein Winkel or jetzt auf einen Chunk-Namen in der Dokumentation stößt, wird davon ausgegangen, dass dies
weist auf einen Fehler hin, normalerweise falsch geschrieben ``< >=''. Andere Fehlermeldungen sollten sein
selbsterklärend.

Es ist falsch, auf einen Chunk zu verweisen, der nie definiert wurde, aber es ist in Ordnung, dass Chunks
definiert und nicht verwendet.

Beispiele:

Wenn Sie Schwierigkeiten haben, diese Manpage zu verdauen, sind Sie nicht allein. Hier sind ein paar Beispiele für
lass dich loslegen. Ich gehe davon aus, dass du eine hast foo.nw Datei mit einem C-Programm im Chunk < >
und eine Header-Datei in Chunk < >, und dass Ihre Dokumentation mit gekennzeichnet ist
Latex(1). Ich zeige Ihnen, wie Sie Dinge mit den gängigsten Optionen erstellen.

Um Ihren C-Quellcode neu zu erstellen, versuchen Sie
kein Winkel -L -Rfoo.c foo.nw > foo.c
Um Ihre Header-Datei neu zu erstellen, versuchen Sie
kein Winkel -Rfoo.h foo.nw | cpif foo.h
Hier gibt es zwei Kompromisse. Weglassen -L hält #Leitung aus Ihrer Header-Datei und
mit automatisierten cpif verhindert das Umschreiben des Befehls foo.h es sei denn, der Inhalt hat sich geändert.
Daher ist dies ein guter Code, um eine Makefile-Regel einzufügen.

Um ein gedrucktes Dokument zu erstellen, führen Sie
jetzt -autodefs c -Index foo.nw > foo.tex
Wenn Sie eine eigene Präambel haben, die . enthält \documentclass und alles, du brauchst auch die
-verzögern .

Um eine Webseite zu erstellen, führen Sie
jetzt -Filter 2h -autodefs c -Index -html foo.nw | htmltoc > foo.html
Viel Spaß!

Verwenden Sie noweave online mit den onworks.net-Diensten