GNOME.org
 

[file-roller] Added new pages for File Roller help

commit cc2831ffa0f5b0ebc8446c824f76dfa4d68c69ee
Author: Marta Bogdanowicz <majus85 gmail com>
Date:   Thu Dec 8 15:28:05 2011 +0100

    Added new pages for File Roller help
    
    I added pages about opening, viewing and editing an archive and I added
    picture for 'Open recently used archive' toolbar button.  I have also
    changed Makefile.am and I fixed validation errors.

 help/C/archive-create.page                 |   26 ++++++-----
 help/C/archive-edit.page                   |   53 ++++++++++++++++++++++
 help/C/archive-open.page                   |   52 ++++++++++++++++++++++
 help/C/archive-view.page                   |   66 ++++++++++++++++++++++++++++
 help/C/figures/file-roller-open-recent.png |  Bin 0 -> 448 bytes
 help/C/introduction.page                   |    4 +-
 help/Makefile.am                           |    7 +++-
 7 files changed, 193 insertions(+), 15 deletions(-)
---
diff --git a/help/C/archive-create.page b/help/C/archive-create.page
index 944aa72..0f6dfda 100644
--- a/help/C/archive-create.page
+++ b/help/C/archive-create.page
@@ -17,18 +17,18 @@
   <title>Create a new archive</title>
 
   <p>
-  To create a new archive with <app>File Roller</app>, follow these steps:
+  Create a new archive with <app>File Roller</app>, by following these steps:
   </p>
 
   <steps>
     <item>
-      <p>Click on the icon <gui>Create a new archive</gui> in the toolbar, or
-      select <guiseq><gui>Archive</gui><gui>Newâ</gui></guiseq>.
-      </p>
+      <p>Click the <gui>Create a new archive</gui> toolbar button, or click
+      <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>
-      <note type="tip">
+      <p>Name your new archive file, 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
         you want to use, available extensions should be listed below. By
         clicking <gui>Other options</gui> you can set a password, or split your
@@ -37,12 +37,14 @@
       </note>
     </item>
     <item>
-      <p>Add the desired files to your archive by clicking on the icon <gui>Add
-      files to the archive</gui>, or by selecting <guiseq><gui>Edit</gui>
-      <gui>Add filesâ</gui></guiseq>. <app>File Roller</app> also allows you to
-      add whole folders. To do this, click the icon <gui>Add a folder
-      to the archive</gui>, or select <guiseq><gui>Edit</gui><gui>Add a folderâ
-      </gui></guiseq>.</p>
+      <p>Add the desired files to your archive by clicking the
+      <gui>Add files to the archive</gui> toolbar button, or by clicking
+      <guiseq><gui style="menu">Edit</gui>
+      <gui style="menuitem">Add filesâ</gui></guiseq>. <app>File Roller</app>
+      also allows you to add whole folders. To do this, click the
+      <gui>Add a folder to the archive</gui> toolbar button, or select
+      <guiseq><gui style="menu">Edit</gui>
+      <gui style="menuitem">Add a folderâ</gui></guiseq></p>
       <note style="tip">
         <p>When you add a folder to your archive, you will be offered some
         options:</p>
