► |  | Scribble: PLT Documentation Tool

1 | How to Scribble Documentation
2 | Scribble Layers
3 | @-Reader
4 | Structures And Processing
5 | Renderer
6 | Decoding Text
7 | Document Language
8 | Document Reader
9 | Basic Document Forms
10 | Scheme
11 | Manual Forms
12 | Evaluation and Examples
13 | BNF Grammars
14 | Cross-Reference Utilities
15 | Text Preprocessor
| Index

▼ | 11 | Manual Forms

11.1 | Typesetting Code
11.2 | Documenting Modules
11.3 | Documenting Forms, Functions, Structure Types, and Values
11.4 | Documenting Classes and Interfaces
11.5 | Documenting Signatures
11.6 | Various String Forms
11.7 | Links
11.8 | Indexing
11.9 | Images
11.10 | Bibliography
11.11 | Miscellaneous
11.12 | Index-Entry Descriptions

On this page:

secref
seclink
other-manual
schemelink
link
elemtag
elemref
deftech
tech
techlink

Version: 4.1.4
top← prev up next →

#### 11.7`` Links

(secref |  | tag |  |  |  |
| [ | #:doc module-path |  |  |  |
|  | #:underline? underline?]) |  | → |  | element?

tag : string?
module-path : (or/c module-path? false/c) = #f
underline? : any/c = #t

Inserts the hyperlinked title of the section tagged tag, but "aux-element" items in the title content are omitted in the hyperlink label.

If module-path is provided, the tag refers to a tag with a prefix determined by module-path. When setup-plt renders documentation, it automatically adds a tag prefix to the document based on the source module. Thus, for example, to refer to a section of the PLT Scheme reference, module-path would be '(lib "scribblings/reference/reference.scrbl").

If underline? is #f, then the hyperlink is rendered in HTML without an underline.

(seclink |  | tag |  |  |  |
| [ | #:doc module-path |  |  |  |
|  | #:underline? underline?] |  |  |  |
|  | pre-content ...) |  | → |  | element?

tag : string?
module-path : (or/c module-path? false/c) = #f
underline? : any/c = #t
pre-content : any/c

Like secref, but the link label is the decoded pre-content instead of the target section’s name.

(other-manual |  | module-path |  |  |  |
| [ | #:underline? underline?]) |  | → |  | element?

module-path : module-path?
underline? : any/c = #t

Like secref for the document’s implicit "top" tag. Use this function to refer to a whole manual instead of secref, in case a special style in the future is used for manual titles.

(schemelink id pre-content ...) → element?
id : symbol?
pre-content : any/c

The decoded pre-content is hyperlinked to the definition of id.

(link |  | url |  |  |  |
|  | pre-content ... |  |  |  |
| [ | #:underline? underline? |  |  |  |
|  | #:style style]) |  | → |  | element?

url : string?
pre-content : any/c
underline? : any/c = #t
style : any/c = (if underline? #f "plainlink")

The decoded pre-content is hyperlinked to url. If style is not supplied, then underline? determines how the link is rendered.

(elemtag t pre-content ...) → element?
t : tag?
pre-content : any/c

The tag t refers to the content form of pre-content.

(elemref t pre-content ...) → element?
t : tag?
pre-content : any/c

The decoded pre-content is hyperlinked to t, which is normally defined using elemtag.

(deftech pre-content ...) → element?
pre-content : any/c

Produces an element for the decoded pre-content, and also defines a term that can be referenced elsewhere using tech.

The content->string result of the decoded pre-content is used as a key for references, but normalized as follows:

- A trailing “ies” is replaced by “y”.

- A trailing “s” is removed.

- Consecutive hyphens and whitespaces are all replaced by a single space.

These normalization steps help support natural-language references that differ slightly from a defined form. For example, a definition of “bananas” can be referenced with a use of “banana”.

(tech pre-content ... [#:doc module-path]) → element?
pre-content : any/c
module-path : (or/c module-path? false/c) = #f

Produces an element for the decoded pre-content, and hyperlinks it to the definition of the content as established by deftech. The content’s string form is normalized in the same way as for deftech. The #:doc argument supports cross-document references, like in secref.

The hyperlink is relatively quiet, in that underlining in HTML output appears only when the mouse is moved over the term.

In some cases, combining both natural-language uses of a term and proper linking can require some creativity, even with the normalization performed on the term. For example, if “bind” is defined, but a sentence uses the term “binding,” the latter can be linked to the former using @tech{bind}ing.

(techlink pre-content ... [#:doc module-path]) → element?
pre-content : any/c
module-path : (or/c module-path? false/c) = #f

Like tech, but the link is not a quiet. For example, in HTML output, a hyperlink underline appears even when the mouse is not over the link.

top← prev up next →