hxindex - Online in der Cloud

PROGRAMM:

NAME/FUNKTION

hxindex - einen Index in ein HTML-Dokument einfügen

ZUSAMMENFASSUNG

hxindex [ -t ] [ -x ] [ -n ] [ -f ] [ -r ] [ -c Unterricht ] [ -b Base ] [ -i indexdb ] [ -s
Vorlage ] [ -u Ausdruck ] [--] [ Datei-oder-URL ]

BESCHREIBUNG

Das hxindex sucht nach Begriffen, die in einem Dokument indiziert werden sollen, sammelt sie, wandelt sie in
target Anker und erstellt einen sortierten Index als HTML-Liste, der an der Stelle eingefügt wird
eines Platzhalters im Dokument. Das resultierende Dokument wird in die Standardausgabe geschrieben.

Der Index wird an der Stelle eines Kommentars des Formulars eingefügt



oder zwischen zwei Kommentaren des Formulars


...


Im letzteren Fall werden zuerst alle vorhandenen Inhalte zwischen den beiden Kommentaren entfernt.

Indexbegriffe sind entweder Elemente vom Typ oder Elemente mit einem Klassenattribut von
"Index". (Aus Gründen der Abwärtskompatibilität auch Klassenattribute "index-inst" und "index-def"
sind erkannt.) Elemente (und Klasse "index-def") gelten als wichtiger als
Elemente mit Klasse "Index" und wird im generierten Index fett angezeigt.

Die Option -c fügt zusätzliche Klassen hinzu, die Aliase für . sind "Index".

Standardmäßig wird der Inhalt des Elements als Indexbegriff verwendet. Hier sind zwei
Beispiele für Vorkommen des Indexbegriffs "Schuh":

Ein Schuh ist ein Kleidungsstück, das...
durch einen Lederschuh abgeschlossen ...

Wenn der zu indizierende Begriff nicht mit dem Inhalt des Elements übereinstimmt, wird der Titel Attribut
kann verwendet werden, um den richtigen Begriff zu geben:

... Schuhe sind Kleidungsstücke, die...
... mit zwei Lederschuhen ...

Das Titel Das Attribut muss auch verwendet werden, wenn der Indexbegriff ein Unterbegriff eines anderen ist.
Unterbegriffe erscheinen im Index eingerückt unter ihrem Hauptbegriff. Um einen Unterterm zu definieren, verwenden Sie a
Titel Attribut mit zwei Ausrufezeichen ("!!") zwischen dem Begriff und dem Unterbegriff, wie
Dies:

...
...
...

Wie das letzte Beispiel oben zeigt, kann es mehrere Ebenen von Unterbegriffen geben.

Das Titel -Attribut ermöglicht auch die Verknüpfung mehrerer Indexbegriffe mit einem einzigen
Auftreten. Die mehreren Begriffe werden durch einen vertikalen Strich ("|") getrennt. Vergleich die
folgende Beispiele mit den obigen:

...
...

Diese beiden Elemente fügen beide zwei Begriffe in den Index ein. Beachten Sie, dass das zweite Beispiel
oben kombiniert Unterbegriffe und mehrere Begriffe.

Es ist möglich, einen Index für eine Datei auszuführen, die bereits über einen Index verfügt. Die alten Zielanker
und der alte Index wird entfernt, bevor er neu generiert wird.

OPTIONAL

Die folgenden Optionen werden unterstützt:

-t Standardmäßig hxindex fügt dem Element, das die enthält, ein ID-Attribut hinzu
Auftreten eines Begriffs und ebenfalls fügt ein Element darin mit a Name
Attribut gleich der ID. Dies dient dazu, alte Browser zuzulassen, die die ID ignorieren
Attribute wie Netscape 4, um das Ziel ebenfalls zu finden. Die -t ganz ohne irgendetwas tun oder drücken zu müssen.
unterdrückt die Element.

-x Diese Option aktiviert die XML-Syntaxkonventionen: leere Elemente enden in />
statt > wie bei HTML. -x impliziert -T.

-i indexdb
hxindex kann einen anfänglichen Index aus einer Datei lesen und die zusammengeführte Sammlung von schreiben
Indexbegriffe zurück in diese Datei. Dadurch kann ein Index mehrere Dokumente umfassen.
Das -i Option wird verwendet, um den Namen der Datei anzugeben, die den Index enthält.

-b Base Diese Option ist nützlich in Kombination mit -i um die Basis-URL-Referenz von . anzugeben
das Dokument. Standardmäßig, hxindex speichert Links zu Vorkommnissen in der indexdb
Datei im Formular #Anker, aber wenn -b gegeben ist, sehen die Links so aus
Basis#Anker stattdessen.

Bei Verwendung in Kombination mit -n, enthalten die Titelattribute der Links
der Titel des Dokuments, das den Begriff enthält. Der Titel wird vor eingefügt
Vorlage (siehe Option -s) und durch Komma und Leerzeichen davon getrennt.
ZB wenn hxindex heißt mit

hxindex -i termdb -n -base meinedatei.html meinedatei.html

