diff options
Diffstat (limited to 'help/C')
| -rw-r--r-- | help/C/adf.page | 52 | ||||
| -rw-r--r-- | help/C/crop.page | 45 | ||||
| -rw-r--r-- | help/C/dpi.page | 57 | ||||
| -rw-r--r-- | help/C/email.page | 24 | ||||
| -rw-r--r-- | help/C/figures/icon.png | bin | 0 -> 1559 bytes | |||
| -rw-r--r-- | help/C/figures/preferences.png | bin | 0 -> 14340 bytes | |||
| -rw-r--r-- | help/C/figures/scan_toolbar.png | bin | 0 -> 11975 bytes | |||
| -rw-r--r-- | help/C/index.page | 34 | ||||
| -rw-r--r-- | help/C/legal.xml | 9 | ||||
| -rw-r--r-- | help/C/print.page | 30 | ||||
| -rw-r--r-- | help/C/reorder.page | 21 | ||||
| -rw-r--r-- | help/C/rotate.page | 57 | ||||
| -rw-r--r-- | help/C/save.page | 68 | ||||
| -rw-r--r-- | help/C/scanner.page | 20 | ||||
| -rw-r--r-- | help/C/scanning.page | 35 |
15 files changed, 452 insertions, 0 deletions
diff --git a/help/C/adf.page b/help/C/adf.page new file mode 100644 index 0000000..91886ce --- /dev/null +++ b/help/C/adf.page @@ -0,0 +1,52 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="guide" + id="adf"> + + <info> + <link type="guide" xref="index#acquire"/> + </info> + + <title>Using an Automatic Document Feeder</title> + + <p> + If your scanner features an Automatic Document Feeder (ADF) + you can scan all the pages from the feeder via one of following methods: + </p> + <steps> + <title></title> + <title>Use a Keyboard Shortcut</title> + <item> + <p>Press <keyseq><key>Ctrl</key><key>F</key></keyseq></p> + </item> + </steps> + + <steps> + <title>Use a Menu</title> + <item> + <p>Navigate to <guiseq><gui>Document</gui> + <gui>Scan</gui><gui>All Pages From Feeder</gui></guiseq>. + </p> + </item> + </steps> + + <steps> + <title>Use the Toolbar Buttons</title> + <item> + <p>Click on the arrow to the right of the "Scan" button.</p> + </item> + <item> + <p>Choose "All Pages From Feeder".</p> + <media type="image" src="figures/scan_toolbar.png"/> + </item> + </steps> + + + <note style="tip"> + <p> + By default, both sides of a sheet will scan if your scanner has this capability. + You can choose single side scanning from the <guiseq><gui>Document</gui><gui>Preferences</gui></guiseq> menu. + </p> + <media type="image" src="figures/preferences.png"/> + </note> + +</page> diff --git a/help/C/crop.page b/help/C/crop.page new file mode 100644 index 0000000..b65893e --- /dev/null +++ b/help/C/crop.page @@ -0,0 +1,45 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="guide" + id="crop"> + + <info> + <link type="guide" xref="index#modify"/> + </info> + + <title>Cropping</title> + + <p> + The cropping feature in <app>Simple Scan</app> allows you to use only a part of a scanned image. You can + enable crop either before or after scanning a page, and you can always change the dimensions of the crop + frame. When crop is enabled, a mask will apper over the current page with the area not being used shown + in gray. You can enable crop and choose the desired dimensions via one of the following methods: + </p> + + <steps> + <title>Use a Right Click</title> + <item><p>Right click anywhere on the image area and select "Crop".</p></item> + <item><p>Choose one of the fixed crop frames, or select "Custom" to manually + set the crop frame's dimensions by dragging its borders.</p></item> + <item><p>Click and hold the frame, then move it to the desired position.</p></item> + </steps> + + <steps> + <title>Use a Menu</title> + <item><p>Navigate to the <guiseq><gui>Page</gui><gui>Crop</gui></guiseq> menu.</p></item> + <item><p>Choose one of the fixed crop frames, or select "Custom" to manually adjust the frame's dimensions by dragging its borders.</p></item> + <item><p>Click and hold the frame, then move it to the desired position.</p></item> + </steps> + + <steps> + <title>Use the Toolbar</title> + <item><p>Click the "<gui>Crop</gui>" button in the toolbar.</p> + <note style="tip"><p>This is the same as choosing "Custom" in step 2 of the + aforementioned methods.</p></note></item> + <item><p>Drag the borders of the frame to set the desired dimensions and position.</p></item> + + </steps> + + <note><p> + Each new scanned page will use the previous crop. + </p></note> +</page> diff --git a/help/C/dpi.page b/help/C/dpi.page new file mode 100644 index 0000000..ea8deeb --- /dev/null +++ b/help/C/dpi.page @@ -0,0 +1,57 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="guide" + id="dpi"> + + <info> + <link type="guide" xref="index#acquire"/> + </info> + + <title>Setting the Scan Resolution</title> + + <p> + The default resolution for document type <gui><em>Text</em></gui> is 150 dpi (dots per inch) + and for document type <gui><em>Photo</em></gui> is 300 dpi. You can change these settings + from the <guiseq><gui>Document</gui><gui>Preferences</gui></guiseq> menu. + </p> + <media type="image" src="figures/preferences.png"/> + + <p>The available scanning resolutions for both document types (Text and Photo) are the same + and are listed in the following table:</p> + + <table frame="bottom left right" rules="rows cols" shade="rows"> + <tr> + <td><p><em>Text Resolution</em></p></td> + <td><p><em>Photo Resolution</em></p></td> + </tr> + <tr> + <td><p>75 dpi (draft)</p></td> + <td><p>75 dpi (draft)</p></td> + </tr> + <tr> + <td><p>150 dpi (default)</p></td> + <td><p>150 dpi</p></td> + </tr> + <tr> + <td><p>300 dpi</p></td> + <td><p>300 dpi (default)</p></td> + </tr> + <tr> + <td><p>600 dpi</p></td> + <td><p>600 dpi</p></td> + </tr> + <tr> + <td><p>1200 dpi (high resolution)</p></td> + <td><p>1200 dpi (high resolution)</p></td> + </tr> + <tr> + <td><p>2400 dpi</p></td> + <td><p>2400 dpi</p></td> + </tr> + </table> + + <note style="important"><p><gui><em>Text</em></gui> documents are always scanned in black + and white, while <gui><em>Photo</em></gui> documents are always scanned in color, at any + resolution!</p> + </note> + +</page> diff --git a/help/C/email.page b/help/C/email.page new file mode 100644 index 0000000..e918e84 --- /dev/null +++ b/help/C/email.page @@ -0,0 +1,24 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="guide" + id="email"> + + <info> + <link type="guide" xref="index#use"/> + </info> + + <title>Sending via Email</title> + + <p> + To email the current document use the <guiseq><gui>Document</gui><gui>Email</gui></guiseq> + menu (<keyseq><key>Ctrl</key><key>E</key></keyseq>). Your email program will be opened with + a new message containing the scanned document as an attachment. + </p> + <p> + If the document type was set to "Text" the email will have a PDF attachment for each page. + Conversely, if the document type was set to "Photo", the email will have a JPEG + attachment for each page. + </p> + <p> + See <link xref="save"/> for more information about file formats. + </p> +</page> diff --git a/help/C/figures/icon.png b/help/C/figures/icon.png Binary files differnew file mode 100644 index 0000000..8cfefc1 --- /dev/null +++ b/help/C/figures/icon.png diff --git a/help/C/figures/preferences.png b/help/C/figures/preferences.png Binary files differnew file mode 100644 index 0000000..fe3bbe1 --- /dev/null +++ b/help/C/figures/preferences.png diff --git a/help/C/figures/scan_toolbar.png b/help/C/figures/scan_toolbar.png Binary files differnew file mode 100644 index 0000000..7736d68 --- /dev/null +++ b/help/C/figures/scan_toolbar.png diff --git a/help/C/index.page b/help/C/index.page new file mode 100644 index 0000000..c9d8425 --- /dev/null +++ b/help/C/index.page @@ -0,0 +1,34 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="guide" + id="index"> + + <info> + <credit type="author"> + <name>Robert Ancell</name> + <email>robert.ancell@gmail.com</email> + </credit> + <credit type="author"> + <name>Ali Shtarbanov</name> + <email>ametedinov@gmail.com</email> + </credit> + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude" /> + </info> + + <title><media type="image" src="figures/icon.png"/> Simple Scan Manual</title> + + <section id="acquire" style="2column"> + <title>Scanning Pages</title> + </section> + + <section id="modify" style="2column"> + <title>Modifying the Document</title> + </section> + + <section id="use" style="2column"> + <title>Using the Document</title> + </section> + + <section id="shortcuts" style="2column"> + <title>Simple Scan Shortcuts</title> + </section> +</page> diff --git a/help/C/legal.xml b/help/C/legal.xml new file mode 100644 index 0000000..86d6173 --- /dev/null +++ b/help/C/legal.xml @@ -0,0 +1,9 @@ +<license xmlns="http://projectmallard.org/1.0/" + href="http://creativecommons.org/licenses/by-sa/3.0/"> +<p>This work is licensed under a +<link href="http://creativecommons.org/licenses/by-sa/3.0/">Creative Commons +Attribution-Share Alike 3.0 Unported License</link>.</p> +<p>As a special exception, the copyright holders give you permission to copy, +modify, and distribute the example code contained in this document under the +terms of your choosing, without restriction.</p> +</license> diff --git a/help/C/print.page b/help/C/print.page new file mode 100644 index 0000000..5c7794a --- /dev/null +++ b/help/C/print.page @@ -0,0 +1,30 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="guide" + id="print"> + + <info> + <link type="guide" xref="index#use"/> + </info> + + <title>Printing</title> + + <p> + <app>Simple Scan</app> allows you print a scanned document directly from the its + interface, without having to save the document first. This feature makes <app>Simple + Scan</app> a very convenient tool for making copies of documents or photos. + </p> + <steps> + <title>To Print a Document</title> + <item> + <p>Go to the <guiseq><gui>Document</gui><gui>Print</gui> + </guiseq> menu or use the keyboard shortcut <keyseq><key>Ctrl</key><key>P</key></keyseq>. + This will open the "Print" dialog box. + </p> + </item> + <item> + <p>From the "Print" dialog box choose your desired printing settings and/or Print Preview + the document, then press the "Print" button. + </p> + </item> + </steps> +</page> diff --git a/help/C/reorder.page b/help/C/reorder.page new file mode 100644 index 0000000..f816acb --- /dev/null +++ b/help/C/reorder.page @@ -0,0 +1,21 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="guide" + id="reorder"> + + <info> + <link type="guide" xref="index#modify"/> + </info> + + <title>Reordering Pages</title> + + <p> + To move a page, right click on it and choose <gui><em>Move Left</em></gui> or + <gui><em>Move Right</em></gui>. + </p> + + <p> + Alternatively, you can move a page by first selecting it and then choosing + <gui><em>Move Left</em></gui> or <gui><em>Move Right</em></gui> from the "Page" menu. + </p> + +</page> diff --git a/help/C/rotate.page b/help/C/rotate.page new file mode 100644 index 0000000..b64c69f --- /dev/null +++ b/help/C/rotate.page @@ -0,0 +1,57 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="guide" + id="rotate"> + + <info> + <link type="guide" xref="index#modify"/> + </info> + + <title>Rotating a Page</title> + + <p> + In <app>Simple Scan</app>, you can change the rotation of a page either before or after scanning the page. + Currently, there are four ways to rotate a page: + </p> + + <steps> + <title>Use Toolbar Buttons</title> + <item><p>Select the page you want to rotate by clicking on it once.</p></item> + <item><p>Press one of the arrows on the toolbar to rotate the page in the desired direction.</p></item> + </steps> + <steps> + <title>Use Right Click</title> + <item><p>Right click on the page you want to rotate.</p></item> + <item><p>From the context menu choose "Rotate Left" or "Rotate Right".</p></item> + </steps> + + <steps> + <title>Use a Menu</title> + <item><p>Select the page you want to rotate by clicking on it once.</p></item> + <item><p>Click the "Page" menu and select "Rotate Left" or "Rotate Right".</p></item> + </steps> + + <steps> + <title>Use Shortcuts</title> + <item><p>Select the page you want to rotate by clicking on it once.</p></item> + <item><p>Press one of the following shortcut keys:</p> + <table frame="bottom left right" rules="rows cols" shade="rows"> + <tr> + <td><p><em>Command</em></p></td> + <td><p><em>Shortcut Key</em></p></td> + </tr> + <tr> + <td><p>Rotate Left</p></td> + <td><p><key>[</key> (left bracket)</p></td> + </tr> + <tr> + <td><p>Rotate Right</p></td> + <td><p><key>]</key> (right bracket)</p></td> + </tr> + </table> + </item> + </steps> + + <note><p> + Each new scanned page will use the previous rotation. + </p></note> +</page> diff --git a/help/C/save.page b/help/C/save.page new file mode 100644 index 0000000..575c36a --- /dev/null +++ b/help/C/save.page @@ -0,0 +1,68 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="guide" + id="save"> + + <info> + <link type="guide" xref="index#use"/> + </info> + + <title>Saving to a File</title> + + <steps> + <item> + <p>Navigate to the <guiseq><gui>Document</gui><gui>Save As</gui></guiseq> menu + (or press <keyseq><key>Shift</key><key>Ctrl</key><key>S</key></keyseq>). + </p> + </item> + <item> + <p>From the "Save As" dialog box, choose one of the supported file + types, or simply change the extension in the "Name" field. + </p> + </item> + <item> + <p>Press the "Save" button.</p> + </item> + </steps> + + +<table frame="bottom left right top" rules="rows cols" shade="rows"> + <title>Supported File Types</title> + <tr> + <td><p><em>Type</em></p></td> + <td><p><em>Brief Description</em></p></td> + </tr> + <tr> + <td><p>PDF</p></td> + <td><p>A PDF can contain multiple pages, like a book, and is easy to distribute. Only a small number + of linux programs can modify PDF documents, so this format is recommended primarily for archiving. + See the <link href="http://en.wikipedia.org/wiki/pdf">PDF Wiki page</link> for more information. + </p></td> + </tr> + <tr> + <td><p>JPEG</p></td> + <td><p>JPEG is the file format used by digital cameras to save pictures. A JPEG file is relatively + small, very easy to distribute, and suitable for uploading to social networking sites. Most operating + systems come with a JPEG editor by default. If you have scanned multiple pages, a JPEG file will be + created for each page. Use this file type if you want to modify or upload the scanned images. + See the <link href="http://en.wikipedia.org/wiki/jpeg">JPEG Wiki page</link> for more information. + </p></td> + </tr> + <tr> + <td><p>PNG</p></td> + <td><p>PNG files contain the raw data from the scanner. This makes them very large and not suitable + for distributing. If you have scanned multiple pages, a PNG file will be created for each page. + See the <link href="http://en.wikipedia.org/wiki/Portable_Network_Graphics">PNG Wiki page</link> + for more information. + </p></td> + </tr> + <tr> + <td><p>TIFF</p></td> + <td><p>TIFF files contain the raw data from the scanner. This makes them very large and not suitable + for distributing. If you have scanned multipe pages, a TIFF file will be created for each page. + See the <link href="http://en.wikipedia.org/wiki/Tagged_Image_File_Format">TIFF Wiki page</link> + for more information. + </p></td> + </tr> + +</table> +</page> diff --git a/help/C/scanner.page b/help/C/scanner.page new file mode 100644 index 0000000..3762cc1 --- /dev/null +++ b/help/C/scanner.page @@ -0,0 +1,20 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="guide" + id="scanner"> + + <info> + <link type="guide" xref="index#acquire"/> + </info> + + <title>Selecting a Scanner</title> + + <p> + If you have multiple scanning devices you can change the selected device from the <guiseq><gui>Document</gui><gui>Preferences</gui></guiseq> menu. + </p> + <media type="image" src="figures/preferences.png"/> + <p> + Your local scanners are automatically detected each time you start <app>Simple Scan</app> + and each time you plug in a USB scanner. If you connect a network scanner while <app>Simple Scan</app> + is running, you will need to restart <app>Simple Scan</app> for the scanner to be detected. + </p> +</page> diff --git a/help/C/scanning.page b/help/C/scanning.page new file mode 100644 index 0000000..c48a99d --- /dev/null +++ b/help/C/scanning.page @@ -0,0 +1,35 @@ +<page xmlns="http://projectmallard.org/1.0/" + type="guide" + id="scanning"> + + <info> + <title type="sort">0</title> + <link type="guide" xref="index#acquire"/> + </info> + + <title>Scanning a Page</title> + + <p> + To scan a document from your scanner: + </p> + <steps> + <item><p>Connect the scanner to your computer and power it on.</p></item> + <item><p>Open <app>Simple Scan</app>.</p></item> + <item><p>Click the arrow to the right of the "Scan" button and choose the type + of document you are scanning: <em>Photo</em> or <em>Text</em>.</p> + <media type="image" src="figures/scan_toolbar.png"/></item> + <item><p>Click the "Scan" button on the toolbar (or press <keyseq><key>Ctrl</key><key>1</key></keyseq>).</p></item> + </steps> + + <note><p> + The page will be shown as it is scanned. To stop the scan at any time press the <key>Esc</key> + key on the keyboard. Each page you scan is placed at the end of the document. + </p></note> + + <p> + The document type can be also be changed from the <guiseq><gui>Document</gui> + <gui>Scan</gui></guiseq> menu. Choose <gui><em>Text</em></gui> if you want the document + to be quickly scanned in black and white; choose <gui><em>Photo</em></gui> for a high + resolution color scan. See <link xref="dpi"/> for more details and more options. + </p> +</page> |
