Hi,
It is now possible to break up egg documentation into several pages. This was
previously possible on the wiki, but is now supported by chicken-doc as well.
Procedure: instead of creating a file, create a directory and populate it with subpage
files. To document the main page, call the page "index".
Example:
allegro/color
allegro/display
allegro/index
chicken-doc-admin supports directories and will automatically recurse. It also
works with the host-installed eggs option.
Notes:
- You should probably create at least a stub "index" file because otherwise the
main page will 404.
- It's a good idea to place links to the subpages on the main page. chickadee
will automatically pick up subpages and place them in the contents bar, but the
wiki will not.
- All subpages are considered "eggs", which means:
- It may confuse users who expect each doc page to correspond to exactly one egg,
unit or module -- there is no "allegro color" egg for example.
- Subpages will show up in a chicken-doc identifier or egg search, which
may be confusing or annoying.
There may eventually need to be a way to tag a page as something other than an
egg for chicken-doc, but that doesn't exist yet.
Jim
_______________________________________________
Chicken-users mailing list
address@hidden
https://lists.nongnu.org/mailman/listinfo/chicken-users