und die termdb enthält bereits einen Eintrag für "foo" in Abschnitt "3.1" von a
Dokument namens "file2.html" mit dem Titel "The foos", dann der generierte Index
enthält einen Eintrag wie diesen:

foo,
title="Die Foos, Abschnitt 3.1">3.1

-c Klasse[,Klasse[,...]]
Normale Indexbegriffe werden erkannt, weil sie eine Klasse von . haben "Index". Das -c
Option fügt zusätzliche, durch Kommas getrennte Klassennamen hinzu, die berücksichtigt werden
Aliase für "Index". Z.B, -c Instanz werde dafür sorgen, dass <Span
class="Instanz">Begriff wird als Begriff für den Index anerkannt.

-n Standardmäßig besteht der Index aus Links mit "#" als Ankertext. Möglichkeit -n
bewirkt, dass der Linktext aus den Abschnittsnummern der Abschnitte besteht, in denen
die Begriffe kommen vor, fallen auf "ohne Nummer" zurück (siehe Option -u unten) wenn nein
Abschnittsnummer gefunden werden konnte. Abschnittsnummern finden Sie, indem Sie nach dem suchen
nächste vorangehende Start-Tag mit einer Klasse von "secno" oder "no-num". Im Falle des
"secno", der Inhalt dieses Elements wird als Abschnittsnummer verwendet. In dem
Bei "no-num" wird davon ausgegangen, dass der Abschnitt keine Nummer hat und hxindex wird gedruckt
"ohne Nummer" statt. Diese Klassen werden auch verwendet von hxnum(1), also ist es
nützlich zu laufen hxindex nachdem hxnum, z.B,

hxnum myfile.html | hxindex -n >meineneueDatei.html

-s Vorlage
Wenn Option -n verwendet wird, hat der Link ein Titelattribut und die Vorlage
bestimmt, was darin enthalten ist. Die Vorgabe ist "Abschnitt %s", wobei %s a . ist
Platzhalter für die Abschnittsnummer. Mit anderen Worten, der Index enthält
Einträge wie diese:

Begriff, 7.8

Einige Beispiele:

hxindex -n -s 'Kapitel %s'
hxindex -n -s 'Teil %s'
hxindex -n -s 'hoofdstuk %s' -u 'zonder nummer'

Diese Option ist nur sinnvoll in Kombination mit -n

-u Ausdruck Wenn Option -n wird verwendet, um Abschnittsnummern anzuzeigen, Referenzen, für die no
Abschnittsnummer kann gefunden werden werden angezeigt als Ausdruck stattdessen. Der Standardwert ist "??".

Diese Option ist nur sinnvoll in Kombination mit -n

-f Entfernen Titel Attribute, die sowohl für den Index als auch für die Kommentare verwendet wurden
die den eingefügten Index begrenzen. Dadurch wird vermieden, dass Browser diese anzeigen
Attribute. Beachten Sie, dass hxindex kann nicht erneut auf einem eigenen Ausgang ausgeführt werden, wenn dies
Option verwendet wird. (Mnemonik: "freeze" oder "fendgültig".)

-r Ignorieren Sie nachfolgende Satzzeichen beim Sortieren von Indexbegriffen nicht. ZB wenn zwei Terme
sind geschrieben als

foo, ... foo

hxindex ignoriert normalerweise das Komma und behandelt sie als denselben Begriff, jedoch mit
-R, sie werden als unterschiedlich behandelt. Dies betrifft nachgestellte Kommas (,), Semikolons
(;), Doppelpunkte (:), Ausrufezeichen (!), Fragezeichen (?) und Punkte (.).
Ein abschließender Punkt wird nie ignoriert, wenn der Begriff zwei oder mehr enthält, um
Abkürzungen ("BC") und Auslassungszeichen ("mehr...") schützen. Das macht nicht beeinflussen
wie der Indexbegriff gedruckt wird (er wird immer so gedruckt, wie er im Text erscheint),
nur wie es mit ähnlichen Begriffen verglichen wird. (Mnemonik: "räh".)

OPERANDEN

Der folgende Operand wird unterstützt:

Datei-oder-URL
Der Name einer HTML- oder XML-Datei oder deren URL. Falls abwesend oder die Datei ist
"-", stattdessen wird die Standardeingabe gelesen.

EXIT STATUS

Die folgenden Exit-Werte werden zurückgegeben:

0 Erfolgreiche Fertigstellung.

>0 Beim Parsen der HTML-Datei ist ein Fehler aufgetreten.

Es wird davon ausgegangen, dass die Eingabe in UTF-8 erfolgt, aber das aktuelle Gebietsschema wird verwendet, um die
Sortierreihenfolge der Indexbegriffe. Dh, hxindex schaut auf die LANG, LC_ALL und/oder
LC_COLLATE-Umgebungsvariablen. Sehen lokal(1).

Um einen Proxy zum Abrufen von Remotedateien zu verwenden, legen Sie die Umgebungsvariablen fest HTTP-Proxy or
ftp_proxy. Z.B, http_proxy="http://localhost:8080/"

Verwenden Sie hxindex online mit den onworks.net-Diensten