Skip to content

Commit ab27a99

Browse files
committed
manual: Add CUSTOM_ID to some sections
Add CUSTOM_ID properties to some sections for reproducible heading IDs. All sections need CUSTOM_IDs eventually. * doc/manual.org (Directives): (Backends): (Models): (Tools): (Writing tools): (Presets): (Specifying presets in the prompt): (Advanced configuration): (Prompt transformations): (gptel's finite state machine):
1 parent 6856cfe commit ab27a99

File tree

1 file changed

+31
-1
lines changed

1 file changed

+31
-1
lines changed

doc/manual.org

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
#+export_file_name: manual
1010
#+startup: content
1111

12-
#+infojs_opt: view:info toc:nil mouse:underline ftoc:nil ltoc:nil
12+
#+infojs_opt: view:overview toc:nil mouse:underline ftoc:nil ltoc:nil
1313
#+html_head: <link rel="stylesheet" type="text/css" href="style.css" />
1414
#+html_head_extra: <style>blockquote { font-style: normal; }</style>
1515
#+html_head: <script src="toc-and-theme-loader.js"></script>
@@ -477,6 +477,9 @@ always contains the last request as a gptel state-machine object (see
477477
- ~gptel-org-set-properties~
478478

479479
** Directives
480+
:PROPERTIES:
481+
:CUSTOM_ID: directives
482+
:END:
480483

481484
#+cindex: system message
482485
In addition to the text in your buffer, LLMs can be prompted with
@@ -561,6 +564,9 @@ the box:
561564
#+end_src
562565

563566
** Backends
567+
:PROPERTIES:
568+
:CUSTOM_ID: backends
569+
:END:
564570

565571
#+tindex: backend, gptel-backend
566572
A ~gptel-backend~ is an object containing LLM connection,
@@ -703,6 +709,9 @@ the list of models in the above backend, for example, you can use
703709
#+end_src
704710

705711
** Models
712+
:PROPERTIES:
713+
:CUSTOM_ID: models
714+
:END:
706715

707716
#+cindex: model, gptel model
708717
A /model/ in gptel is a symbol denoting a specific LLM, whose name is
@@ -784,6 +793,9 @@ Keys used by gptel:
784793
# #+INCLUDE: ../README.org::#include-context :only-contents t
785794

786795
** TODO Tools
796+
:PROPERTIES:
797+
:CUSTOM_ID: tools
798+
:END:
787799

788800
gptel can provide the LLM with client-side elisp "tools", or function
789801
specifications, along with the request. A "tool" is an elisp function
@@ -813,6 +825,9 @@ To use tools in gptel, you need
813825

814826
*** Obtaining tools
815827
*** Writing tools
828+
:PROPERTIES:
829+
:CUSTOM_ID: writing-tools
830+
:END:
816831

817832
A gptel tool is a structure specifying an Elisp function, the format
818833
of its arguments and accompanying documentation intended for the LLM.
@@ -1070,6 +1085,9 @@ Interactively:
10701085
Via elisp:
10711086

10721087
** Presets
1088+
:PROPERTIES:
1089+
:CUSTOM_ID: presets
1090+
:END:
10731091

10741092
#+cindex: agent
10751093
#+cindex: preset
@@ -1243,6 +1261,9 @@ programmatic use of gptel, where you can let-bind ~gptel-backend~,
12431261
simplify this too, see ~gptel-with-preset~ above.
12441262

12451263
*** Specifying presets in the prompt
1264+
:PROPERTIES:
1265+
:CUSTOM_ID: presets-in-prompts
1266+
:END:
12461267

12471268
It is sometimes useful to be able to send a single LLM query with
12481269
options different from the active ones. One way to do this is to set
@@ -1371,6 +1392,9 @@ LLMs.) gptel does not currently ship with tools, but a preset
13711392
* Advanced configuration
13721393

13731394
** The ~gptel-request~ API
1395+
:PROPERTIES:
1396+
:CUSTOM_ID: gptel-request
1397+
:END:
13741398

13751399
The heart of gptel is the function ~gptel-request~. It offers an
13761400
easy, flexible and comprehensive way to interact with LLMs, and is
@@ -1612,6 +1636,9 @@ Note:
16121636
are specified in greater detail in the sections that follow.
16131637

16141638
** Prompt transformations
1639+
:PROPERTIES:
1640+
:CUSTOM_ID: gptel-prompt-transform-functions
1641+
:END:
16151642
** Output in a specified JSON schema
16161643

16171644
~gptel-request~ can force the LLM to generate output that follows a
@@ -1849,6 +1876,9 @@ the top-level is expected to be a JSON object, not an array. gptel
18491876
handles this issue internally and wraps it an object if required.
18501877

18511878
** gptel's finite state machine
1879+
:PROPERTIES:
1880+
:CUSTOM_ID: fsm
1881+
:END:
18521882

18531883
#+cindex: finite state machine
18541884
gptel's interactions with LLMs are typically limited to a query

0 commit comments

Comments
 (0)