GNOME.org
 

[file-roller] Added new help pages

commit b5bb038e0eea3d65956435114d5da80cc209631b
Author: Marta Bogdanowicz <majus85 gmail com>
Date:   Thu Dec 15 15:39:35 2011 +0100

    Added new help pages
    
    I added two pages for the 'Advanced options' section. I also changed
    archive-create.page and Makefile.am

 help/C/archive-create.page      |    6 +-
 help/C/keyboard-shortcuts.page  |  101 +++++++++++++++++++++++++++++++++++++++
 help/C/last-output.page.stub    |   46 ++++++++++++++++++
 help/C/password-protection.page |   62 ++++++++++++++++++++++++
 help/Makefile.am                |    2 +
 5 files changed, 214 insertions(+), 3 deletions(-)
---
diff --git a/help/C/archive-create.page b/help/C/archive-create.page
index 0f6dfda..614faea 100644
--- a/help/C/archive-create.page
+++ b/help/C/archive-create.page
@@ -26,10 +26,10 @@
       <guiseq><gui style="menu">Archive</gui><gui style="menuitem">Newâ</gui></guiseq></p>
     </item>
     <item>
-      <p>Name your new archive file, choose its location and click
-      <gui>Create</gui>.</p>
+      <p>The file chooser will open. Use it to name your new archive file and
+      choose its location, and click <gui>Create</gui>.</p>
       <note style="tip">
-        <p>In this window you may also choose the type of the file format that
+        <p>In this dialog you may also choose the type of the file format that
         you want to use, available extensions should be listed below. By
         clicking <gui>Other options</gui> you can set a password, or split your
         new archive into smaller parts. You should specify the size of the