diff --git a/help/C/archive-edit.page b/help/C/archive-edit.page
new file mode 100644
index 0000000..271b2fd
--- /dev/null
+++ b/help/C/archive-edit.page
@@ -0,0 +1,53 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="archive-edit">
+
+  <info>
+    <link type="guide" xref="index#managing-archives"/>
+    <link type="seealso" xref="archive-create"/>
+    <desc>Change the content of 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>Edit an archive</title>
+
+  <p>With <app>File Roller</app> you can edit an existing archive by adding
+  new files, removing unwanted ones or by changing their names. You can work
+  with folders in the same way as with files.</p>
+
+  <terms>
+    <item>
+    <title><code>Add files</code></title>
+    <p>Add files to an existing archive by following the instructions on
+    <link xref="archive-create"/> page.</p>
+    </item>
+    <item>
+    <title><code>Remove files</code></title>
+      <steps>
+        <item><p>Select the file.</p></item>
+        <item><p>Click <guiseq><gui style="menu">Edit</gui>
+        <gui style="menuitem">Delete</gui></guiseq>, or right-click on the
+        selected file, and choose <gui>Delete</gui>.</p></item>
+      </steps>
+    </item>
+    <item>
+    <title><code>Rename files</code></title>
+      <steps>
+        <item><p>Select the file.</p></item>
+        <item><p>Click <guiseq><gui style="menu">Edit</gui>
+        <gui style="menuitem">Renameâ</gui></guiseq>, or right-click on the
+        selected file, and choose <gui>Renameâ</gui>.</p></item>
+        <item><p>A dialog will open. Enter the new file name into the text entry
+        field.</p></item>
+        <item><p>Confirm the name by clicking <gui>Rename</gui>.</p></item>
+      </steps>
+    </item>
+  </terms>
+
+</page>
diff --git a/help/C/archive-open.page b/help/C/archive-open.page
new file mode 100644
index 0000000..6d12ec9
--- /dev/null
+++ b/help/C/archive-open.page
@@ -0,0 +1,52 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="archive-open">
+
+  <info>
+    <link type="guide" xref="index#managing-archives"/>
+    <desc>Open an existing 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>Open an archive</title>
+
+  <p>Open an existing archive with <app>File Roller</app> in the following ways:</p>
+
+  <list>
+    <item>
+      <p>Click the toolbar button <gui>Open</gui>.</p>
+    </item>
+    <item>
+      <p>Click <guiseq><gui style="menu">Archive</gui>
+      <gui style="menuitem">Openâ</gui></guiseq></p>
+    </item>
+  </list>
+
+  <p>You may also use the <gui>Open Recent</gui> option in the following ways:</p>
+
+  <list>
+    <item>
+      <p>Click the
+      <media type="image" mime="image/png" src="figures/file-roller-open-recent.png">
+      Open a recently used archive</media>
+      toolbar button and select a file.</p>
+    </item>
+    <item>
+      <p>Click <guiseq><gui style="menu">Archive</gui>
+      <gui style="menuitem">Open Recent</gui></guiseq> to see the list of
+      recently used archives.</p>
+    </item>
+  </list>
+
+  <note><p>If <app>File Roller</app> cannot open your recently used
+  archive, and shows the error message <gui>The file doesn't exist</gui>, it may
+  be that the location of the archive file has changed. Then, you may use
+  <gui>Open</gui> option to search for it.</p></note>
+
+</page>
diff --git a/help/C/archive-view.page b/help/C/archive-view.page
new file mode 100644
index 0000000..72fadd6
--- /dev/null
+++ b/help/C/archive-view.page
@@ -0,0 +1,66 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="archive-view">
+
+  <info>
+    <link type="guide" xref="index#managing-archives"/>
+    <desc>View an existing archive and its content.</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>View an archive</title>
+
+  <p>There are two ways of viewing the archive:</p>
+
+  <list>
+    <item>
+    <p>View all files</p>
+      <p>To use this view, click <guiseq><gui style="menu">View</gui>
+      <gui style="menuitem">View All Files</gui></guiseq>. <app>File Roller</app>
+      will list all files inside the archive. You will see their names, sizes,
+      types, dates of the last modification and locations.</p>
+        <note style="tip">
+          <p>You may use these column headings mentioned above (name, sizeâ) to
+          sort the files in your archive. Do this by clicking on them, and click
+          the same one again to sort in reverse order.</p>
+        </note>
+    </item>
+    <item>
+    <p>View as a folder</p>
+      <p>This view displays the classic directory structure. To use this, click
+      <guiseq><gui style="menu">View</gui>
+      <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>
+          <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>
+        </note>
+    </item>
+  </list>
+
+  <section id="file-open">
+    <title>Open files in your archive</title>
+    <p>Open files, which are in you archive by double-clicking the file name, or
+    right-click on the file name and select <gui>Open</gui>.
+    <app>File Roller</app> will open the file with the default application for
+    that file type.</p>
+      <note>
+        <p>Open the file with different application by following these steps:</p>
+          <steps>
+            <item><p>Select the file</p></item>
+            <item><p>Right-click</p></item>
+            <item><p>Click <gui>Open Withâ</gui></p></item>
+          </steps>
+      </note>
+  </section>
+
+
+</page>
diff --git a/help/C/figures/file-roller-open-recent.png b/help/C/figures/file-roller-open-recent.png
new file mode 100644
index 0000000..88d0cec
Binary files /dev/null and b/help/C/figures/file-roller-open-recent.png differ
diff --git a/help/C/introduction.page b/help/C/introduction.page
index e41933b..858c221 100644
--- a/help/C/introduction.page
+++ b/help/C/introduction.page
@@ -38,9 +38,9 @@
   </list>
 
   <figure>
-    <title>The <gui>File Roller</gui> main window</title>
+    <title><gui>File Roller</gui> main window</title>
     <media type="image" mime="image/png" src="figures/file-roller-main-window.png">
-      Screenshot of the <app>File Roller</app>
+    <p>Screenshot of the <app>File Roller</app> main window.</p>
     </media>
   </figure>
 
diff --git a/help/Makefile.am b/help/Makefile.am
index b8e6b93..04e92d0 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -5,11 +5,16 @@ dist-hook: doc-dist-hook
 DOC_ID = file-roller
 
 # List of figures to be included
-DOC_FIGURES = figures/file-roller-main-window.png
+DOC_FIGURES = \
+	figures/file-roller-main-window.png \
+	figures/file-roller-open-recent.png
 
 # List of pages
 DOC_PAGES = \
 	archive-create.page \
+	archive-edit.page \
+	archive-open.page \
+	archive-view.page \
 	index.page \
 	introduction.page \
 	supported-formats.page
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]