Wiki Links

In wiki systems, the hyper links to internal pages and resources are typically known as wiki links. In the BookWiki application, links are specified as a page path. Page paths are discussed in detail on the next page.

wiki module

\link[anchor=name]{dest}{link-text}

Inserts a hyperlink into the document that can refer to an internal page, an anchor, or an external resource.

Arguments:

dest

A required argument that specifies the destination of the link. The destination argument can be one of the following:

page path
To specify a link to an internal page within the same book or to a different book hosted on the same site. See Page Paths for a detailed description of page paths in BookWiki.
```
   \link{PagePaths}
```
url
To specify a link to an external resource or web page. The destination must begin with http:\\ or https:\\ and refer to a valid destination.
```
   \link{https://google.com}
```
anchor
To specify an anchor on the same page, the destination begins with a # and contains the name of the anchor. To refer to an anchor on a different internal page, specify the page path as the destination and set the anchor key.

link-text

An optional argument that specifies the text or image used for the actual link on which the user clicks to navigate to a different location. If omitted, the title of the page is used as the link text for internal wiki pages; for external links, the provided url will be used.

Key:

anchor

Page anchors allow a link to refer to a specific location on a page as the destination. To specify a page anchor, set this key field to the name of the anchor. For an anchor on the same page, the anchor has to be specified as the destination and preceded with a # symbol. The \anchor command is used to define anchors on wiki pages in BookWiki.

   \link[anchor='sectionA']{Page2/ChildPage}

Plugin: WikiLink

wiki module

\anchor{name}

Inserts a named anchor into the document which can be referred to in a link in order to jump directly to the anchor via a link.

   \anchor{sectionA}

Argument:

name: The name of the anchor specified as a text string.

Plugin: LinkAnchor

wiki module

\attachment[page=path]{name}<{link-text}>

Inserts a link to an internal page attachment that can be used to download the attachment.

   \attachment[page=Page2/ChildPage]{icon.png}{Page Icon}

Arguments:

name: A required argument that specifies the name of the attachment to be downloaded when the link is clicked.
link-text: An optional argument that provides the text to be used for the link on which the user clicks. If omitted, the name of the attachment is used.

Key:

page: By default, the link is to an attachment on the same page. To specify an attachment on a different page, provide the path to the page.

Plugin: WikiAttachment

☰ Click for Table of Contents	BookWiki Documentation	Wiki Plugin Reference