diff --git a/help/C/keyboard-shortcuts.page b/help/C/keyboard-shortcuts.page
new file mode 100644
index 0000000..2f1fe70
--- /dev/null
+++ b/help/C/keyboard-shortcuts.page
@@ -0,0 +1,101 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="keyboard-shortcuts">
+
+<info>
+  <link type="guide" xref="index#advanced-options"/>
+  <desc>The list of shortcuts in <app>File Roller</app>.</desc>
+  <credit type="author">
+    <name>Marta Bogdanowicz</name>
+    <email>majus85 gmail com</email>
+  </credit>
+  <license>
+    <p>Creative Commons Share Alike 3.0</p>
+  </license>
+</info>
+
+  <title>Keyboard shortcuts</title>
+
+  <p>Using keyboard shortcuts can help speed up work-flow. In the table below
+  is a list of shortcuts which can be used in <app>File Roller</app>.</p>
+
+  <table frame="all" shade="rows">
+    <tr>
+      <td><p>Create new archive</p></td>
+      <td><p><keyseq><key>Ctrl</key><key>N</key></keyseq></p></td>
+    </tr>
+    <tr>
+      <td><p>Open an archive</p></td>
+      <td><p><keyseq><key>Ctrl</key><key>O</key></keyseq></p></td>
+    </tr>
+    <tr>
+      <td><p>Extract an archive</p></td>
+      <td><p><keyseq><key>Ctrl</key><key>E</key></keyseq></p></td>
+    </tr>
+    <tr>
+      <td><p>View archive properties</p></td>
+      <td><p><keyseq><key>Alt</key><key>Return</key></keyseq></p></td>
+    </tr>
+    <tr>
+      <td><p>Close</p></td>
+      <td><p><keyseq><key>Ctrl</key><key>W</key></keyseq></p></td>
+    </tr>
+    <tr>
+      <td><p>Cut</p></td>
+      <td><p><keyseq><key>Ctrl</key><key>X</key></keyseq></p></td>
+    </tr>
+    <tr>
+      <td><p>Copy</p></td>
+      <td><p><keyseq><key>Ctrl</key><key>C</key></keyseq></p></td>
+    </tr>
+    <tr>
+      <td><p>Paste</p></td>
+      <td><p><keyseq><key>Ctrl</key><key>V</key></keyseq></p></td>
+    </tr>
+    <tr>
+      <td><p>Rename file or folder in an archive</p></td>
+      <td><p><key>F2</key></p></td>
+    </tr>
+    <tr>
+      <td><p>Select all</p></td>
+      <td><p><keyseq><key>Ctrl</key><key>A</key></keyseq></p></td>
+    </tr>
+    <tr>
+      <td><p>Deselect all</p></td>
+      <td><p><keyseq><key>Shift</key><key>Ctrl</key><key>A</key></keyseq></p></td>
+    </tr>
+    <tr>
+      <td><p>Find</p></td>
+      <td><p><keyseq><key>Ctrl</key><key>F</key></keyseq></p></td>
+    </tr>
+    <tr>
+      <td><p>Delete files or folders from an archive</p></td>
+      <td><p><key>Delete</key></p></td>
+    </tr>
+    <tr>
+      <td><p>Display the tree view of the folders in the side pane</p></td>
+      <td><p><key>F9</key></p></td>
+    </tr>
+    <tr>
+      <td><p>View the content of an archive as a list of files</p></td>
+      <td><p><keyseq><key>Ctrl</key><key>1</key></keyseq></p></td>
+    </tr>
+    <tr>
+      <td><p>View the content of an archive as a folder structure</p></td>
+      <td><p><keyseq><key>Ctrl</key><key>2</key></keyseq></p></td>
+    </tr>
+    <tr>
+      <td><p>Stop the operation</p></td>
+      <td><p><key>Esc</key></p></td>
+    </tr>
+    <tr>
+      <td><p>Refresh</p></td>
+      <td><p><keyseq><key>Ctrl</key><key>R</key></keyseq></p></td>
+    </tr>
+    <tr>
+      <td><p>View help content</p></td>
+      <td><p><key>F1</key></p></td>
+    </tr>
+  </table>
+
+</page>
diff --git a/help/C/last-output.page.stub b/help/C/last-output.page.stub
new file mode 100644
index 0000000..c8f278f
--- /dev/null
+++ b/help/C/last-output.page.stub
@@ -0,0 +1,46 @@
+<!--To be honest, I do not understand what it is for. I did it few times for
+some archive types and my results where quite different. Could somebody explain
+me this "Last Output" thing? Does anybody use it?-->
+
+
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="last-output">
+
+  <info>
+    <link type="guide" xref="index#advanced-options"/>
+    <desc>View information about an archive or its last changes.</desc>
+    <credit>
+      <name>Marta Bogdanowicz</name>
+      <email>majus85 gmail com</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+
+  <title>Last output</title>
+
+  <p>Click <guiseq><gui style="menu">View</gui>
+  <gui style="menuitem">Last Output</gui></guiseq> to view information about an
+  archive and its content. The dialog <gui>Last Output</gui> will pop up and you
+  will see:</p>
+
+  <list>
+    <item><p>Status of your archive. This includes, for example, location of the
+    archive, number of entries, and list of all files and their size (in bytes).
+    </p>
+      <note>
+        <p>Such result you will receive only then, when you have just opened the
+        archive, and no other operations was done.</p>
+      </note>
+    </item>
+    <item><p>Status of the last changes.</p></item>
+      <note>
+        <p><app>File Roller</app> will show this information, only if the opened
+        archive was changed.</p>
+      </note>
+  </list>
+
+
+</page>
diff --git a/help/C/password-protection.page b/help/C/password-protection.page
new file mode 100644
index 0000000..d17c1e2
--- /dev/null
+++ b/help/C/password-protection.page
@@ -0,0 +1,62 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="password-protection">
+
+  <info>
+    <link type="guide" xref="index#advanced-options"/>
+    <link type="seealso" xref="archive-create"/>
+    <link type="seealso" xref="archive-open"/>
+    <desc>Set the password for your archive.</desc>
+    <credit type="author">
+      <name>Marta Bogdanowicz</name>
+      <email>majus85 gmail com</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+
+  <title>Password protection</title>
+
+  <note style="warning"><p><app>File Roller</app> allows you to encrypt an
+  archive with a password only in specific circumstances.</p></note>
+
+  <p>Set a password to encrypt data in a new archive by following these steps:</p>
+  <steps>
+    <item><p><link xref="archive-create">Create a new archive</link></p></item>
+    <item><p>The file chooser will open</p></item>
+    <item><p>At the bottom of this dialog you can choose the <gui>File Format</gui>
+    and <gui>Other Options</gui>, where you can set a password</p></item>
+    <item><p>Click <gui>Other Options</gui> and type a password</p>
+      <note style="warning">
+        <p>You may not be able to type password, because <app>File Roller</app>
+        does not allow this option to be used for all types of archive files, so
+        it is better to choose file format before
+        setting a password.</p>
+      </note>
+    </item>
+    <item><p>Type your password into the password field</p></item>
+    <item><p>Continue with <link xref="archive-create">
+    creating a new archive</link></p></item>
+  </steps>
+
+  <p>Protect an existing archive by setting a password :</p>
+  <steps>
+    <item><p><link xref="archive-open">Open an archive</link></p></item>
+    <item><p>Click <guiseq><gui style="menu">Edit</gui>
+    <gui style="menuitem">Passwordâ</gui></guiseq></p></item>
+    <item><p>Type password into the password field</p>
+      <note>
+        <p>If you want to encrypt the list of files tick
+        <gui>Encrypt the file list too</gui>.</p>
+      </note>
+    </item>
+    <item><p>Click <gui style="button">OK</gui> to continue</p>
+      <note style="warning">
+        <p><app>File Roller</app> will encrypt only new files which will be
+        added to the archive!</p>
+      </note>
+    </item>
+  </steps>
+
+</page>
diff --git a/help/Makefile.am b/help/Makefile.am
index e61c013..585b1cc 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -19,6 +19,8 @@ DOC_PAGES = \
 	archive-view.page \
 	index.page \
 	introduction.page \
+	keyboard-shortcuts.page \
+	password-protection.page \
 	supported-formats.page \
 	test-integrity.page
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]