Introduction
YakBack is a web-based tool for interactively viewing and
commenting on single or multi-page documents.
Each YakBack enabled document has a control bar at the top of
each page. Each section within a page that can be commented on is followed by a
tag:
= A section with
no attached comments.
= A section
with one or more attached comments.
The Control Bar
The control bar at the top of the page allows you to select the
current display mode:
- Hide tags: Do not show any tags.
- Show tags: Show all tags.
- Show comments: Show all tags and attached comments.
When Show tags mode is selected, pointing at a tag
automatically expands the tag, enabling you to see any attached comments.
When the mouse pointer leaves the tag, the comments are hidden again.
If you want the comments to remain visible, click the
tag to lock the comments. Click again to unlock and hide the
comments.
When Show comments mode is selected, all comments are
initially visible. Clicking on a tag hides its comments. Clicking the tag
again makes its comments visible again. In this mode, comments are shown or
hidden only by clicking on a tag, never by just mousing over a tag.
Click the Save preferences link to make your
currently selected display mode the default mode for each new page
displayed.
Click the View page log link to view a summary page of
all comments organized by document page.
Click the View time log link to view a summary page of
all comments ordered from newest to oldest.
Note: On both log pages, you can click on any comment
number (e.g. #3) to link directly back to the page and section the
comment applies to.
Adding a Comment
You can add your own comments to a section by following these
steps:
- Make sure that tags are visible by selecting either the Show tags
or Show comments option in the YakBack control bar.
- If the comments for the section you want to comment on are not already
visible, click the section's tag to make them visible.
- If you do not not see the Add my comment button in the expanded
comment area, click the button at the bottom of comment area to expand the
comment input section.
- Type in your comment and name, then click the Add my comment
button to add your comment to the document.
About YakBack
YakBack enabled documents are produced using the
pydoh
program, a free Python-based program written by David C. Morrill.