X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=html-doc%2Fmanual.html;h=6c5fad88ff37e26d403499403d038265146c2118;hb=2e5ff0bff41fa53d4941b6f0fe49c8914bf29cbc;hp=be75dea015668eb7605e5a7181e92acff986d1b9;hpb=3d2aca5e4781cf52291afc063e37b65f61638df8;p=xournal.git diff --git a/html-doc/manual.html b/html-doc/manual.html index be75dea..6c5fad8 100644 --- a/html-doc/manual.html +++ b/html-doc/manual.html @@ -24,7 +24,7 @@ Xournal User's Manual

- Version 0.3.1 + Version 0.4


@@ -38,6 +38,7 @@

Xournal can be downloaded at +http://xournal.sourceforge.net/ or http://math.mit.edu/~auroux/software/xournal/

@@ -53,6 +54,7 @@ Xournal can be downloaded at

  • The drawing and selection tools
  • Pages, layers, and backgrounds
  • Printing
  • +
  • Configuration
  • Author information, license, bug-reports
  • Version history
  • The file format
  • @@ -125,6 +127,28 @@ the Tools menu): is yellow) and thicknesses. Use the color and thickness toolbar buttons to change these settings.

    +

    The text tool

    +

    + To insert a new text item, click at the location where the text is to be + inserted on the page, then type it in or paste it using the contextual + menu (note: no wrapping is performed). To modify a text item, click inside + it. The font and point size can be modified using the "Text Font" command + in the Tools menu (or the toolbar button). The color is the same as that + currently selected for the pen (and can be modified using the toolbar + buttons). +

    +

    + Text items can contain arbitrary Unicode characters, provided that a + suitable font is installed on your system. However, languages written + in a direction other than left-to-right might not be handled properly. + If a journal contains some items in a font that is unavailable on your + system, another one will be substituted. (Also, text items will be + lost if the document is opened in a version of Xournal prior to 0.4). + Finally, note that the printing and PDF export features only accept + TrueType and Type 1 scalable fonts (do not use any bitmap fonts), and + that the typesetting of the text may be slightly different in the + printout. +

    The ruler

    The ruler is not a tool by itself, but rather a special operating mode @@ -134,15 +158,17 @@ the Tools menu):

    Default tools

    - Each drawing tool (pen, eraser, highlighter) has a default setting - (color, thickness, ...) associated to it. - The "Default Pen", "Default Eraser", and "Default Highlighter" entries of + Each tool (pen, eraser, highlighter, text) has a default setting + (color, thickness, ... for the drawing tools, font and size for the + text tool) associated to it. + The "Default Pen", "Default Eraser", "Default Highlighter", and + "Default Text" entries of the Tools menu select the appropriate tool and reset its settings to the defaults. The toolbar also includes a "Default" button which - resets the currently selected drawing tool to its default settings, + resets the currently selected tool to its default settings, and a "Default Pen" button.
    The "Set As Default" entry of the Tools menu takes the current settings - of the currently selected drawing tool and makes them the new default. + of the currently selected tool and makes them the new default.

    @@ -190,6 +216,11 @@ the Tools menu): cursor above the top of the page so that the entire block being moved becomes invisible results in the items being moved to the previous page.

    +

    Hand tool

    +

    + This tool lets you browse the journal; dragging the cursor scrolls the + view. +

    Undo and redo

    All operations performed on the currently open journal (drawing, erasing, @@ -464,7 +495,8 @@ file is much more compact than those produced via gnome-print, and its pages have the same size as in Xournal. Highlighter strokes are rendered in a partially transparent manner (note however that applications such as xpdf and ghostview do not always handle -PDF transparency properly). +PDF transparency properly). Text items are rendered by embedding +TrueType subsets or Type 1 fonts into the PDF document as appropriate.

    Xournal also includes a PDF file parser compatible with PDF format @@ -477,6 +509,30 @@ file, the backgrounds are converted to (compressed) bitmaps and a new PDF file is generated from scratch.


    + +

    Configuration

    +

    +Starting with version 0.3.2, Xournal's configuration settings can be +saved to a file (~user/.xournal/config) by using the "Save +Preferences" command in the Options menu. The settings saved in the +configuration file include in particular: +

    +The configuration file also gives access to additional customization +options which cannot be set from the user interface, such as: the +display resolution in pixels per inch, the step increment in zoom factors, +the tool selected at startup, the thickness of the various drawing tools, +the default directory for opening and saving files, the visibility and +position of the menu and toolbars, ... +

    +

    Author information, license, bug-reports

    @@ -499,9 +555,43 @@ Bug reports and suggestions can also be submitted on Xournal's

    Version history

    +Version 0.4 (August 15, 2007): +

    +

    +

    +Version 0.3.3 (January 31, 2007): +

    +

    +

    +Version 0.3.2 (November 25, 2006): +

    +

    Version 0.3.1 (August 3, 2006):

    Version 0.3 (July 23, 2006): @@ -567,14 +657,6 @@ Version 0.1.1 (January 5, 2006):

    Version 0.1 (January 2, 2006): initial release.

    -

    -Features yet to be implemented: -

    -


    The file format

    @@ -582,17 +664,21 @@ Features yet to be implemented:

    Xournal stores its data in gzipped XML-like files. The gzipped data consists of a succession of XML tags describing the document. By convention, the -first few lines contain a header in the following format: +file header and trailer look like this:

     <?xml version="1.0" standalone="no"?>
    +<xournal version="...">
     <title>Xournal document - see http://math.mit.edu/~auroux/software/xournal/</title>
    -<xournal version="..."/>
    +... sequence of pages ...
    +</xournal>
     
    The <title> and <xournal> tags may only appear within the file header (not within the pages of the document). The version attribute of the <xournal> tag indicates which version of Xournal was used to create the document; it is currently ignored, but may be used in a later release if the file format changes in an incompatible manner. +(Following a suggestion of Matteo Abrate, starting with version 0.4 the +<xournal> tag is the document's root tag, and encloses all other tags).

    The rest of the file is a sequence of pages, specified by a @@ -666,15 +752,15 @@ page of the PDF file. After the line specifying the background, the remainder of a <page> section is occupied by one or more layer sections

    <layer> ... </layer>
    -describing the various strokes within a layer. Every page must +describing the various items within a layer. Every page must contain at least one layer; a layer may be empty. The successive layers are listed in their stacking order, from bottom to top.

    -A layer consist of a collection of items, listed in the order in which +A layer consists of a collection of items, listed in the order in which they should be drawn (from bottom-most to top-most). -As of the current version, the only legal contents within a layer are +Up to version 0.3.3, the only legal contents within a layer are strokes. The format of a stroke is:

    <stroke tool="..." color="..." width="...">
     ... list of coordinates ...
    @@ -708,6 +794,25 @@ appropriate (otherwise the eraser tool will not interact properly with the
     stroke). The default precision used by Xournal for the x,y coordinates is
     0.01 unit (1/7200 in).
     

    +

    Starting with version 0.4, layers also contain text items. +The format of a text item is: +

    <text font="..." size="..." x="..." y="..." color="...">... text ...</text>
    +
    +The font attribute contains the font name, for example "Serif Bold +Italic"; if the font is not available, another font will be substituted. +The size attribute specifies the font size in points. The x +and y attributes specify the coordinates of the top-left corner +of the text box in page coordinates (measured in points from the top-left +corner of the page). Finally, the color attribute contains either +the name of a standard color or a hexadecimal RGBA value (see above). +

    +

    +The contents of the text are encoded in UTF-8, with the characters +'&', '<', '>' replaced by &amp;, &lt;, +&gt;. Whitespace and linefeeds are preserved (in particular, +no extraneous whitespace should be inserted between the enclosing tags +and the text itself). +


    Installation issues

    @@ -851,6 +956,20 @@ installation instructions specific to your model: for example, the use USB instead; the BottomX and BottomY values correspond to the physical resolution of the tablet and will vary from one model to another.

    +

    +For historical reasons, most X servers do not allow the input device +designated as the "core pointer" in the X server's configuration file +to be used as an XInput extension device. Thus, your tablet input devices +should not be designated as the core pointer device. Instead, they +should be configured with the "SendCoreEvents" option, which enables them +to simultaneously generate XInput extension events and move the cursor on +the screen. Since high-resolution coordinates cannot be obtained for the +core pointer device, it is disabled in Xournal by default. +Starting with version 0.3.3, +it is possible to have core events processed alongside with extension +events (uncheck "Discard Core Events" in the Options menu); however, in +some rare cases this may lead to a loss of resolution on all devices. +

    The cursor doesn't appear in the right place...

    If the mouse pointer does not follow accurately the position of the stylus, @@ -890,19 +1009,20 @@ Do not add a list of xsetwacom commands to your startup files).

    Strokes aren't drawn under the cursor...

    -This is due to misfeatures in the linuxwacom driver. Typically, this -will happen in all of the following cases: +This is due to misfeatures in the linuxwacom driver in versions prior +to 0.7.6. Typically, this will happen in all of the following cases:

    -Future versions of the driver may fix these issues. Meanwhile, you can +Most of these issues should have been fixed in version 0.7.6 of the +wacom driver. Otherwise, you can either disable XInput support in Xournal (in the Options menu), at a price of a severe loss of resolution (and the eraser tip won't be detected anymore), or apply this patch -to the wacom driver. +to version 0.7.0 of the wacom driver.

    I have also had a report that one of the workarounds used by Xournal to @@ -918,8 +1038,8 @@ contact me.

    On-the-fly display rotation

    You need an X server that supports the RANDR extension, and a -patched version of the linuxwacom -driver to support on-the-fly rotation. +recent (0.7.6 or later) or patched +version of the linuxwacom driver to support on-the-fly rotation.

    To set the tablet in portrait mode: @@ -943,12 +1063,14 @@ Exit Xournal and restart it after the display has been rotated. This patch fixes rotation and calibration issues with the linuxwacom driver version 0.7.0.

    +This patch has been included in version 0.7.6 of the linuxwacom driver, +and should now be obsolete.