GNOME.org
 

[file-roller] Edits to File Roller help

commit 6bd89f4db64a2338f47e830fcb4d8a10889245e0
Author: Marta Bogdanowicz <majus85 gmail com>
Date:   Mon Dec 12 17:09:52 2011 +0100

    Edits to File Roller help
    
    I added new pages about archive: extracting, properties (not finished)
    and test integrity. I editied Makefile.am, index.page and
    archive-view.page

 help/C/archive-extract-advanced-options.page |   77 ++++++++++++++++++++++++++
 help/C/archive-extract.page                  |   56 +++++++++++++++++++
 help/C/archive-properties.page.stub          |   35 ++++++++++++
 help/C/archive-view.page                     |    2 +-
 help/C/index.page                            |    4 +
 help/C/test-integrity.page                   |   31 ++++++++++
 help/Makefile.am                             |    5 +-
 7 files changed, 208 insertions(+), 2 deletions(-)
---
diff --git a/help/C/archive-extract-advanced-options.page b/help/C/archive-extract-advanced-options.page
new file mode 100644
index 0000000..522e0f2
--- /dev/null
+++ b/help/C/archive-extract-advanced-options.page
@@ -0,0 +1,77 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="archive-extract-advanced-options">
+
+  <info>
+    <link type="guide" xref="index#advanced-options"/>
+    <desc>Specify your preferences for archive extraction.</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>Advanced options for archive extracting</title>
+
+  <p><app>File Roller</app> offers different options while extracting an
+  archive. You can see these options in the file chooser dialog, which you use
+  for choosing the location for extracted files. At the bottom of this dialog,
+  you can decide if you want to extract:</p>
+  <terms>
+    <item>
+      <title><gui>All files</gui></title>
+        <p>the whole archive will be extracted</p>
+    </item>
+    <item>
+      <title><gui>Selected files</gui></title>
+        <p><app>File Roller</app> extracts only the chosen files</p>
+          <note>
+          <p>Select them before you click <guiseq><gui style="menu">Archive</gui>
+          <gui style="menuitem">Extractâ</gui></guiseq>. Do this by clicking on
+          the file name. Press <key>Ctrl</key> or <key>Shift</key>, to select
+          more than one file.</p>
+          </note>
+    </item>
+    <item>
+      <title><gui>Files</gui></title>
+        <p>you can type the names of the files that you want to extract</p>
+          <note>
+          <p>The file name needs to be followed by a file extension. You can
+          extract, for exapmle, all <file>.txt</file> files, by typing
+          <file>*.txt</file>.</p>
+          </note>
+    </item>
+  </terms>
+
+  <p>You can specify in the file chooser dialog whether you want:</p>
+  <terms>
+    <item>
+      <title><gui>Re-create folders</gui></title>
+        <p>Tick this option if you want to keep the directory structure, as it
+        was in your archive</p>
+    </item>
+    <item>
+      <title><gui>Overwrite existing files</gui></title>
+        <p>If your archive contains files with the same name as those in the
+        destination folder, then <app>File Roller</app> will overwrite them
+        during extraction if this option is enabled</p>
+    </item>
+    <item>
+      <title><gui>Do not extract older folders</gui></title>
+        <p>This option will not overwrite existing files with the same name,
+        which have a more recent modification date than those which are in the
+        archive.</p>
+    </item>
+  </terms>
+
+  <p>These <gui>Actions</gui> are listed at the bottom of the dialog.</p>
+
+  <note style="advanced">
+    <p>The option <gui>Do not extract older files</gui> is only avaiable when
+    the option <gui>Overwrite existing files</gui> has been enabled.</p>
+  </note>
+
+</page>
diff --git a/help/C/archive-extract.page b/help/C/archive-extract.page
new file mode 100644
index 0000000..fd968ef
--- /dev/null
+++ b/help/C/archive-extract.page
@@ -0,0 +1,56 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="archive-extract">
+
+  <info>
+    <link type="guide" xref="index#managing-archives"/>
+    <link type="seealso" xref="archive-open"/>
+<!--    <link type="seealso" xref="password-protection"/>-->
+    <link type="seealso" xref="archive-extract-advanced-options"/>
+    <desc>Extract files or folders from 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>Extract an archive</title>
+
+  <p>Extract files from archive using <app>File Roller</app> by following these
+  steps:</p>
+
+    <steps>
+      <item><p><link xref="archive-open">Open</link> an archive.</p></item>
+      <item><p>Click <guiseq><gui style="menu">Archive</gui>
+      <gui style="menuitem">Extractâ</gui></guiseq> or click the <gui>Extract</gui>
+      toolbar button.</p></item>
+      <item><p>Choose the location in the file chooser, into which the files
+      should be extracted. This will be the destination folder.</p>
+      <note style="tip">
+        <p>There are additional options in this dialog. See
+        <link xref="archive-extract-advanced-options">advanced options for
+        extracting archives</link>.</p>
+      </note>
+      </item>
+      <item><p>Click <gui>Extract</gui>.</p></item>
+      <item><p>If an archive is protected by a
+      <!--<link xref="password-protection">-->password<!--</link>-->, <app>File
+      Roller</app> will request it. Type the password and click
+      <gui>OK</gui>.</p></item>
+      <item><p>The application will show you the progress bar in a new dialog.
+      If the extraction completes successfully, you will be asked whether you
+      want to:</p>
+        <list>
+          <item><p><gui>Quit</gui> - this option closes <app>File Roller</app></p></item>
+          <item><p><gui>Show the files</gui> - after clicking this the
+          destination folder will be open in <app>Nautilus</app></p></item>
+          <item><p><gui>Close</gui> - the dialog will be closed and you will see
+          your archive again</p></item>
+        </list>
+      </item>
+    </steps>
+
+</page>
diff --git a/help/C/archive-properties.page.stub b/help/C/archive-properties.page.stub
new file mode 100644
index 0000000..84d413d
--- /dev/null
+++ b/help/C/archive-properties.page.stub
@@ -0,0 +1,35 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="archive-properties">
+
+  <info>
+    <link type="guide" xref="index#advanced-options"/>
+    <desc>Find information about 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>Archive properties</title>
+
+  <p><gui>Archive properties</gui> allows you to view information about an
+  archive. Open it by clicking <guiseq><gui style="menu">Archive</gui>
+  <gui style="menuitem">Properties</gui></guiseq> or by pressing
+  <keyseq><key>Alt</key><key>Return</key></keyseq>.</p>
+
+  <p><app>File Roller</app> will open the dialog, which will inform you about:</p>
+  <list>
+    <item><p><gui>Name</gui> of the archive</p></item>
+    <item><p><gui>Location</gui> of the archive</p></item>
+    <item><p>date, when it was <gui>Modified</gui></p></item>
+    <item><p><gui>Archive size</gui></p></item>
+    <item><p><gui>Content size</gui></p></item>
+    <item><p><gui>Compression ratio</gui> of archive size to content size</p></item>
+    <item><p><gui>Number of files</gui> in the archive</p></item>
+  </list>
+
+</page>
diff --git a/help/C/archive-view.page b/help/C/archive-view.page
index 72fadd6..1c1cb26 100644
--- a/help/C/archive-view.page
+++ b/help/C/archive-view.page
@@ -38,7 +38,7 @@
       <gui style="menuitem">View as a Folder</gui></guiseq>.</p>
         <note style="tip">
           <p>While viewing your archive in this way, press
