jwilk-archive / djvusmooth

graphical editor for DjVu
GNU General Public License v2.0
12 stars 2 forks source link

Improve manual page #22

Open jwilk opened 5 years ago

jwilk commented 5 years ago

Long time ago, Maxim Leyenson proposed some updates to the manual page. Better documentation is very much needed, but I never got around into integrating the proposed text. :-/ I'm pasting it here so that it won't be lost:

NAME

       djvusmooth is a GUI (Graphical User Interface)
DjVu file editor. 

SYNOPSIS

    djvusmooth [file]

DESCRIPTION

     djvusmooth allows one to add (or  edit) a table of contents (TOC)
of a  DjVu document, and add  or edit hyperlink within  the document.
djvusmooth  supports  sub-bookmarks,  and Unicode  characters  in  the
bookmark names. 

USAGE

When opening a  DjVu file, three tabs  appear on the left  side of the
window, called "Outline", "Hyperlinks" and "Text".

The "Outline"  section contains  the table of  contents (TOC)  for the
DjVu file.  

The section  "Hyperlinks" contains  page numbers for  which hyperlinks
within the file have been created.

* Navigating the document

    * Ctrl-g   -- Go to a page with a given number
    * PgUp, PgDown
    * go to a specific bookmarked page:
       choose a bookmark in the "Outline" section,
       and press "Enter".

* Adding bookmark to a DjVu file

    * go to a page you want to bookmark with Ctrl-G command,
      or by navigating the document using PgUp and PgDown.

    * Press Ctrl-B to bookmark the page. A new bookmark with the title
      "(no title)"  will appear on the  left side of the  screen under
      the "Outline" tab.

    * Rename  the bookmark: click once  with the left mouse  button on
    the current title ("no title"), edit the name, and press Enter.

* Reorganizing bookmarks in a DjVu file.
    One  can move  around bookmarks  under  the "Outline"  tag with  a
    mouse. 
    Also, see the discussion on moving bookmarks around here:
    https://bitbucket.org/jwilk/djvusmooth/issue/1/

* Renaming bookmarks
    Press once with  the left mouse click on the  bookmark title, edit
    the name, and press Enter.

* Removing bookmarks.
    Select a bookmark under the "Outline" tab and press the "Del"
    keyoard button. 

    Warning: The  "Edit-> Outline ->  Remove" menu option  removes the
    outline  (callection  of all  the  bookmarks)  on the  DjVu  file.
    This can lead to a  confusion when a specific bookmark is
    selected,  since in  this case  the  command will  remove all  the
    bookmarks as well, and not just the selected bookmark. 

HYPERLINKS 

* Adding a hyperlink inside a DjVu document.

   Say, page #1 of the  document has a table of contents (TOC) for
   the document, which looks like

        TOC           page 1
        Chapter 1     page 10
        Chapter 2     page 20
        ....

    and we want to  add a hyperlink from the line  "Chapter 2" to page
    20 where the chapter 2 starts,  so that when one mouse-clicks on a
    line named "Chapter  2" in the TOC, one is redirected to the page
    #20 in the document.

    * Choose "Hyperlinks" tab in the left-side menu.
    * Point  the mouse on  the line  "Chapter 2" and  right-click. A
      pop-up  "New Hyperlink"  appears. Mouse-click  on the  words "New
      Hyperlink"
    * A new menu with hyperlink details appears. 
      Under the URI section, put "#20", so that the line "Chapter 2"
      will be linked to the page #20 in the DjVu document.
    * Border type: select "XOR" and "always visible"
      (more variants are explained below). 
    * Press OK to create the hyperlink.
    * Now, a small blue square is visible on the line
      "Chapter 2". One can move it with mouse, and then left-click
      on it to change the shape. Change the shape to create a
      rectangle going around the line "Chapter 2", and left-click
      on the rectangle again. 
    * Now,  when one saves the  file (Ctrl-S) and opens  it again with
    the  DjView browser,  a  small grey  rectangle  is visible  around
    the  line  "Chapter 2".  If  one  hovers  over  this line  with  a
    mouse, DjView  shows "Go: page  20" in  the bottom of  its window.
    Left-clicking anywhere in  the middle of this  rectangle makes the
    DjView go to the page #20 directly.

    Other options: XOR, not selecting "always visible": the outline of
    the hyperlink  becomes visible  only when  mouse hovers  over this
    line.

CREDITS
     djvusmooth is written by Jakub Wilk <jwilk@jwilk.net>

Current version: 0.2.11 (February 2012)

License: GPL-2

BUGS
   Please report any bugs here:
     https://bitbucket.org/jwilk/djvusmooth