X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=html-doc%2Fmanual.html;h=743d81e73230c555f877b397fddc25a372f9d29a;hb=9f09269d8918dfa930543f4a15de4e7276719e5e;hp=e1036cb86e2378594d171e24543fd3ac894a981b;hpb=a78b442e4b673ac29d7dd29cfb2c9bca6f07130a;p=xournal.git diff --git a/html-doc/manual.html b/html-doc/manual.html index e1036cb..743d81e 100644 --- a/html-doc/manual.html +++ b/html-doc/manual.html @@ -24,7 +24,7 @@ Xournal User's Manual

- Version 0.2.1 + Version 0.4.7


@@ -38,13 +38,13 @@

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

Xournal aims to provide superior graphical quality (subpixel resolution) and overall - functionality; however it lacks the collaborative features of Jarnal. - Since Xournal is still in its early development stages, it may not - be fully stable, and some features have not been implemented yet. + functionality; however various advanced features have not been implemented + yet.

Table of contents

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

  • The drawing and selection tools
  • Pages, layers, and backgrounds
  • Printing
  • +
  • Configuration file
  • Author information, license, bug-reports
  • Version history
  • The file format
  • @@ -77,7 +78,7 @@ Xournal can be downloaded at

    -Refer the next few sections of this manual for more information about +Refer to the next few sections of this manual for more information about the various functionalities.


    @@ -93,12 +94,10 @@ the Pen Options submenu of the Tools menu).

    The eraser

    -The eraser lets you erase what you have drawn. If your tablet's stylus -has an eraser tip, and if the XInput extensions are enabled, the eraser -will be automatically selected when drawing with the eraser tip. -Another possibility is to enable the "Emulate Eraser" option in the Options -menu, which lets you use button 2 or 3 on the stylus (mouse middle or right button) -as an eraser.
    +The eraser lets you erase what you have drawn. +By default, stylus buttons 2 and 3 (mouse middle or right buttons) are +mapped to the eraser tool. +
    The eraser comes in three different thicknesses (selected using the thickness toolbar buttons), and can operate in three different modes (Eraser Options submenu of @@ -127,6 +126,37 @@ 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 image tool

    +

    + To insert a new image (from a file on disk), click at the location + where the upper-left corner is to be located. A file selection dialog + box pops up. Alternatively, images can be pasted directly from the + clipboard (without having to select the image tool). In both cases, + the newly inserted image is selected, and can be easily moved or resized + as with any selection. +

    The ruler

    The ruler is not a tool by itself, but rather a special operating mode @@ -134,17 +164,44 @@ the Tools menu): line segments instead of curvy strokes. For simplicity, selecting the ruler when not in pen or highlighter mode automatically selects the pen.

    + +

    The shape recognizer

    +

    + The shape recognizer is also a special + operating mode of the pen and highlighter tools. When it is enabled, + Xournal attempts to recognize geometric shapes as they are drawn, and + if successful will replace the drawn strokes accordingly. The shapes + that can be recognized are: line segments, circles, rectangles, arrows, + triangles and quadrilaterals. Polygonal shapes can be drawn in a single + stroke or in a sequence of consecutive strokes. +

    +

    + The recognizer is set to be as unobtrusive as possible, and should not + interfere too much with handwriting. (It differs in this and other ways + from another shape recognizer written for Xournal by Lukasz Kaiser). + As a result, it may only recognize shapes if you draw them carefully and + deliberately. Specific tips for better recognition: (1) for circles, + a closed curve that isn't quite round works better + than a rounder curve that doesn't close; (2) for arrows, it is better + to lift the pen before drawing the tip of the arrow, and make sure + the tip consists of two straight line segments; + (3) for very elongated rectangles, + recognition tends to be better if you lift the pen between consecutive + sides. +

    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.

    @@ -160,13 +217,22 @@ the Tools menu): All the strokes which are entirely contained within the rectangular region are selected. The selection can be moved within its page by clicking inside the - selection rectangle and dragging the cursor. + selection rectangle and dragging the cursor. If the cursor is dragged + to a different page, the selection will be moved to the topmost layer of + that page.

    The selection can be cut, duplicated, etc. (including to a different page or to a different journal) using the copy-paste toolbar buttons or the corresponding entries of the Edit menu.

    +

    Lasso selection

    +

    + This tool lets you select an irregular shaped region of the current layer. + All the items which are entirely contained within the given region + are selected. As with the rectangle selection tool, the selection can be moved, + resized, copied and pasted. +

    Vertical space

    This tool lets you insert or remove vertical space within the page: @@ -182,6 +248,19 @@ the Tools menu): space, or change the page height to an appropriate value (using the "Paper Size" entry in the Journal menu).

    +

    + If you drag the cursor below the bottom of the page (so that the + entire block being moved has become invisible), the items will be moved + to the next page (topmost layer); however, any items that were already + present on the next page are left unchanged. Similarly, dragging the + 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, @@ -190,6 +269,41 @@ the Tools menu): the corresponding entries in the Edit menu.
    There is no limit to the depth of the undo/redo stack. It is cleared only when you quit the application or open a new journal. +

    + +

    Button mappings

    +

    + Stylus buttons 2 and 3 (mouse middle and right buttons) can be mapped + to different tools using the appropriate submenus in the Options menu + (whereas the Tools menu and the toolbar buttons affect the primary tool + assigned to button 1). The default mapping is the eraser. +

    +

    Advanced configuration: + if a secondary button is mapped to a drawing tool (pen, eraser, or + highlighter), the default is to "dynamically link" its settings to those + of the primary tool, which means that each drawing tool has common + settings (color, thickness, etc.) for all buttons. + Dynamic linking of brush settings + can be disabled by selecting the "Copy of current brush" option in the + "Button mapping" submenu. The settings of the tool for button 2 or 3 are + copied from the button 1 settings at the time when you select the option, + and afterwards they are no longer updated when the button 1 settings are + modified, thus making it possible to assign pens of different colors or + thicknesses to different buttons. +

    +

    + Another option that affects button mappings is the "Eraser tip" option. + If this option is turned on and the XInput extensions are enabled, then + the eraser tip of your tablet's stylus will automatically be remapped to + the eraser tool. This behavior, which overrides all other button mappings, + is most useful if your X server is configured to map the eraser tip of + your tablet's stylus to button 1. +

    +

    + Also note the "Buttons switch mappings" option, which may be useful to + users of external tablets: when this option is turned on, buttons 2 and 3 + only switch the tool mapping, and drawing is still done with button 1. +


    Pages, layers, and backgrounds

    @@ -295,8 +409,9 @@ resizes the current page according to the size of the bitmap image, and resets the zoom level to 100%. If ghostscript is installed on your system, you can also use this method to import a fixed-resolution bitmap version of a Postscript or PDF file; in that case, all pages will be -imported sequentially as backgrounds into consecutive pages (this is not the -recommended method; PDF annotation is better in many respects). +imported sequentially as backgrounds into consecutive pages (this is +not the +recommended method; PDF annotation is better in every respect).

    To capture a screenshot of a window or the entire screen and make it @@ -317,29 +432,15 @@ ghostscript) are automatically "attached" to the journal file: when the journal is saved, they will be saved (in PNG format) along with it (using file names of the form *.xoj.bg_*.png).

    -

    -Rescaling and anti-aliasing: by default, -bitmap backgrounds are rescaled and anti-aliased as needed when the zoom -level is changed, to ensure their appearance always remains acceptable. -Because this consumes a lot of memory and CPU resources, by default this -rescaling is performed on-demand as each page becomes visible. This means -that you will occasionally notice bitmap backgrounds being smoothed while -you are scrolling inside the document (at large zoom levels, this can slow -down the screen refresh rate noticeably). If you'd prefer all backgrounds to -be rescaled immediately upon changing the zoom level (slower but maybe more -intuitive), disable the "Progressive Backgrounds" option in the Options -menu.
    -If you are handling large bitmaps, you can save memory and CPU resources (at the -expense of quality) by disabling the "Antialiased Bitmaps" option in the Options menu. -

    PDF annotation

    Xournal can be used to annotate PDF files, by loading the pages of a PDF -file as backgrounds for a journal. This feature requires the -pdftoppm converter to be installed (this is part of the xpdf - PDF file viewer). +file as backgrounds for a journal. As of version 0.4.5 this is done using +the poppler library (previous versions used the +pdftoppm converter, which is part of the xpdf utilities or +the poppler utilities depending on distributions).

    The "Annotate PDF" command in the File menu can be used to load a PDF file @@ -366,9 +467,10 @@ become visible on the screen (unless you disable the "Progressive Backgrounds" option in the Options menu). This means that you will occasionally notice the page backgrounds being updated while you are scrolling inside the document (at large zoom levels, it can take a while -for the updated background to appear). However, since the backgrounds are -generated asynchronously by a separate Unix process, you can keep drawing in the journal -while the update process is still in progress. +for the updated background to appear). +

    It is strongly recommended that you do not resize PDF pages (using the @@ -384,72 +486,426 @@ possible to include pages from more than one PDF file into a single journal document. If you need to annotate two or more PDF files inside a same journal document, please consider using an external utility for merging PDF files (for example pdfmerge). +

    +

    +Note: the PDF backgrounds are +rescaled and/or regenerated as needed when the zoom level is changed. +Because this consumes a lot of memory and CPU resources, by default this +rescaling is performed on-demand as each page becomes visible. This means +that you will occasionally notice backgrounds being generated while +you are scrolling inside the document (at large zoom levels, this can slow +down the screen refresh rate noticeably). If you'd prefer all backgrounds to +be loaded in advance and rescaled immediately upon changing the zoom level, +disable the "Progressive Backgrounds" option in the Options menu. Be aware +that this increases the memory consumption and will cause out-of-memory +crashes when viewing long documents. +

    +

    Printing

    -Xournal uses the gnome-print architecture for printing. While it is very -powerful, some aspects of the API leave to be desired, -and future versions of Xournal will probably also include a native -Postscript/PDF printing feature. +As of version 0.4.5, Xournal uses the gtk-print architecture for printing +(previous versions used gnome-print). Xournal also includes a native PDF +printing feature.

    +

    Printing via gtk-print

    -The "Printer" tab of the print dialog box lets you select a printer -(either one of the printers installed on your system, or the generic -Postscript printer, or the PDF virtual printer). The "Job" tab lets you -select a range of pages to print (the default is to print the entire -journal). The "Paper" tab lets you select the paper size. Each page +The print dialog box lets you select a printer +(either one of the printers installed on your system, or the "Print to File" +virtual printer), and a range of pages to print (the default is to print +the entire journal). Each page of the journal is automatically rescaled so as to fit the paper size. -(minus a 5% margin all around). +

    +

    +Unlike the older gnome-print architecture, gtk-print and poppler make it +possible to efficiently print files that annotate PDF backgrounds. (Prior to +version 0.4.5, PDF backgrounds had to be converted to bitmaps upon printing, +resulting in huge print jobs and low printout quality).

    The settings are currently not saved properly from one print job to -the next, so make sure to select the appropriate printer and verify -the paper size. When printing to a file (Postscript or PDF), Xournal -attempts to pre-fill the output file name (for the Postscript driver -this often fails due to gnome-print API issues). +the next, so make sure to verify the settings. +

    +

    Exporting to PDF

    +

    +Xournal also provides its own PDF rendering +engine. The "Export to PDF" command (in the File menu) produces a +PDF-1.4 file from the currently loaded document. The pages of the +resulting PDF file 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). Text items are rendered by embedding +TrueType subsets or Type 1 fonts into the PDF document as appropriate.

    -The "Print to PDF" entry of the File menu directly generates a PDF file -using the PDF virtual printer, without bringing up the dialog box -(the page size is the default one for that printer, usually A4). -Note that the PDF virtual printer produces files that are very large -and far from optimal, so in the current state of things it is better -to generate a Postscript file and use a converter such as ps2pdf. +Xournal includes a PDF file parser compatible with PDF format +version 1.4; the compression features of PDF 1.5 are +not supported. When exporting a document that uses PDF +backgrounds, Xournal attempts to preserve most of the structure of +the original PDF file (however, auxiliary data such as thumbnails, hyperlinks, +and annotations are lost). If Xournal is unable to parse the PDF +file, the backgrounds are converted to (compressed) bitmaps and a new +PDF file is generated from scratch.

    +
    + +

    Configuration file

    -The gnome-print architecture also forces page backgrounds (bitmaps -and PDF) to be generated as uncompressed bitmaps, which leads to gigantic -print job files. An alternative to gnome-print will be -implemented in a future release of Xournal. +Xournal's configuration settings are saved to the 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, ... +

    +

    Here is a partial list of configuration file settings: +

    +


    Author information, license, bug-reports

    Xournal is written by Denis Auroux -(auroux@math.mit.edu). -
    It is distributed under the GNU General Public License. +(auroux@math.berkeley.edu). +

    +

    +The source code includes contributions by the following people: +Alvaro, Kit Barnes, Eduardo de Barros Lima, Mathieu Bouchard, +Ole Jørgen Brønner, Robert Buchholz, Vincenzo Ciancia, Luca de Cicco, +Michele Codutti, Robert Gerlach, Daniel German, Dirk Gerrits, Simon Guest, +Lukasz Kaiser, Ian Woo Kim, Timo Kluck, David Kolibac, Danny Kukawka, +Stefan Lembach, Bob McElrath, Andy Neitzke, David Planella, Marco Poletti, +Alex Ray, Jean-Baptiste Rouquier, Victor Saase, Marco Souza, Mike Ter Louw, +Uwe Winter, Lu Zhihe. +

    +

    (Let me know if you are missing from this list or +if your name is mis-spelled)

    +

    +Xournal is distributed under the GNU General Public License (version 2, or +at your option any later version). +

    +

    + Note: most of the code of version 0.4.2.1 + (excluding graphics and a few portions of the code) has also been released + under the MIT License. Please contact the main developer if + you need an MIT License version of the 0.4.2.1 code. Later versions are + not available under MIT License.

    Feel free to contact me with bug reports and suggestions; I apologize in advance if I am unable to respond properly to some requests. -List of known bugs/misfeatures (no need to report them again): -

    If you find a sequence of operations which crashes Xournal in a reproducible manner, please send detailed instructions on how to reproduce the crash. A core file may also be helpful.

    +

    +Bug reports and suggestions can also be submitted on Xournal's +SourceForge page. +


    Version history

    -Version 0.2.1 (Jun 3, 2006): +Version 0.4.7 (July 4, 2012): +

    +

    +

    +Version 0.4.6 (May 22, 2012): +

    +

    +

    +Version 0.4.5 (Oct 2, 2009): +

    +

    +

    +Version 0.4.2.1 (Mar 27, 2008): +

    +

    +

    +Version 0.4.2 (Mar 25, 2008): +

    +

    +

    +Version 0.4.1 (Sep 15, 2007): +

    +

    +

    +Version 0.4.0.1 (September 3, 2007): +

    +

    +

    +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): +

    +

    +

    +Version 0.2.2 (June 5, 2006): +

    +

    +

    +Version 0.2.1 (June 3, 2006):