Documentation of pagetree #16

Closed
opened 10 years ago by gfrey · 3 comments
gfrey commented 10 years ago (Migrated from github.com)

The documentation of pagetree fails to explain how to actually build a tree of documents using .ptree files. There are some examples that define a pagetree using nested lists given explicitly, but I fail to figure out how to build a nested tree using .ptree files.

The documentation of pagetree fails to explain how to actually build a tree of documents using `.ptree` files. There are some examples that define a pagetree using nested lists given explicitly, but I fail to figure out how to build a nested tree using `.ptree` files.
mbutterick commented 10 years ago (Migrated from github.com)

Yes, true. I will patch the docs. In the meantime:

Recall from the docs that a flat pagetree can be defined in a .ptree source file this way:

#lang pollen

first.html
second.html
third.html

Whereas a hierarchical pagetree just uses the ◊ command syntax to add nested levels, e.g.:

#lang pollen

◊first-section-first-page.html{
    first-subsection-first-page.html
    first-subsection-second-page.html}
◊second-section-first-page.html{
    ◊second-subsection-first-page.html{
        first-subsubsection-first-page.html}}

And so forth.

Yes, true. I will patch the docs. In the meantime: Recall [from the docs](http://mbutterick.github.io/pollen/doc/second-tutorial.html#%28part._tutorial-2._.Making_a_pagetree_file%29) that a flat pagetree can be defined in a .ptree source file this way: ``` racket #lang pollen first.html second.html third.html ``` Whereas a hierarchical pagetree just uses the ◊ command syntax to add nested levels, e.g.: ``` racket #lang pollen ◊first-section-first-page.html{ first-subsection-first-page.html first-subsection-second-page.html} ◊second-section-first-page.html{ ◊second-subsection-first-page.html{ first-subsubsection-first-page.html}} ``` And so forth.
gfrey commented 10 years ago (Migrated from github.com)

Nice. Thanks!

Nice. Thanks!
mbutterick commented 10 years ago (Migrated from github.com)

Improved pagetree docs are here, or you can do raco pkg update pollen and they will be added to your installation.

Improved pagetree docs [are here](http://mbutterick.github.io/pollen/doc/Pagetree.html), or you can do `raco pkg update pollen` and they will be added to your installation.
Sign in to join this conversation.
No Label
No Milestone
No project
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: mbutterick/pollen#16
Loading…
There is no content yet.