Bookmarking API

Jump to bottom Edit New page

h3rald edited this page Aug 13, 2010 · 6 revisions

Glyph::Bookmark

Initialization Hash

id → @code
title → @title
file → @file

Exposed Methods

ref (used in IDs)
link (used when creating links to the bookmark itself)
title

IDs & Links

Definition

section[ @title[Test Section] @id[test] ]

Links

Same/different source file: =>[#test] (links are unique throughout the whole project/document)

Method	single-file output (different file)	single-file output (same file)	multi-file output (different file)	multi-file output (same file)
Glyph::Bookmark#ref	`test`	`test`	`test`	`test`
Glyph::Bookmark#link	`#test`	`#test`	`intro.EXTENSION#test`	`#test`

Glyph::Header < Glyph::Bookmark

Initialization Hash

level → @level
toc → @toc

Exposed Methods

toc? (whether the header should be in the TOC or not)
level