Remove old help documentation

This commit is contained in:
Sean Davis 2014-01-25 18:31:53 -05:00
parent c31e82fec8
commit 4b2ba99cbe
17 changed files with 3 additions and 154 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 107 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 642 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 290 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 40 KiB

View File

@ -1,46 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="index">
<info>
<!-- This shows in the title bar so does not show [icon] -->
<title type="text">Mugshot</title>
<desc>The <app>Mugshot</app> help.</desc>
<credit type="author">
<name>Sean Davis</name>
<email>smd.seandavis@gmail.com</email>
<years>2013</years>
</credit>
<license href="http://creativecommons.org/licenses/by-sa/3.0/">
<p>Creative Commons Attribution-Share Alike 3.0 Unported License</p>
</license>
</info>
<title>
<!-- This shows on the page in title font -->
<!-- the icon only shows when installed -->
<media type="image" mime="image/png" src="figures/icon.png">[icon]</media>
<app>Mugshot</app> Help
</title>
<p>Welcome to the <app>Mugshot</app> help guide. For a quick introduction into <app>Mugshot's</app> most basic features, visit the <link xref="mugshot-quickstart">Getting Started with Mugshot</link> page.</p>
<p>Other help topics are grouped together into sections below. Enjoy using <app>Mugshot</app>!</p>
<!-- This is the visible index -->
<section id="contents" style="2column">
<!-- other pages needs to have a link to index#contents for this to work -->
<title>Contents</title>
</section>
<note>
<!-- delete this note -->
<p>
Your script or application looks better if it has help files similar to other applications in ubuntu.
</p>
<p>
Some people think that help files are only for apps that are difficult to use.
</p>
</note>
</page>

View File

@ -1,29 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic"
id="mugshot-quickstart">
<info>
<link type="guide" xref="index#contents"/>
<link type="seealso" xref="mugshot-take-a-picture"/>
<credit type="author">
<name>Sean Davis</name>
<email>smd.seandavis@gmail.com</email>
<years>2013</years>
</credit>
<desc>Get started with Mugshot</desc>
</info>
<title>Getting Started</title>
<p><app>Mugshot</app> is a lightweight user configuration utility. It allows you to quickly configure your profile image in Linux and Pidgin, as well as your user details for your Linux user and LibreOffice.</p>
<media type="image" mime="image/png" src="figures/main.png"/>
<p>Once <app>Mugshot</app> launches, enter your user details, <link xref="mugshot-take-a-picture">choose a profile image</link>, and click <gui>Apply</gui> to save your changes.</p>
<p>If you've installed and regularly use Pidgin and/or LibreOffice, you will then be prompted to update your settings, but this is entirely up to you.</p>
<media type="image" mime="image/png" src="figures/pidgin.png"/>
<media type="image" mime="image/png" src="figures/libreoffice.png"/>
</page>

View File

@ -1,55 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic"
id="mugshot-take-a-picture">
<info>
<link type="guide" xref="index#contents"/>
<link type="seealso" xref="mugshot-quickstart"/>
<credit type="author">
<name>Sean Davis</name>
<email>smd.seandavis@gmail.com</email>
<years>2013</years>
</credit>
<desc>Take a picture with Mugshot</desc>
</info>
<title>Taking a Picture</title>
<p>One of the key features of <app>Mugshot</app> is the ability to easily choose a profile image, whether its from your camera (say "cheese!"), stock photos, or your picture library.</p>
<media type="image" mime="image/png" src="figures/take_a_photo.png"/>
<section id="stock-browser">
<title>Using the Stock Browser</title>
<p>If stock user images are installed (/usr/share/pixmaps/faces), the <gui>Select from stock...</gui> option will be available in the image menu. Click this menu item to continue.</p>
<media type="image" mime="image/png" src="figures/stock_browser.png"/>
<p>Each of the stock photos will be loaded into the browser. Simply select the one you wish to use and click <gui>Apply</gui>. Note that the picture will not be saved until clicking the <gui>Apply</gui> button in the main application window.</p>
</section>
<section id="file-browser">
<title>Using the File Browser</title>
<p>The stock browser is your typical file chooser dialog, with the addition of a preview window and cropping options. Since user images are square, <app>Mugshot</app> automatically crops images to the desired size. You can crop left (aligning to the left side of the image), center (centering the image), or right (aligning to the right side of the image.</p>
<media type="image" mime="image/png" src="figures/file_chooser.png"/>
<p>Once you are happy with your selection and crop settings, click <gui>Apply</gui>. Note that the picture will not be saved until clicking the <gui>Apply</gui> button in the main application window.</p>
</section>
<section id="using-a-camera">
<title>Using a Camera</title>
<p>If your webcam is detected by Linux, and you have the necessary components installed (gstreamer1.0-plugins-good), the <gui>Capture from camera...</gui> option will be available in the image menu. Click this menu item to continue.</p>
<media type="image" mime="image/png" src="figures/camera.png"/>
<p>The camera will then initialize, and the <gui>Record</gui> button will become available once the camera is ready. Simply click the record button to snap a photo. Try to position yourself in the middle of the frame as the photo will be cropped to a square and center-aligned.</p>
<p>If you'd like to try again, just click the <gui>Retry</gui> button. Otherwise, click the <gui>Apply</gui> button to continue. Note that the picture will not be saved until clicking the <gui>Apply</gui> button in the main application window.</p>
</section>
</page>

View File

@ -19,7 +19,7 @@ from gi.repository import Gtk # pylint: disable=E0611
import logging
logger = logging.getLogger('mugshot_lib')
from . helpers import get_builder, show_uri, get_help_uri
from . helpers import get_builder
class CameraDialog(Gtk.Dialog):
@ -57,7 +57,3 @@ class CameraDialog(Gtk.Dialog):
def on_btn_close_clicked(self, widget, data=None):
"""Destroy the dialog when closed."""
self.destroy()
def on_btn_help_clicked(self, widget, data=None):
"""Show the help dialog when Help is clicked."""
show_uri(self, "ghelp:%s" % get_help_uri('preferences'))

View File

@ -21,7 +21,7 @@ logger = logging.getLogger('mugshot_lib')
import os
from . helpers import get_builder, show_uri, get_help_uri
from . helpers import get_builder, show_uri
class Window(Gtk.Window):
@ -68,7 +68,7 @@ class Window(Gtk.Window):
def on_help_activate(self, widget, data=None):
"""Show the Help documentation when Help is clicked."""
show_uri(self, "ghelp:%s" % get_help_uri())
show_uri(self, "http://wiki.smdavis.us/doku.php?id=mugshot-docs")
def on_menu_camera_activate(self, widget, data=None):
"""Display the camera window for mugshot."""

View File

@ -85,23 +85,6 @@ def set_up_logging(opts):
lib_logger.setLevel(logging.DEBUG)
def get_help_uri(page=None):
"""Get the URI to be used for Help."""
# help_uri from source tree - default language
here = os.path.dirname(__file__)
help_uri = os.path.abspath(os.path.join(here, '..', 'help', 'C'))
if not os.path.exists(help_uri):
# installed so use gnome help tree - user's language
help_uri = 'mugshot'
# unspecified page is the index.page
if page is not None:
help_uri = '%s#%s' % (help_uri, page)
return help_uri
def show_uri(parent, link):
"""Open the URI."""
from gi.repository import Gtk # pylint: disable=E0611