-          <gui style="button">F9</gui>, or click <guiseq><gui style="menu">View</gui>
+          <key>F9</key>, or click <guiseq><gui style="menu">View</gui>
           <gui style="menuitem">Folders</gui></guiseq> option. You will see a
           tree view of the folders in the side pane. It allows you to navigate
           easily between folders.</p>
diff --git a/help/C/index.page b/help/C/index.page
index a45dad7..fd2236b 100644
--- a/help/C/index.page
+++ b/help/C/index.page
@@ -8,6 +8,10 @@
     <title>Managing archives</title>
   </section>
 
+  <section id="advanced-options" style="2column">
+    <title>Advanced options</title>
+  </section>
+
 <!--  <section id="troubleshooting" style="2column">-->
 <!--    <title>Troubleshooting</title>-->
 <!--  </section>-->
diff --git a/help/C/test-integrity.page b/help/C/test-integrity.page
new file mode 100644
index 0000000..1de7426
--- /dev/null
+++ b/help/C/test-integrity.page
@@ -0,0 +1,31 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="test-integrity">
+
+  <info>
+    <link type="guide" xref="index#advanced-options"/>
+    <desc>Check the integrity of an 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>Test integrity</title>
+
+  <p><app>File Roller</app> allows you to check whether the compressed data in
+  an archive contains any errors. Do this by clicking
+  <guiseq><gui style="menu">Archive</gui>
+  <gui style="menuitem">Test Integrity</gui></guiseq>.</p>
+
+  <p>The dialog with the <gui>Test Result</gui> will pop up. You will see the
+  list of tested files and, at the bottom, there will also be the test summary.</p>
+
+  <note style="advanced">
+    <p>The integrity test verifies that your data is not corrupt.</p>
+  </note>
+
+</page>
diff --git a/help/Makefile.am b/help/Makefile.am
index 04e92d0..e61c013 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -13,11 +13,14 @@ DOC_FIGURES = \
 DOC_PAGES = \
 	archive-create.page \
 	archive-edit.page \
+	archive-extract.page \
+	archive-extract-advanced-options.page \
 	archive-open.page \
 	archive-view.page \
 	index.page \
 	introduction.page \
-	supported-formats.page
+	supported-formats.page \
+	test-integrity.page
 
 DOC_LINGUAS = bg ca cs da de el en_GB es eu fi fr it ja oc nl ru sl sv te vi uk zh_CN zh_HK zh_TW
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]