> For the complete documentation index, see [llms.txt](https://overleaf-pro.ayaka.space/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://overleaf-pro.ayaka.space/latex/de/dokumentstruktur/04-indices.md). # Indizes In einigen großen Dokumenten, zum Beispiel Büchern, ist es üblich, eine alphabetische Liste mit den wichtigsten Begriffen zu erstellen. Mit LaTeX und dem Hilfsprogramm **imakeidx**, kann ein Index recht einfach erzeugt werden. ## Einführung Sehen wir uns ein einfaches funktionierendes Beispiel an. ```latex \documentclass{article} \usepackage[T1]{fontenc} \usepackage{imakeidx} \makeindex \begin{document} \section{Einleitung} In diesem Beispiel werden mehrere Schlüsselwörter\index{keywords} verwendet die wichtig sind und es verdienen, im Index\index{Index} aufzutauchen. Begriffe wie generate\index{generate} und some\index{others} werden ebenfalls erscheinen. \printindex \end{document} ``` [Öffnen Sie dieses Beispiel in Overleaf](https://www.overleaf.com/docs?engine=pdflatex\&snip_name=Index+example\&snip=%5Cdocumentclass%7Barticle%7D%0A%5Cusepackage%5BT1%5D%7Bfontenc%7D%0A%5Cusepackage%7Bimakeidx%7D%0A%5Cmakeindex%0A%0A%5Cbegin%7Bdocument%7D%0A%5Csection%7BIntroduction%7D%0AIn+this+example%2C+several+keywords%5Cindex%7Bkeywords%7D+will+be+used+%0Awhich+are+important+and+deserve+to+appear+in+the+Index%5Cindex%7BIndex%7D.%0A%0ATerms+like+generate%5Cindex%7Bgenerate%7D+and+some%5Cindex%7Bothers%7D+will+%0Aalso+show+up.+%0A%0A%5Cprintindex%0A%5Cend%7Bdocument%7D) Das folgende Bild zeigt die von dem obigen Beispiel erzeugte Ausgabe: ![Index1OLV2.png](/files/f33ce84da14cfb6a150b8ccb59207ab6604542f8) Zunächst wird das Paket mit der Zeile in die Präambel eingebunden ```latex \usepackage{imakeidx} ``` Dann ist der Befehl `\makeindex` für die Funktion des Index erforderlich und kann einige Parameter zur Anpassung seines Erscheinungsbilds übernehmen; in den nächsten Abschnitten wird das klar werden. Um einen Eintrag zum Index hinzuzufügen, wird der Befehl `\index{}` verwendet, wobei das hinzuzufügende Wort als Parameter eingefügt wird. Vorsicht, das Wort wird an der aktuellen Position nicht ausgegeben, sondern nur im Index. Schließlich wird der Befehl `\printindex` den Index tatsächlich setzen. Wenn Sie eine spezielle Lokalisierung mithilfe des `babel` Pakets verwenden, wird der Titel entsprechend übersetzt. Hinweis: Anstelle von `imakeidx`, kann das Paket `makeidx` importiert werden, bietet jedoch weniger Anpassungsmöglichkeiten. ## Indizes auf Overleaf Beim Hinzufügen eines Index zu einem Projekt auf Overleaf ist es **wichtig zu beachten** dass für eine korrekte Kompilierung des Index die Haupt `.tex` datei im Stammverzeichnis des Projekts liegen muss, *außerhalb aller Ordner*. Dadurch wird sichergestellt, dass die zur Erzeugung des Index benötigten Hilfsdateien so zwischengespeichert werden, dass der Compiler auf sie zugreifen kann. ## Einträge und Untereinträge Wie im vorherigen Abschnitt erwähnt, wird der Befehl `\index` das ihm übergebene Wort zum Index hinzufügen, aber das ist nicht die einzige Verwendungsweise. ```latex \documentclass{article} \usepackage[T1]{fontenc} \usepackage{imakeidx} \makeindex \begin{document} \section{Einleitung} In diesem Beispiel werden mehrere Schlüsselwörter\index{keywords} verwendet die wichtig sind und es verdienen, im Index\index{Index} aufzutauchen. Begriffe wie generate\index{generate} und some\index{others} werden auch erscheinen. Begriffe im Index können auch verschachtelt werden \index{Index!nested} \clearpage \section{Zweiter Abschnitt} Dieser zweite Abschnitt\index{section} kann ein spezielles Wort enthalten, und die bereits verwendeten erweitern\index{keywords!used}. \printindex \end{document} ``` [Öffnen Sie dieses Beispiel in Overleaf](https://www.overleaf.com/docs?engine=pdflatex\&snip_name=Index+example+2\&snip=%5Cdocumentclass%7Barticle%7D%0A%5Cusepackage%5BT1%5D%7Bfontenc%7D%0A%5Cusepackage%7Bimakeidx%7D%0A%5Cmakeindex%0A%0A%5Cbegin%7Bdocument%7D%0A%5Csection%7BIntroduction%7D%0AIn+this+example%2C+several+keywords%5Cindex%7Bkeywords%7D+will+be+used+%0Awhich+are+important+and+deserve+to+appear+in+the+Index%5Cindex%7BIndex%7D.%0A%0ATerms+like+generate%5Cindex%7Bgenerate%7D+and+some%5Cindex%7Bothers%7D+will+also+%0Ashow+up.+Terms+in+the+index+can+also+be+nested+%5Cindex%7BIndex%21nested%7D%0A%0A%5Cclearpage%0A%0A%5Csection%7BSecond+section%7D%0AThis+second+section%5Cindex%7Bsection%7D+may+include+some+special+word%2C+%0Aand+expand+the+ones+already+used%5Cindex%7Bkeywords%21used%7D.%0A%0A%5Cprintindex%0A%5Cend%7Bdocument%7D) Das folgende Bild zeigt die von dem obigen Beispiel erzeugte Ausgabe: ![Index2OLV2.png](/files/39d2c38d6f1a4d79135ee71653c25112cf365256) Es ist üblich, Begriffe im Index um spezielle Adjektive zu erweitern. Zum Beispiel kann das Wort *Feld* eine spezielle Bedeutung haben, wenn ihm das Adjektiv *endlich* oder gefolgt von *der Charakteristik 0*, und es kann etwas umständlich sein, verschiedene Arten von *Feld*als separate Einträge im Index hinzuzufügen. Für solche Fälle können Sie ein Ausrufezeichen "!" hinzufügen, das die Begriffe nach diesem Zeichen als Untereinträge des Hauptworts hinzufügt *Feld*. Im Beispiel hat das Wort "Index" das Wort "nested" als Untereintrag. ## Den Index formatieren Einfache Formatierungen für den Index, wie das Ändern des Index-Titels, das Hinzufügen mehrerer Spalten und das Ändern der Spaltenbreite, lassen sich leicht durch Übergabe optionaler Werte an `\makeindex`: ```latex \documentclass{article} \usepackage[T1]{fontenc} \usepackage{imakeidx} \makeindex[columns=3, title=Alphabetical Index] \begin{document} \section{Einleitung} In diesem Beispiel werden mehrere Schlüsselwörter\index{keywords} verwendet, die wichtig sind und es verdienen, im Index\index{Index} aufzutauchen. Begriffe wie generate\index{generate} und some\index{others} werden auch erscheinen. Begriffe im Index können auch verschachtelt werden \index{Index!nested} \clearpage \section{Zweiter Abschnitt} Dieser zweite Abschnitt\index{section} kann ein spezielles Wort enthalten, und die bereits verwendeten erweitern\index{keywords!used}. \printindex \end{document} ``` [Öffnen Sie dieses Beispiel in Overleaf](https://www.overleaf.com/docs?engine=pdflatex\&snip_name=Index+example+3\&snip=%5Cdocumentclass%7Barticle%7D%0A%5Cusepackage%5BT1%5D%7Bfontenc%7D%0A%5Cusepackage%7Bimakeidx%7D%0A%5Cmakeindex%5Bcolumns%3D3%2C+title%3DAlphabetical+Index%5D%0A%0A%5Cbegin%7Bdocument%7D%0A%5Csection%7BIntroduction%7D%0AIn+this+example%2C+several+keywords%5Cindex%7Bkeywords%7D+will+be+used+which+%0Aare+important+and+deserve+to+appear+in+the+Index%5Cindex%7BIndex%7D.%0A%0ATerms+like+generate%5Cindex%7Bgenerate%7D+and+some%5Cindex%7Bothers%7D+will+also+%0Ashow+up.+Terms+in+the+index+can+also+be+nested+%5Cindex%7BIndex%21nested%7D%0A%0A%5Cclearpage%0A%0A%5Csection%7BSecond+section%7D%0AThis+second+section%5Cindex%7Bsection%7D+may+include+some+special+word%2C+%0Aand+expand+the+ones+already+used%5Cindex%7Bkeywords%21used%7D.%0A%0A%5Cprintindex%0A%5Cend%7Bdocument%7D) Das folgende Bild zeigt die von dem obigen Beispiel erzeugte Ausgabe: ![Index3OLV2.png](/files/2daa993ac1568eb4445770a5d17d48e7b68efb30) In diesem Beispiel wird der Index mit dem Parameter in einem dreispaltigen Format dargestellt `columns=3`, und der Titel wird zu "Alphabetical Index" geändert durch `title=Alphabetical Index`; diese Parameter werden an `\makeindex` in der Präambel übergeben. Siehe die [Referenzleitfaden](#reference-guide) für eine Liste der verfügbaren Parameter und ihrer Beschreibung. ### Stildateien verwenden Für eine weitergehende Anpassung des Index kann eine Stildatei verwendet werden. Stildateien informieren `makeindex` über das gewünschte Format der Ausgabe. Stildateien enthalten eine Liste von `` Paaren. Wenn man beispielsweise die Begriffe im Index nach ihrem Anfangsbuchstaben gruppieren und die Seitennummern rechtsbündig ausrichten möchte, erfüllt die folgende Stildatei diese Aufgabe: ```latex headings_flag 1 "\n\\centering\\large\\sffamily\\bfseries% \\noindent\\textbf{"heading_suffix "}\\par\\nopagebreak\n" "\n \\item \\small " " \\hfill " " \\hfill " " \\hfill " ``` Die Schlüssel ändern verschiedene Elemente der Indexausgabe: * `headings_flag 1` ermöglicht die Gruppierung, indem die Gruppenüberschrift (Symbole, Zahlen oder Buchstaben) vor einer neuen Gruppe eingefügt wird. * `heading_prefix` formatiert die Überschrift, die vor dem Beginn eines neuen Buchstabens eingefügt wird. Sie verwendet übliche Formatierungsbefehle für die Schriftfamilie, die Schriftgröße und die Ausrichtung, aber die Backslashes müssen mit einem doppelten Backslash statt mit einem einfachen escaped werden. * `item_0` wird zwischen zwei primären Einträgen eingefügt. * `delim_*` ist das Trennzeichen, das zwischen dem Schlüssel und der ersten Seitennummer eingefügt wird. Eine vollständige Liste der in einer .ist-Datei zu verwendenden Schlüssel und Werte finden Sie unter [Die in der Referenzanleitung enthaltene Tabelle](#keys-to-create-styles-files). Angenommen, die vorherige Datei wird als "example\_style.ist" gespeichert. Um sie im Dokument zu verwenden, fügen wir den Parameter `options= -s example_style.ist` zu `\makeindex` Befehl zu interpretieren ist. ```latex \documentclass{article} \usepackage[utf8]{inputenc} \usepackage[T1]{fontenc} \usepackage{imakeidx} \makeindex[columns=3, title=Alphabetical Index, options= -s example_style.ist] \begin{document} \tableofcontents \section{Einleitung} In diesem Beispiel werden mehrere Schlüsselwörter\index{keywords} verwendet, die wichtig sind und es verdienen, im Index\index{Index} aufzutauchen. Begriffe wie generate\index{generate}, eine großartige\index{great} Liste und einige andere\index{others} Begriffe, die wichtig sein könnten\index{important} werden ebenfalls erscheinen. Begriffe im Index können auch verschachtelt werden \index{Index!nested} \clearpage \section{Zweiter Abschnitt} Dieser zweite Abschnitt\index{section} kann ein spezielles Wort enthalten und die bereits verwendeten erweitern\index{keywords!used}. \printindex \end{document} ``` [Ein Beispiel mit einer Index-Stildatei auf Overleaf öffnen](https://www.overleaf.com/project/new/template/20614?id=70756423\&templateName=Using+an+index+style+file\&latexEngine=pdflatex\&texImage=texlive-full%3A2020.1\&mainFile=) Das folgende Bild zeigt die von dem obigen Beispiel erzeugte Ausgabe: ![Index4OLV2.png](/files/1fe5f27026f28e594c1cdf23a9e6a9ff75f16d15) ## Den Index ins Inhaltsverzeichnis aufnehmen Standardmäßig ist der Index nicht im Inhaltsverzeichnis enthalten; das lässt sich leicht anpassen. ```latex \documentclass{article} \usepackage[T1]{fontenc} \usepackage{imakeidx} \makeindex[columns=3, title=Alphabetical Index, intoc] \begin{document} \tableofcontents \section{Einleitung} In diesem Beispiel werden mehrere Schlüsselwörter\index{keywords} verwendet, die verwendet, die wichtig sind und es verdienen, im Index\index{Index}. Begriffe wie generate\index{generate} und some\index{others} werden ebenfalls erscheinen. Begriffe im Index können auch verschachtelt werden \index{Index!nested} \clearpage \section{Zweiter Abschnitt} Dieser zweite Abschnitt\index{section} kann einige spezielle Wörter enthalten und die bereits verwendeten erweitern\index{keywords!used}. \printindex \end{document} ``` [Öffnen Sie dieses Beispiel in Overleaf](https://www.overleaf.com/docs?engine=pdflatex\&snip_name=Index+example+3\&snip=%5Cdocumentclass%7Barticle%7D%0A%5Cusepackage%5BT1%5D%7Bfontenc%7D%0A%5Cusepackage%7Bimakeidx%7D%0A%5Cmakeindex%5Bcolumns%3D3%2C+title%3DAlphabetical+Index%2C+intoc%5D%0A%0A%5Cbegin%7Bdocument%7D%0A%5Ctableofcontents%0A%0A%5Csection%7BIntroduction%7D%0AIn+this+example%2C+several+keywords%5Cindex%7Bkeywords%7D+will+be+%0Aused+which+are+important+and+deserve+to+appear+in+the+%0AIndex%5Cindex%7BIndex%7D.%0A%0ATerms+like+generate%5Cindex%7Bgenerate%7D+and+some%5Cindex%7Bothers%7D+%0Awill+also+show+up.+Terms+in+the+index+can+also+be+%0Anested+%5Cindex%7BIndex%21nested%7D%0A%0A%5Cclearpage%0A%0A%5Csection%7BSecond+section%7D%0AThis+second+section%5Cindex%7Bsection%7D+may+include+some+special+%0Aword%2C+and+expand+the+ones+already+used%5Cindex%7Bkeywords%21used%7D.%0A%0A%5Cprintindex%0A%5Cend%7Bdocument%7D) Das folgende Bild zeigt die von dem obigen Beispiel erzeugte Ausgabe: ![Index5OLV2.png](/files/2912fa195e14df4f9d64939163ae0545b1be6d03) Durch Hinzufügen des Parameters `intoc` zum Befehl `\makeindex` wird das Aufnehmen des Index-Titels ins Inhaltsverzeichnis aktiviert. ## Referenzhandbuch ### Parameter für den Befehl \makeindex **Titel** Titel, der am Anfang des jeweiligen Index gesetzt werden soll. Ein Beispiel wird unter Den Index formatieren gezeigt. **intoc** Wenn diese Option übergeben wird, wird der Index-Titel ins Inhaltsverzeichnis aufgenommen. **columns** Verwendet die Syntax Schlüssel=Wert; der Wert muss eine Ganzzahl sein, die die Anzahl der Spalten angibt. Der Standardwert ist 2. **columnsep** Gibt die Maßeinheit für den Abstand zwischen den Spalten an. Die Syntax muss Schlüssel=Wert sein, zum Beispiel columnsep=2em. **columnseprule** Wenn die Option übergeben wird, wird zwischen den Spalten ein vertikales Trennzeichen dargestellt. ### Schlüssel zum Erstellen von Stildateien Die folgende Tabelle zeigt die Schlüssel, Standardwerte und Beschreibungen zum Erstellen von .ist-Stildateien. | Schlüssel | Beschreibung | | --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `actual ` | '@' Symbol, der anzeigt, dass der nächste Eintrag in der Ausgabedatei erscheinen soll. | | `arg_close ` | '}' Schließendes Trennzeichen für das Argument des Indexeintrags. | | `arg_open ` | '{' Öffnendes Trennzeichen für das Argument des Indexeintrags. | | `encap ` | ' Symbol, das anzeigt, dass der Rest der Argumentliste als umschließender Befehl für die Seitenzahl verwendet werden soll. | | `escape ` | '\\\\' Zeichen, das den folgenden Buchstaben maskiert, es sei denn, sein vorangehendes Zeichen ist selbst ein Escape-Zeichen. Hinweis: quote wird verwendet, um den unmittelbar folgenden Buchstaben zu maskieren; wenn ihm jedoch ein Escape-Zeichen vorausgeht, wird es als normales Zeichen behandelt. Diese beiden Zeichen müssen unterschiedlich sein. | | `keyword ` | "\\\indexentry" Befehl, der makeindex mitteilt, dass sein Argument ein Indexeintrag ist. | | `level ` | '!' Trennzeichen, das eine neue Ebene eines Untereintrags kennzeichnet. | | `quote ` | "'" Hinweis: quote wird verwendet, um den unmittelbar folgenden Buchstaben zu maskieren; wenn ihm jedoch ein Escape-Zeichen vorausgeht, wird es als normales Zeichen behandelt. Diese beiden Zeichen müssen unterschiedlich sein. | | `range_close ` | ')' Schließendes Trennzeichen, das das Ende eines expliziten Seitenbereichs anzeigt. | | `range_open ` | '(' Öffnendes Trennzeichen, das den Beginn eines expliziten Seitenbereichs anzeigt. | | `preamble ` | "\begin{theindex}\n" Präambel der Ausgabedatei. | | `postamble ` | "\n\n\\\end{theindex}\n" Nachspann der Ausgabedatei. | | `setpage_prefix ` | "\n \\\setcounter{page}{" Präfix des Befehls, der die Startseitennummer festlegt. | | `setpage_suffix ` | "}\n" Suffix des Befehls, der die Startseitennummer festlegt. | | `group_skip ` | "\n\n \\\indexspace\n" Vertikaler Abstand, der eingefügt wird, bevor eine neue Gruppe beginnt. | | `headings_flag ` | 0 Flag, das die Behandlung neuer Gruppenüberschriften angibt, die vor einer neuen Gruppe eingefügt werden (Symbole, Zahlen und die 26 Buchstaben): Positive Werte führen dazu, dass ein Großbuchstabe zwischen Präfix und Suffix eingefügt wird, und negative Werte führen dazu, dass ein Kleinbuchstabe eingefügt wird (Standard ist 0, wodurch keine Überschrift erzeugt wird). | | `heading_prefix ` | "" Präfix der Überschrift, das vor dem Beginn eines neuen Buchstabens eingefügt wird. | | `symhead_positive ` | "Symbols" Überschrift für Symbole, die eingefügt wird, wenn headings\_flag positiv ist. | | `symhead_negative ` | "symbols" Überschrift für Symbole, die eingefügt wird, wenn headings\_flag negativ ist. | | `numhead_positive ` | "Numbers" Überschrift für Zahlen, die eingefügt wird, wenn headings\_flag positiv ist. | | `numhead_negative ` | "numbers" Überschrift für Zahlen, die eingefügt wird, wenn headings\_flag negativ ist. | | `item_0 ` | "\n \\\item " Befehl, der zwischen zwei primären Einträgen (Ebene 0) eingefügt wird. | | `item_1 ` | "\n \\\subitem " Befehl, der zwischen zwei sekundären Einträgen (Ebene 1) eingefügt wird. | | `item_2 ` | "\n \\\subsubitem " Befehl, der zwischen zwei Einträgen der Ebene 2 eingefügt wird. | | `item_01 ` | "\n \\\subitem " Befehl, der zwischen einem Eintrag der Ebene 0 und einem Eintrag der Ebene 1 eingefügt wird. | | `item_x1 ` | "\n \\\subitem " Befehl, der zwischen einem Eintrag der Ebene 0 und einem Eintrag der Ebene 1 eingefügt wird, wobei der Eintrag der Ebene 0 keine zugehörigen Seitenzahlen hat. | | `item_12 ` | "\n \\\subsubitem " Befehl, der zwischen einem Eintrag der Ebene 1 und einem Eintrag der Ebene 2 eingefügt wird. | | `item_x2 ` | "\n \\\subsubitem " Befehl, der zwischen einem Eintrag der Ebene 1 und einem Eintrag der Ebene 2 eingefügt wird, wobei der Eintrag der Ebene 1 keine zugehörigen Seitenzahlen hat. | | `delim_0 ` | ", " Trennzeichen, das zwischen einem Schlüssel der Ebene 0 und seiner ersten Seitennummer eingefügt wird (Standard: Komma gefolgt von einem Leerzeichen). | | `delim_1 ` | ", " Trennzeichen, das zwischen einem Schlüssel der Ebene 1 und seiner ersten Seitennummer eingefügt wird (Standard: Komma gefolgt von einem Leerzeichen). | | `delim_2 ` | ", " Trennzeichen, das zwischen einem Schlüssel der Ebene 2 und seiner ersten Seitennummer eingefügt wird (Standard: Komma gefolgt von einem Leerzeichen). | | `delim_n ` | ", " Trennzeichen, das zwischen zwei Seitennummern für denselben Schlüssel auf beliebiger Ebene eingefügt wird (Standard: Komma gefolgt von einem Leerzeichen). | | `delim_r ` | "--" Trennzeichen, das zwischen der ersten und der letzten Seitennummer eines Bereichs eingefügt wird. | | `delim_t ` | "" Trennzeichen, das am Ende einer Seitenliste eingefügt wird. Dieses Trennzeichen hat keinen Einfluss auf Einträge, die keine zugehörige Seitenliste haben. | | `encap_prefix ` | "\\\\" Erster Teil des Präfixes für den Befehl, der die Seitennummer umschließt. | | `encap_infix ` | "{" Zweiter Teil des Präfixes für den Befehl, der die Seitennummer umschließt. | | `encap_suffix ` | "}". Suffix für den Befehl, der die Seitennummer umschließt. | | `line_max ` | 72 Maximale Länge einer Zeile in der Ausgabe, ab der eine Zeile umgebrochen wird. | | `indent_space ` | "\t\t" Leerraum, der vor einer umgebrochenen Zeile eingefügt wird (Standard: zwei Tabs). | | `indent_length ` | 16 Länge von indent\_space (Standard: 16, entspricht 2 Tabs). | ## Weiterführende Lektüre Weitere Informationen finden Sie unter: * [Glossare](/latex/de/dokumentstruktur/05-glossaries.md) * [Verzeichnisse der Tabellen und Abbildungen](/latex/de/abbildungen-und-tabellen/03-lists-of-tables-and-figures.md) * [Inhaltsverzeichnis](/latex/de/dokumentstruktur/02-table-of-contents.md) * [Abschnitte und Kapitel](/latex/de/dokumentstruktur/01-sections-and-chapters.md) * [Hyperlinks](/latex/de/dokumentstruktur/09-hyperlinks.md) * [Unterstützung internationaler Sprachen](/latex/de/sprachen/03-international-language-support.md) * [Querverweise auf Abschnitte und Gleichungen](/latex/de/dokumentstruktur/03-cross-referencing-sections-equations-and-floats.md) * [Verwaltung in einem großen Projekt](/latex/de/dokumentstruktur/07-management-in-a-large-project.md) * [Mehrdatei-LaTeX-Projekte](/latex/de/dokumentstruktur/08-multi-file-latex-projects.md) * [Dokumentation des Pakets imakeidx](http://mirror.math.ku.edu/tex-archive/macros/latex/contrib/imakeidx/imakeidx.pdf) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://overleaf-pro.ayaka.space/latex/de/dokumentstruktur/04-indices.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.