Manual HTML
Manual HTML is the specification for the eBook GUI. This includes the eBook toolbar, the HTML links, etc.
Blueprint information
- Status:
- Started
- Approver:
- None
- Priority:
- Essential
- Drafter:
- Jacob Litewski
- Direction:
- Approved
- Assignee:
- Jacob Litewski
- Definition:
- Drafting
- Series goal:
- Accepted for prototype
- Implementation:
-
Slow progress
- Milestone target:
-
0.2
- Started by
- Jacob Litewski
- Completed by
Related branches
Related bugs
Sprints
Whiteboard
TODO: (Updated 05/09/2009)
==========
Add the eBook Toolbar
Make/Perfect .xml parsing for TOC.xml documents
Enable/Disable buttons if Params are/are not present
Make the buttons work
Implement it (Partial implement in trunk)
COMMENTS:
==========
DISCUSSION:
==========
The eBook GUI is an extremely simplistic tool bar containing a Back Button, a Forward Button, and an Index Button. This will be enabled when a HTML tag with a command Manual recognizes is passed through the HTML renderer. It will be disabled all other times.
The 'Official' link between Manual and HTML pages is the <link> HTML tag in the <head> section of a HTML Document. Usage is as follows:
<link type="linux/manual" prev="foo.html" next="bar.html" toc="toc.xml" />
where 'foo.html' is the path to the previous page, if any, 'bar.html' is the path to the next page, if any, and 'toc.xml' is the path to the Table of Contents, if any.
I haven't tested this feature fully yet, since it is still being coded into Manual's GUI. The eBookParser class does recognize the format of the <link> tag though.
