[file-roller] Started re-writing documentation in Mallard
- From: Ekaterina Gerasimova <egerasimov src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [file-roller] Started re-writing documentation in Mallard
- Date: Sat, 29 Oct 2011 21:11:21 +0000 (UTC)
commit 8ad0246a4756705d5ad2d9224329aa5d63147a14
Author: Marta Bogdanowicz <majus85 gmail com>
Date: Thu Oct 27 20:35:49 2011 +0200
Started re-writing documentation in Mallard
Removed old DocBook help. Added introduction, index and page about
creating new archive. Edited Makefile.am to work with Mallard.
help/C/Makefile.am | 9 -
help/C/create-archive.page | 62 ++
help/C/figures/file-roller-main-window.png | Bin 0 -> 46562 bytes
help/C/figures/file-roller_home.png | Bin 867 -> 0 bytes
help/C/figures/file-roller_leftarrow.png | Bin 1509 -> 0 bytes
help/C/figures/file-roller_main_window.png | Bin 22841 -> 0 bytes
help/C/figures/file-roller_rightarrow.png | Bin 868 -> 0 bytes
help/C/figures/file-roller_uparrow.png | Bin 860 -> 0 bytes
help/C/file-roller.xml | 1630 ----------------------------
help/C/index.page | 19 +
help/C/introduction.page | 47 +
help/C/l10n.txt | 61 -
help/C/legal.xml | 76 --
help/Makefile.am | 20 +-
14 files changed, 139 insertions(+), 1785 deletions(-)
---
diff --git a/help/C/create-archive.page b/help/C/create-archive.page
new file mode 100644
index 0000000..38c649b
--- /dev/null
+++ b/help/C/create-archive.page
@@ -0,0 +1,62 @@
+<page xmlns="http://projectmallard.org/1.0/"
+ type="guide"
+ id="archive-create">
+
+ <info>
+ <link type="guide" xref="index#managing-archives"/>
+ <desc>Add files or folders to your new 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>Create a new archive</title>
+
+ <p>
+ To create a new archive with <app>File Roller</app>, follow 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>
+ </item>
+ <item>
+ <p>Name your new archive file, choose its location and click <gui>Create
+ </gui>.</p>
+ <note type="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
+ new archive into smaller parts. You should specify the size of the
+ volume in <gui>MB</gui>.</p>
+ </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>
+ <note style="tip">
+ <p>When you add a folder to your archive, you will be offered some
+ options:</p>
+ <list>
+ <item><p>Whether to include subfolders or not</p></item>
+ <item><p>Choose which files should be included</p></item>
+ <item><p>Select which subfolders or files are to be excluded</p></item>
+ </list>
+ </note>
+ </item>
+ <item>
+ <p>Once you finish adding files, your archive is ready.</p>
+ </item>
+ </steps>
+
+</page>
diff --git a/help/C/figures/file-roller-main-window.png b/help/C/figures/file-roller-main-window.png
new file mode 100644
index 0000000..0d89f9e
Binary files /dev/null and b/help/C/figures/file-roller-main-window.png differ
diff --git a/help/C/index.page b/help/C/index.page
new file mode 100644
index 0000000..a45dad7
--- /dev/null
+++ b/help/C/index.page
@@ -0,0 +1,19 @@
+<page xmlns="http://projectmallard.org/1.0/"
+ type="guide"
+ id="index">
+
+ <title>File Roller Archive Manager Help</title>
+
+ <section id="managing-archives" style="2column">
+ <title>Managing archives</title>
+ </section>
+
+<!-- <section id="troubleshooting" style="2column">-->
+<!-- <title>Troubleshooting</title>-->
+<!-- </section>-->
+
+<!-- <section id="tools" style="2column">-->
+<!-- <title>Other tools</title>-->
+<!-- </section>-->
+
+</page>
diff --git a/help/C/introduction.page b/help/C/introduction.page
new file mode 100644
index 0000000..e41933b
--- /dev/null
+++ b/help/C/introduction.page
@@ -0,0 +1,47 @@
+<page xmlns="http://projectmallard.org/1.0/"
+ type="guide"
+ id="introduction">
+
+ <info>
+ <link type="guide" xref="index"/>
+ <desc>Introduction to the <app>File Roller</app> archive managing
+ application.</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>Introduction</title>
+
+ <p><app>File Roller</app> is an application for managing archives, designed to
+ be easy to use. It provides all the tools necessary for creating, modifying or
+ extracting archives.</p>
+
+ <note style="advanced">
+ <p>An archive is composed of one or more files, along with metadata. It may
+ be encrypted in part or as a whole. By collecting multiple data files
+ together into a single one, archive files are useful for storing data and
+ transferring it between computers.</p>
+ </note>
+
+ <p>With <app>File Roller</app> you can:</p>
+ <list>
+ <item><p>Create new archive by adding files or folders</p></item>
+ <item><p>View the content of the existing archive</p></item>
+ <item><p>View a file contained in the archive</p></item>
+ <item><p>Modify existing archives</p></item>
+ <item><p>Extract files from archive</p></item>
+ </list>
+
+ <figure>
+ <title>The <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>
+ </media>
+ </figure>
+
+</page>
diff --git a/help/Makefile.am b/help/Makefile.am
index 789facd..abd184d 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -1,15 +1,17 @@
include $(top_srcdir)/gnome-doc-utils.make
dist-hook: doc-dist-hook
-DOC_MODULE = file-roller
-DOC_ENTITIES = legal.xml
-DOC_INCLUDES =
-DOC_FIGURES = \
- figures/file-roller_home.png \
- figures/file-roller_leftarrow.png \
- figures/file-roller_main_window.png \
- figures/file-roller_rightarrow.png \
- figures/file-roller_uparrow.png
+# Module name
+DOC_ID = file-roller
+
+# List of figures to be included
+DOC_FIGURES = figures/file-roller-main-window.png
+
+# List of pages
+DOC_PAGES = \
+ create-archive.page \
+ index.page \
+ introduction.page
DOC_LINGUAS = bg ca cs da de el en_GB es eu fi fr it ja oc nl ru sl sv vi uk zh_CN zh_HK zh_TW
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]