GNOME.org
 

[gnome-system-log] Rewrite DocBook help in Mallard, bug 658455

commit 3d08b9978ef5f93bef014fe34e8bd94b7b4ae657
Author: Ekaterina Gerasimova <kittykat3756 googlemail com>
Date:   Sun Oct 30 16:37:28 2011 +0100

    Rewrite DocBook help in Mallard, bug 658455

 help/C/figures/log-viewer-main.png |  Bin 0 -> 170790 bytes
 help/C/figures/syslog_window.png   |  Bin 198892 -> 0 bytes
 help/C/gnome-system-log.xml        |  365 ------------------------------------
 help/C/index.page                  |   11 +
 help/C/introduction.page           |   43 +++++
 help/C/legal.xml                   |   76 --------
 help/C/log-close.page              |   28 +++
 help/C/log-copy.page               |   32 +++
 help/C/log-filter.page             |  103 ++++++++++
 help/C/log-search.page             |   59 ++++++
 help/C/log-view.page               |   37 ++++
 help/C/pref-font-size.page         |   44 +++++
 help/Makefile.am                   |   22 ++-
 13 files changed, 374 insertions(+), 446 deletions(-)
---
diff --git a/help/C/figures/log-viewer-main.png b/help/C/figures/log-viewer-main.png
new file mode 100644
index 0000000..a8ea26a
Binary files /dev/null and b/help/C/figures/log-viewer-main.png differ
diff --git a/help/C/index.page b/help/C/index.page
new file mode 100644
index 0000000..1030849
--- /dev/null
+++ b/help/C/index.page
@@ -0,0 +1,11 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="index">
+
+  <title>Log File Viewer Help</title>
+
+  <section id="main" style="2column">
+    <title>Working with the <app>Log File Viewer</app></title>
+  </section>
+
+</page>
diff --git a/help/C/introduction.page b/help/C/introduction.page
new file mode 100644
index 0000000..36fcdd7
--- /dev/null
+++ b/help/C/introduction.page
@@ -0,0 +1,43 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="introduction">
+
+  <info>
+    <link type="guide" xref="index"/>
+    <revision version="3.3" date="2011-10-30" status="review"/>
+    <desc>Introduction to the <app>GNOME System Log</app>.</desc>
+
+    <credit type="author">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 googlemail com</email>
+    </credit>
+
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+
+  <title>Introduction</title>
+
+  <p><app>Log File Viewer</app> is a graphical, menu-driven viewer that you can
+  use to view and monitor your system logs. <app>Log File Viewer</app> comes
+  with a few functions that can help you manage your logs, including a log
+  monitor and log statistics display.</p>
+
+  <p><app>Log File Viewer</app> is useful if you are new to system
+  administration because it provides an easier, more user-friendly display of
+  your logs than a text display of the log file. It is also useful for more
+  experienced administrators, as it contains a monitor to enable you to
+  continuously monitor crucial logs.</p>
+
+  <note style="tip">
+    <p><app>Log File Viewer</app> is useful only to those who have access to the
+    system log files, which generally requires root access.</p>
+  </note>
+
+  <figure>
+    <title> </title>
+    <media type="image" mime="image/png" src="figures/log-viewer-main.png"/>
+  </figure>
+
+</page>
diff --git a/help/C/log-close.page b/help/C/log-close.page
new file mode 100644
index 0000000..b4bdfaa
--- /dev/null
+++ b/help/C/log-close.page
@@ -0,0 +1,28 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="log-close">
+
+  <info>
+    <link type="guide" xref="index#main"/>
+    <link type="seealso" xref="log-view"/>
+    <revision version="3.3" date="2011-10-30" status="review"/>
+    <desc>Remove the log you are currently viewing from the <gui>side pane</gui>.</desc>
+
+    <credit type="author">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 googlemail com</email>
+    </credit>
+
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+
+  <title>Close log</title>
+
+  <p>Close the log that you are currently viewing by pressing
+  <keyseq><key>Ctrl</key><key>W</key></keyseq>, or by clicking
+  <guiseq><gui>File</gui><gui>Close</gui></guiseq>. This removes it from the
+  <gui>side pane</gui> until you open the log again.</p>
+
+</page>
diff --git a/help/C/log-copy.page b/help/C/log-copy.page
new file mode 100644
index 0000000..d255a9c
--- /dev/null
+++ b/help/C/log-copy.page
@@ -0,0 +1,32 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="log-copy">
+
+  <info>
+    <link type="guide" xref="index#main"/>
+    <revision version="3.3" date="2011-10-30" status="review"/>
+    <desc>Copy text from the log.</desc>
+
+    <credit type="author">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 googlemail com</email>
+    </credit>
+
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+
+  <title>Copy log</title>
+
+  <p>Highlight the section of the log that you want to copy with the cursor and
+  press <keyseq><key>Ctrl</key><key>C</key></keyseq>, or click
+  <guiseq><gui>Edit</gui><gui>Copy</gui></guiseq>.</p>
+
+  <note style="tip">
+    <p>You can press <keyseq><key>Ctrl</key><key>A</key></keyseq>, or click
+    <guiseq><gui>Edit</gui><gui>Select All</gui></guiseq>, to select all the
+    text in the log which you are currently viewing.</p>
+  </note>
+
+</page>
diff --git a/help/C/log-filter.page b/help/C/log-filter.page
new file mode 100644
index 0000000..63d2de3
--- /dev/null
+++ b/help/C/log-filter.page
@@ -0,0 +1,103 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="log-filter">
+
+  <info>
+    <link type="guide" xref="index#main"/>
+    <link type="seealso" xref="log-search"/>
+    <revision version="3.3" date="2011-10-30" status="review"/>
+    <desc>Include or exclude shown lines using regular expressions.</desc>
+
+    <credit type="author">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 googlemail com</email>
+    </credit>
+
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+
+  </info>
+
+  <title>Filter log</title>
+
+  <p>The log viewer allows you to filter log content based on regular
+  expressions. Set up or manage a new filter by:</p>
+
+  <steps>
+    <item>
+      <p>Open the filter manager dialog by clicking <guiseq><gui>Filters:</gui>
+      <gui>Manage Filters</gui></guiseq>.</p>
+    </item>
+    <item>
+      <p>Click <gui>Add</gui> to add a new filter, or select an existing filter
+      and click <gui>Properties</gui> to edit it.</p>
+    </item>
+    <item>
+      <p>Fill in the form or edit the fields that you wish to change:</p>
+      <terms>
+        <item>
+          <title>Name:</title>
+          <p>The identifier for the filter</p>
+        </item>
+        <item>
+          <title>Regular Expression:</title>
+          <p>What the filter will filter for</p>
+        </item>
+        <item>
+          <title>Highlight:</title>
+          <p>This option emphasizes the line containing the regular expression</p>
+          <terms>
+            <item>
+              <title>Background:</title>
+              <p>This is the font color</p>
+              <note style="tip">
+                <p>The default font color is black, which does not emphasize the
+                text.</p>
+              </note>
+            </item>
+            <item>
+              <title>Foreground:</title>
+              <p>This is the highlight color</p>
+              <note style="tip">
+                <p>The default highlight color is black, which shows solid black
+                lines as a result, so it would be wise to change it.</p>
+              </note>
+            </item>
+          </terms>
+        </item>
+        <item>
+          <title>Hide:</title>
+          <p>This option hides the lines containing the regular expression from
+          the shown log</p>
+        </item>
+      </terms>
+    </item>
+    <item>
+      <p>Click <gui>Apply</gui> to save the new filter or save changes to an
+      existing one</p>
+    </item>
+    <item>
+      <p>You are now back at the filter manager dialog, click <gui>Close</gui>
+      button to apply the changes.</p>
+    </item>
+  </steps>
+
+  <p>Check the box next to the name of the filter that you want to enable in
+  <gui>Filters:</gui>. If you want to view only the filters which have
+  <gui>Highlight</gui> enabled and are checked, check
+  <guiseq><gui>Filters:</gui><gui>Show matches only</gui></guiseq>.</p>
+
+  <note style="tip">
+    <p>If there is a conflict between a hidden and a highlighted filter, the
+     line many show as an empty white line.</p>
+  </note>
+
+  <note style="bug">
+    <p>If you uncheck a filter while viewing only matches, the log will show the
+    lines without any formatting, regardless of whether they were hidden or
+    highlighted before. The filter should reset when you check a highlighted
+    filter.</p>
+  </note>
+
+</page>
diff --git a/help/C/log-search.page b/help/C/log-search.page
new file mode 100644
index 0000000..615ee02
--- /dev/null
+++ b/help/C/log-search.page
@@ -0,0 +1,59 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="log-search">
+
+  <info>
+    <link type="guide" xref="index#main"/>
+    <revision version="3.3" date="2011-10-30" status="review"/>
+    <desc>Search the text in the log that you are currently viewing.</desc>
+
+    <credit type="author">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 googlemail com</email>
+    </credit>
+
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+
+  </info>
+
+  <title>Search log</title>
+
+  <p>Search the log that you are currently viewing by:</p>
+
+  <steps>
+    <item>
+      <p>Show the find bar by pressing
+      <keyseq><key>Ctrl</key><key>F</key></keyseq>, or by clicking
+      <guiseq><gui>View</gui><gui>Find</gui></guiseq>. The bar will be shown
+      below the log.</p>
+    </item>
+    <item>
+      <p>Enter your search term into the field and press <key>Enter</key> to see
+      the first result.</p>
+      <note style="tip">
+        <p>The search is case sensitive.</p>
+      </note>
+    </item>
+    <item>
+      <p>Use the <gui>Find Previous</gui> and <gui>Find Next</gui> buttons to
+      browse through the results.</p>
+      <note style="tip">
+        <p>If you can not see the result highlighted, try scrolling to the left.</p>
+      </note>
+    </item>
+    <item>
+      <p>Press <key>Esc</key> to hide the find bar once you are finished with
+      the search.</p>
+      <note style="tip">
+        <p>You can only hide the <gui>find bar</gui> if you are currently
+        focused on the search field. The bar will hide itself if you view
+        another log.</p>
+      </note>
+    </item>
+  </steps>
+
+
+
+</page>
diff --git a/help/C/log-view.page b/help/C/log-view.page
new file mode 100644
index 0000000..3f94d87
--- /dev/null
+++ b/help/C/log-view.page
@@ -0,0 +1,37 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="log-view">
+
+  <info>
+    <link type="guide" xref="index#main"/>
+    <link type="seealso" xref="log-search"/>
+    <revision version="3.3" date="2011-10-30" status="review"/>
+    <desc>Open and view logs.</desc>
+
+    <credit type="author">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 googlemail com</email>
+    </credit>
+
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+
+  </info>
+
+  <title>Open log</title>
+
+  <p>Open logs by clicking <guiseq><gui>File</gui><gui>Open</gui></guiseq>. Your
+  opened logs will be displayed in the side pane, to the left of the main area.
+  You can view a log in the side pane by clicking it.</p>
+
+  <note style="tip">
+    <p>You can expand some logs. This will show you a list of dates. By clicking
+    one of the dates, you can view only the log lines from that date, instead of
+    the whole log.</p>
+  </note>
+
+  <p>The logs you have open when you quit the log viewer will be opened when you
+  start it up again.</p>
+
+</page>
diff --git a/help/C/pref-font-size.page b/help/C/pref-font-size.page
new file mode 100644
index 0000000..999934f
--- /dev/null
+++ b/help/C/pref-font-size.page
@@ -0,0 +1,44 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide"
+      id="pref-font-size">
+
+  <info>
+    <link type="guide" xref="index#main"/>
+    <revision version="3.3" date="2011-10-30" status="review"/>
+    <desc>Increase or decrease the size of the text.</desc>
+
+    <credit type="author">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 googlemail com</email>
+    </credit>
+
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+
+  </info>
+
+  <title>Change font size</title>
+
+  <p>You can increase, decrease and reset the font size that the log is
+  displayed in:</p>
+
+  <terms>
+    <item>
+      <title>Increase font size</title>
+      <p>Click <guiseq><gui>View</gui><gui>Zoom In</gui></guiseq>, or press
+      <keyseq><key>Ctrl</key><key>+</key></keyseq></p>
+    </item>
+    <item>
+      <title>Decrease font size</title>
+      <p>Click <guiseq><gui>View</gui><gui>Zoom Out</gui></guiseq>, or press
+      <keyseq><key>Ctrl</key><key>-</key></keyseq></p>
+    </item>
+    <item>
+      <title>Reset to default size</title>
+      <p>Click <guiseq><gui>View</gui><gui>Normal Size</gui></guiseq>, or press
+      <keyseq><key>Ctrl</key><key>0</key></keyseq></p>
+    </item>
+  </terms>
+
+</page>
diff --git a/help/Makefile.am b/help/Makefile.am
index 89dab8f..f38ba80 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -1,10 +1,22 @@
 include $(top_srcdir)/gnome-doc-utils.make
 dist-hook: doc-dist-hook
 
-DOC_MODULE = gnome-system-log
-DOC_ENTITIES = legal.xml
-DOC_INCLUDES = 
-DOC_FIGURES = \
-	figures/syslog_window.png
+# Module name
+DOC_ID = gnome-system-log
 
+# List of figures to be included
+DOC_FIGURES = figures/log-viewer-main.png
+
+# List of pages
+DOC_PAGES = \
+	index.page \
+	introduction.page \
+	log-close.page \
+	log-copy.page \
+	log-filter.page \
+	log-search.page \
+	log-view.page \
+	pref-font-size.page
+
+# List of translations
 DOC_LINGUAS = ca cs de el en_GB es eu fi fr it ja ko oc ru sl sv uk zh_CN
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]