> 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/06-nomenclatures.md). # Nomenklaturen ## Einführung Eine Liste von Abkürzungen und Symbolen ist in vielen wissenschaftlichen Dokumenten üblich. Diese Arten von Listen können mit LaTeX mithilfe des `nomencl` Pakets erstellt werden. Dieser Artikel erklärt, wie Nomenklaturen erstellt werden, einschließlich der Anpassung der Sortierung und Untergruppierung der Symbole. Einträge in der Nomenklatur funktionieren ziemlich ähnlich wie Indexeinträge: ```latex \documentclass{article} \usepackage{nomencl} \makenomenclature \begin{document} Hier ist ein Beispiel: \nomenclature{\(c\)}{Lichtgeschwindigkeit im Vakuum} \nomenclature{\(h\)}{Planck-Konstante} \printnomenclature \end{document} ``` [Öffnen Sie dieses `nomencl` Beispiel in Overleaf](https://www.overleaf.com/docs?engine=pdflatex\&snip_name=nomencl+package+example\&snip=%5Cdocumentclass%7Barticle%7D%0A%5Cusepackage%7Bnomencl%7D%0A%5Cmakenomenclature%0A%0A%5Cbegin%7Bdocument%7D%0AHere+is+an+example%3A%0A%5Cnomenclature%7B%5C%28c%5C%29%7D%7BSpeed+of+light+in+a+vacuum%7D%0A%5Cnomenclature%7B%5C%28h%5C%29%7D%7BPlanck+constant%7D%0A%0A%5Cprintnomenclature%0A%5Cend%7Bdocument%7D) ![Nomenclatures01OLV2.png](/files/56c9c47d8b160bdaf0b3606f0205e6fc48161282) Wie üblich wird das Paket im Vorspann mit `\usepackage{nomencl}`. Die drei grundlegenden Befehle zum Erzeugen der Nomenklaturen sind: * `\makenomenclature`. Üblicherweise direkt nach dem Einbinden des Pakets platziert. * `\nomenclature`. Wird verwendet, um die Nomenklatureinträge selbst zu definieren. Nimmt zwei Argumente: das Symbol und die entsprechende Beschreibung. * `\printnomenclatures`. Dieser Befehl gibt die Nomenklaturliste aus. ## Grundlegende Syntax Beim Einbinden des `nomencl` Pakets können zusätzliche Optionen verwendet werden. Das nächste Beispiel zeigt, wie die Nomenklatur zum Inhaltsverzeichnis hinzugefügt wird und wie die Standardsprache geändert werden kann: ```latex \documentclass{article} \usepackage[spanish]{babel} \usepackage[intoc, spanish]{nomencl} \makenomenclature \begin{document} \tableofcontents \section{Erster Abschnitt} Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Etiam lobortisfacilisis sem. Nullam nec mi et neque pharetra sollicitudin. Praesent imperdie... \nomenclature{\(c\)}{Lichtgeschwindigkeit im Vakuum} \nomenclature{\(h\)}{Planck-Konstante} \printnomenclature \end{document} ``` [Öffnen Sie dieses `nomencl` Beispiel in Overleaf](https://www.overleaf.com/docs?engine=pdflatex\&snip_name=nomencl+package+example\&snip=%5Cdocumentclass%7Barticle%7D%0A%5Cusepackage%5Bspanish%5D%7Bbabel%7D%0A%5Cusepackage%5Bintoc%2C+spanish%5D%7Bnomencl%7D%0A%5Cmakenomenclature%0A%0A%5Cbegin%7Bdocument%7D%0A%5Ctableofcontents%0A%0A%5Csection%7BPrimera+Secci%C3%B3n%7D%0A%0ALorem+ipsum+dolor+sit+amet%2C+consectetuer+adipiscing+elit.+Etiam+lobortisfacilisis+sem.+Nullam+nec+mi+et+neque+pharetra+sollicitudin.+Praesent+imperdie...%0A%0A%5Cnomenclature%7B%5C%28c%5C%29%7D%7BSpeed+of+light+in+a+vacuum%7D%0A%5Cnomenclature%7B%5C%28h%5C%29%7D%7BPlanck+constant%7D%0A%0A%5Cprintnomenclature%0A%5Cend%7Bdocument%7D) ![Nomenclatures02OLV2.png](/files/0cc04f2c35c66b4dbf6bcbf580bc8e510e80394f) Die hier beim Einbinden des Pakets verwendeten zusätzlichen Optionen sind: * `intoc` Fügt die **Nomenklatur** zum Inhaltsverzeichnis hinzu. * `spanisch` Ändert die Sprache und übersetzt den Standardtitel *Nomenklaturen* entsprechend. Die unterstützten Sprachen sind: `kroatisch`, `dänisch`, `english`, `french`, `deutsch`, `italienisch`, `polnisch`, `portugiesisch`, `russian`, `spanisch` und `ukrainisch`. Weitere nützliche Funktionen des `nomencl` Pakets sind die Möglichkeit, den Nomenklaturtitel manuell festzulegen und eine zusätzliche Anmerkung hinzuzufügen. ```latex \documentclass{article} \usepackage{nomencl} \makenomenclature \renewcommand{\nomname}{Liste der Symbole} \renewcommand{\nompreamble}{Die folgende Liste beschreibt mehrere Symbole, die später im Text des Dokuments verwendet werden} \begin{document} Hier ist ein Beispiel: \nomenclature{\(c\)}{Lichtgeschwindigkeit im Vakuum} \nomenclature{\(h\)}{Planck-Konstante} \printnomenclature \end{document} ``` [Öffnen Sie dieses `nomencl` Beispiel in Overleaf](https://www.overleaf.com/docs?engine=pdflatex\&snip_name=nomencl+package+example\&snip=%5Cdocumentclass%7Barticle%7D%0A%5Cusepackage%7Bnomencl%7D%0A%5Cmakenomenclature%0A%0A%5Crenewcommand%7B%5Cnomname%7D%7BList+of+Symbols%7D%0A%0A%5Crenewcommand%7B%5Cnompreamble%7D%7BThe+next+list+describes+several+symbols+that+will+be+later+used+within+the+body+of+the+document%7D%0A%0A%5Cbegin%7Bdocument%7D%0AHere+is+an+example%3A%0A%0A%5Cnomenclature%7B%5C%28c%5C%29%7D%7BSpeed+of+light+in+a+vacuum%7D%0A%5Cnomenclature%7B%5C%28h%5C%29%7D%7BPlanck+constant%7D%0A%0A%5Cprintnomenclature%0A%5Cend%7Bdocument%7D) ![Nomenclatures03verbOLV2.png](/files/850339f22712395b104d288ba31d9e22bd9d51a7) Die Zeile ``` \renewcommand{\nomname}{Liste der Symbole} ``` ändert den Standardtitel. Der Befehl ``` \renewcommand{\nompreamble}{Die folgende Liste...} ``` fügt zwischen dem Titel und der Liste der Symbole etwas Text ein. ## Gruppierung Um die Symbole nach ihrem Typ zu gruppieren, ist zusätzliche Arbeit nötig. Wir fügen jedem Symbol ein Präfix hinzu und verwenden das `etoolbox` Paket, um die Präfixe zu vergleichen. ```latex \documentclass{article} \usepackage{amssymb} \usepackage{nomencl} \makenomenclature %% Dieser Code erstellt die Gruppen % ----------------------------------------- \usepackage{etoolbox} \renewcommand\nomgroup[1]{% \item[\bfseries \ifstrequal{#1}{P}{Physikalische Konstanten}{% \ifstrequal{#1}{N}{Zahlenmengen}{% \ifstrequal{#1}{O}{Andere Symbole}{}}}% ]} % ----------------------------------------- \begin{document} Hier ist ein Beispiel: \nomenclature[P]{\(c\)}{Lichtgeschwindigkeit im Vakuum} \nomenclature[P]{\(h\)}{Planck-Konstante} \nomenclature[P]{\(G\)}{Gravitationskonstante} \nomenclature[N]{\(\mathbb{R}\)}{Reelle Zahlen} \nomenclature[N]{\(\mathbb{C}\)}{Komplexe Zahlen} \nomenclature[N]{\(\mathbb{H}\)}{Quaternionen} \nomenclature[O]{\(V\)}{Konstantes Volumen} \nomenclature[O]{\(\rho\)}{Reibungsindex} \printnomenclature \end{document} ``` [Öffnen Sie dieses `nomencl` Beispiel in Overleaf](https://www.overleaf.com/docs?engine=pdflatex\&snip_name=nomencl+package+example\&snip=%5Cdocumentclass%7Barticle%7D%0A%5Cusepackage%7Bamssymb%7D%0A%5Cusepackage%7Bnomencl%7D%0A%5Cmakenomenclature%0A%0A%25%25+This+code+creates+the+groups%0A%25+-----------------------------------------%0A%5Cusepackage%7Betoolbox%7D%0A%5Crenewcommand%5Cnomgroup%5B1%5D%7B%25%0A++%5Citem%5B%5Cbfseries%0A++%5Cifstrequal%7B%231%7D%7BP%7D%7BPhysics+constants%7D%7B%25%0A++%5Cifstrequal%7B%231%7D%7BN%7D%7BNumber+sets%7D%7B%25%0A++%5Cifstrequal%7B%231%7D%7BO%7D%7BOther+symbols%7D%7B%7D%7D%7D%25%0A%5D%7D%0A%25+-----------------------------------------%0A%0A%5Cbegin%7Bdocument%7D%0AHere+is+an+example%3A%0A%0A%5Cnomenclature%5BP%5D%7B%5C%28c%5C%29%7D%7BSpeed+of+light+in+a+vacuum%7D%0A%5Cnomenclature%5BP%5D%7B%5C%28h%5C%29%7D%7BPlanck+constant%7D%0A%5Cnomenclature%5BP%5D%7B%5C%28G%5C%29%7D%7BGravitational+constant%7D%0A%5Cnomenclature%5BN%5D%7B%5C%28%5Cmathbb%7BR%7D%5C%29%7D%7BReal+numbers%7D%0A%5Cnomenclature%5BN%5D%7B%5C%28%5Cmathbb%7BC%7D%5C%29%7D%7BComplex+numbers%7D%0A%5Cnomenclature%5BN%5D%7B%5C%28%5Cmathbb%7BH%7D%5C%29%7D%7BQuaternions%7D%0A%5Cnomenclature%5BO%5D%7B%5C%28V%5C%29%7D%7BConstant+volume%7D%0A%5Cnomenclature%5BO%5D%7B%5C%28%5Crho%5C%29%7D%7BFriction+index%7D%0A%0A%5Cprintnomenclature%0A%5Cend%7Bdocument%7D) ![Nomenclatures04OLV2.png](/files/1340e7d55535d8d45da7d0be1e784c1e4f1c0f2d) Einige zusätzliche Gruppen werden hinzugefügt. Der Code dafür ist nicht ganz so einfach; er verwendet den Befehl `\ifstrequal{}{}{}{}`, die ersten beiden Argumente sind die zu vergleichenden Zeichenfolgen; wenn sie gleich sind, wird der Begriff der Gruppe hinzugefügt, andernfalls wird die nächste verschachtelte Bedingung geprüft. Beachten Sie, dass nun jeder `\nomenclature` Befehl ein zusätzliches Argument, das Präfix, in eckigen Klammern hat; dieses wird im Gruppierungscode verwendet. Wenn `etoolbox` nicht verfügbar ist, kann man stattdessen das `ifthen` Paket verwenden, das die Bedingung `\ifthenelse{}{}{}`bereitstellt, aber die Syntax ist etwas komplexer: ```latex \usepackage{ifthen} \renewcommand{\nomgroup}[1]{% \item[\bfseries \ifthenelse{\equal{#1}{P}}{Physikalische Konstanten}{% \ifthenelse{\equal{#1}{O}}{Andere Symbole}{% \ifthenelse{\equal{#1}{N}}{Zahlenmengen}{}}}% ]} ``` Dies erzeugt dieselben Nomenklaturgruppen. ## Einheiten für physikalische Konstanten hinzufügen Eine weitere interessante Funktion ist die Verwendung des `siunitx` Pakets zum Hinzufügen von Einheiten, die rechts von den entsprechenden Einträgen ausgerichtet werden. Dazu muss man das `nomunit` Makro wie im folgenden Beispiel definieren: ```latex \documentclass{article} \usepackage{amssymb} \usepackage{nomencl} \usepackage{siunitx} \usepackage{hyperref} \makenomenclature \hypersetup{ colorlinks=true, urlcolor=blue, } %% Dies fügt die Untergruppen hinzu %---------------------------------------------- \usepackage{etoolbox} \renewcommand\nomgroup[1]{% \item[\bfseries \ifstrequal{#1}{A}{Physikalische Konstanten}{% \ifstrequal{#1}{B}{Zahlenmengen}{% \ifstrequal{#1}{C}{Andere Symbole}{}}}% ]} %---------------------------------------------- %% Dies fügt die Einheiten hinzu %---------------------------------------------- \newcommand{\nomunit}[1]{% \renewcommand{\nomentryend}{\hspace*{\fill}#1}} %---------------------------------------------- \title{Beispiel für Nomenklaturen} \author{Overleaf-Team} \date{\today} \begin{document} \maketitle \noindent Dies ist ein Beispiel, das zeigt, wie das \texttt{nomencl}-Paket funktioniert, mit Einheiten, die über das \texttt{siunitx}-Paket gesetzt werden. \href{https://www.nist.gov/pml/fundamental-physical-constants}{NIST} wurde als Quelle für die Werte physikalischer Konstanten sowie deren entsprechende Einheiten verwendet---Links werden über das \texttt{hyperref}-Paket bereitgestellt: \nomenclature[A, 02]{\(c\)}{\href{https://physics.nist.gov/cgi-bin/cuu/Value?c} {Lichtgeschwindigkeit im Vakuum} \nomunit{\SI{299792458}{\meter\per\second}}} \nomenclature[A, 03]{\(h\)}{\href{https://physics.nist.gov/cgi-bin/cuu/Value?h} {Planck-Konstante} \nomunit{\SI[group-digits=false]{6.62607015e-34}{\joule\per\hertz}}} \nomenclature[A, 01]{\(G\)}{\href{https://physics.nist.gov/cgi-bin/cuu/Value?bg} {Gravitationskonstante} \nomunit{\SI[group-digits=false]{6.67430e-11}{\meter\cubed\per\kilogram\per\second\squared}}} \nomenclature[B, 03]{\(\mathbb{R}\)}{Reelle Zahlen} \nomenclature[B, 02]{\(\mathbb{C}\)}{Komplexe Zahlen} \nomenclature[B, 01]{\(\mathbb{H}\)}{Quaternionen} \nomenclature[C]{\(V\)}{Konstantes Volumen} \nomenclature[C]{\(\rho\)}{Reibungsindex} \printnomenclature \end{document} ``` [In Overleaf öffnen (Beispiel mit `nomencl` und `siunitx` Paketen).](/latex/de/dokumentstruktur/06-nomenclatures.md) ![Nomcomplex.png](/files/890abe8b559f3d90950eda63e7cdfdfb15d63f92) ## Einträge sortieren Dies ist die Standard-Sortierreihenfolge: ```latex \documentclass{article} \usepackage{nomencl} \makenomenclature \begin{document} Hier ist ein Beispiel: \nomenclature{\(+a\)}{Operator} \nomenclature{\(2a\)}{Zahl} \nomenclature{\(:a\)}{Interpunktionszeichen} \nomenclature{\(Aa\)}{Großbuchstabe} \nomenclature{\(aa\)}{Kleinbuchstabe} \nomenclature{\(\alpha\)}{Griechisches Zeichen} \printnomenclature \end{document} ``` [Öffnen Sie dieses `nomencl` Beispiel in Overleaf](https://www.overleaf.com/docs?engine=pdflatex\&snip_name=nomencl+default+sort+order\&snip=%5Cdocumentclass%7Barticle%7D%0A%5Cusepackage%7Bnomencl%7D%0A%0A%5Cmakenomenclature%0A%0A%5Cbegin%7Bdocument%7D%0AHere+is+an+example%3A%0A%0A%5Cnomenclature%7B%5C%28%2Ba%5C%29%7D%7BOperator%7D%0A%5Cnomenclature%7B%5C%282a%5C%29%7D%7BNumber%7D%0A%5Cnomenclature%7B%5C%28%3Aa%5C%29%7D%7BPunctuation+symbol%7D%0A%5Cnomenclature%7B%5C%28Aa%5C%29%7D%7BUppercase+letter%7D%0A%5Cnomenclature%7B%5C%28aa%5C%29%7D%7BLowercase+letter%7D%0A%5Cnomenclature%7B%5C%28%5Calpha%5C%29%7D%7BGreek+character%7D%0A%0A%5Cprintnomenclature%0A%0A%5Cend%7Bdocument%7D) ![Nomenclatures05OLV2.png](/files/cde8868b935196b3bb55dedb8078381bae47c83b) Beachten Sie, dass das griechische Zeichen aufgrund des Backslash vor den alphabetischen Zeichen erscheint `\` in `\alpha`. Genau wie bei der Gruppierung ist es möglich, ein Präfix zu verwenden, um die Nomenklatureinträge manuell zu sortieren: ```latex \documentclass{article} \usepackage{nomencl} \makenomenclature \begin{document} Hier ist ein Beispiel: \nomenclature[06]{\(+a\)}{Operator} \nomenclature[03]{\(2a\)}{Zahl} \nomenclature[05]{\(:a\)}{Interpunktionszeichen} \nomenclature[04]{\(Aa\)}{Großbuchstabe} \nomenclature[01]{\(aa\)}{Kleinbuchstabe} \nomenclature[02]{\(\alpha\)}{Griechisches Zeichen} \printnomenclature \end{document} ``` [Öffnen Sie dieses `nomencl` Beispiel in Overleaf](https://www.overleaf.com/docs?engine=pdflatex\&snip_name=Sorting+nomencl+entries\&snip=%5Cdocumentclass%7Barticle%7D%0A%5Cusepackage%7Bnomencl%7D%0A%0A%5Cmakenomenclature%0A%0A%5Cbegin%7Bdocument%7D%0AHere+is+an+example%3A%0A%0A%5Cnomenclature%5B06%5D%7B%5C%28%2Ba%5C%29%7D%7BOperator%7D%0A%5Cnomenclature%5B03%5D%7B%5C%282a%5C%29%7D%7BNumber%7D%0A%5Cnomenclature%5B05%5D%7B%5C%28%3Aa%5C%29%7D%7BPunctuation+symbol%7D%0A%5Cnomenclature%5B04%5D%7B%5C%28Aa%5C%29%7D%7BUppercase+letter%7D%0A%5Cnomenclature%5B01%5D%7B%5C%28aa%5C%29%7D%7BLowercase+letter%7D%0A%5Cnomenclature%5B02%5D%7B%5C%28%5Calpha%5C%29%7D%7BGreek+character%7D%0A%0A%5Cprintnomenclature%0A%0A%5Cend%7Bdocument%7D) ![Nomenclatures06OLV2.png](/files/5b767d6deabab9fb78648a674a361bf9392bbdb7) Die Zahl in den Klammern bestimmt die Reihenfolge, in der das entsprechende Symbol ausgegeben wird. Man kann Gruppierung und manuelle Sortierung auch kombinieren: ```latex \documentclass{article} \usepackage{amssymb} \usepackage{nomencl} \makenomenclature \usepackage{etoolbox} \renewcommand\nomgroup[1]{% \item[\bfseries \ifstrequal{#1}{A}{Physikalische Konstanten}{% \ifstrequal{#1}{B}{Zahlenmengen}{% \ifstrequal{#1}{C}{Andere Symbole}{}}}% ]} \begin{document} Hier ist ein Beispiel: \nomenclature[A, 02]{\(c\)}{Lichtgeschwindigkeit im Vakuum} \nomenclature[A, 03]{\(h\)}{Planck-Konstante} \nomenclature[A, 01]{\(G\)}{Gravitationskonstante} \nomenclature[B, 03]{\(\mathbb{R}\)}{Reelle Zahlen} \nomenclature[B, 02]{\(\mathbb{C}\)}{Komplexe Zahlen} \nomenclature[B, 01]{\(\mathbb{H}\)}{Oktavenionen} \nomenclature[C]{\(V\)}{Konstantes Volumen} \nomenclature[C]{\(\rho\)}{Reibungsindex} \printnomenclature \end{document} ``` [Öffnen Sie dieses `nomencl` Beispiel in Overleaf](https://www.overleaf.com/docs?engine=pdflatex\&snip_name=Grouping+and+sorting+with+nomencl\&snip=%5Cdocumentclass%7Barticle%7D%0A%5Cusepackage%7Bamssymb%7D%0A%5Cusepackage%7Bnomencl%7D%0A%5Cmakenomenclature%0A%0A%5Cusepackage%7Betoolbox%7D%0A%5Crenewcommand%5Cnomgroup%5B1%5D%7B%25%0A++%5Citem%5B%5Cbfseries%0A++%5Cifstrequal%7B%231%7D%7BA%7D%7BPhysics+Constants%7D%7B%25%0A++%5Cifstrequal%7B%231%7D%7BB%7D%7BNumber+Sets%7D%7B%25%0A++%5Cifstrequal%7B%231%7D%7BC%7D%7BOther+Symbols%7D%7B%7D%7D%7D%25%0A%5D%7D%0A%0A%5Cbegin%7Bdocument%7D%0AHere+is+an+example%3A%0A%0A%5Cnomenclature%5BA%2C+02%5D%7B%5C%28c%5C%29%7D%7BSpeed+of+light+in+a+vacuum%7D%0A%5Cnomenclature%5BA%2C+03%5D%7B%5C%28h%5C%29%7D%7BPlanck+constant%7D%0A%5Cnomenclature%5BA%2C+01%5D%7B%5C%28G%5C%29%7D%7BGravitational+constant%7D%0A%5Cnomenclature%5BB%2C+03%5D%7B%5C%28%5Cmathbb%7BR%7D%5C%29%7D%7BReal+numbers%7D%0A%5Cnomenclature%5BB%2C+02%5D%7B%5C%28%5Cmathbb%7BC%7D%5C%29%7D%7BComplex+numbers%7D%0A%5Cnomenclature%5BB%2C+01%5D%7B%5C%28%5Cmathbb%7BH%7D%5C%29%7D%7BOctonions%7D%0A%5Cnomenclature%5BC%5D%7B%5C%28V%5C%29%7D%7BConstant+volume%7D%0A%5Cnomenclature%5BC%5D%7B%5C%28%5Crho%5C%29%7D%7BFriction+index%7D%0A%0A%5Cprintnomenclature%0A%0A%5Cend%7Bdocument%7D) ![Nomenclatures07OLV2.png](/files/31546ebcbfea0d264685e033f4e2d725c226c93e) Beachten Sie, dass die für die Gruppierung verwendeten Großbuchstaben sich von denen im Beispiel im vorherigen Abschnitt unterscheiden, da dieser Buchstabe zur Sortierung der Gruppen verwendet wird. ## Weiterführende Literatur Weitere Informationen finden Sie unter: * [Glossare](/latex/de/dokumentstruktur/05-glossaries.md) * [Mehrdatei-LaTeX-Projekte](/latex/de/dokumentstruktur/08-multi-file-latex-projects.md) * [Textausrichtung](/latex/de/formatierung/06-text-alignment.md) * [Fett, kursiv und unterstrichen](/latex/de/latex-grundlagen/03-bold-italics-and-underlining.md) * [Mathematische Ausdrücke](/latex/de/mathematik/01-mathematical-expressions.md) * [Erstellen und Neudefinieren von Makros](/latex/de/befehle/01-commands.md) * [`nomencl` Paketdokumentation](http://mirror.jmu.edu/pub/CTAN/macros/latex/contrib/nomencl/nomencl.pdf) * [`ifthen` Paketdokumentation](http://texdoc.net/texmf-dist/doc/latex/base/ifthen.pdf) * [`etoolbox` Paketdokumentation](http://mirror.math.ku.edu/tex-archive/macros/latex/contrib/etoolbox/etoolbox.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/06-nomenclatures.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.