cheese r405 - in trunk: . help help/C help/C/figures



Author: jhaitsma
Date: Wed Jan 16 18:54:25 2008
New Revision: 405
URL: http://svn.gnome.org/viewvc/cheese?rev=405&view=rev

Log:
Update to new manual provided by Joshua Henderson as part of GHOP


Added:
   trunk/help/C/figures/cheese-effects-screenshot.png   (contents, props changed)
Modified:
   trunk/ChangeLog
   trunk/help/C/cheese.xml
   trunk/help/Makefile.am

Modified: trunk/help/C/cheese.xml
==============================================================================
--- trunk/help/C/cheese.xml	(original)
+++ trunk/help/C/cheese.xml	Wed Jan 16 18:54:25 2008
@@ -1,88 +1,89 @@
-<?xml version="1.0"?>
-<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
-    "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"; [
-  <!ENTITY legal SYSTEM "legal.xml">
-  <!ENTITY GFDL  SYSTEM "fdl-appendix.xml">
-  <!ENTITY app "Cheese">
-  <!ENTITY application "<application>&app;</application>">
-  <!ENTITY appversion "0.3">
-  <!ENTITY manrevision "0.3">
-]>
-<!--
-      (Do not remove this comment block.)
-  Template Maintained by the GNOME Documentation Project:
-	  http://developer.gnome.org/projects/gdp
-  Template version: 2.0 beta
-  Template last modified Feb 12, 2002
--->
-
-<!-- =============Document Header ============================= -->
-<article id="index" lang="en">
-<!-- please do not change the id; for translations, change lang to -->
-<!-- appropriate code -->
-
-  <articleinfo>
-    <title>&application; Manual</title>
-    <abstract role="description">
-      <para>
-        &application; is a video and photo shoot program that for webcams
-        (or other cameras) and can do some cool effects
-      </para>
-    </abstract>
-    <copyright>
-      <year>2007</year>
-      <holder>daniel g. siegel (dgsiegel gmail com)</holder>
-      <holder>Jaap A. Haitsma (jaap haitsma org)</holder>
-    </copyright>
-
-  <!-- translators: uncomment this:
-
-  <copyright>
-   <year>2006</year>
-   <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
-  </copyright>
-
-  -->
-
-<!-- An address can be added to the publisher information.  If a role is
-     not specified, the publisher/author is the same for all versions of the
-     document.  -->
-    <publisher role="maintainer">
-      <publishername>daniel g. siegel</publishername>
-    </publisher>
-
-   &legal;
-   <!-- This file  contains link to license for the documentation (GNU FDL), and
-        other legal stuff such as "NO WARRANTY" statement. Please do not change
-        any of this. -->
-
-    <authorgroup>
-      <author role="maintainer">
-        <firstname>daniel</firstname>
-        <surname>siegel</surname>
-	<email>dgsiegel gmail com</email>
-      </author>
-      <author>
-        <firstname>Jaap</firstname>
-        <surname>Haitsma</surname>
-	<email>jaap haitsma org</email>
-      </author>
-
-<!-- This is appropriate place for other contributors: translators,
-      maintainers,  etc. Commented out by default.
-       <othercredit role="translator">
-        <firstname>Latin</firstname>
-        <surname>Translator 1</surname>
-        <affiliation>
-          <orgname>Latin Translation Team</orgname>
-          <address> <email>translator gnome org</email> </address>
-        </affiliation>
-        <contrib>Latin translation</contrib>
-      </othercredit>
--->
-    </authorgroup>
-
-    <revhistory>
+<?xml version="1.0"?>
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+    "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"; [
+  <!ENTITY legal SYSTEM "legal.xml">
+  <!ENTITY GFDL  SYSTEM "fdl-appendix.xml">
+  <!ENTITY app "Cheese">
+  <!ENTITY application "<application>&app;</application>">
+  <!ENTITY appversion "2.22">
+  <!ENTITY manrevision "2.22">
+]>
+<!--
+      (Do not remove this comment block.)
+  Template Maintained by the GNOME Documentation Project:
+	  http://developer.gnome.org/projects/gdp
+  Template version: 2.0 beta
+  Template last modified Feb 12, 2002
+-->
+
+<!-- =============Document Header ============================= -->
+<article id="index" lang="en">
+<!-- please do not change the id; for translations, change lang to -->
+<!-- appropriate code -->
+
+  <articleinfo>
+    <title>&application; Manual</title>
+    <abstract role="description">
+      <para>
+        &application; is a video and photo shoot program that for webcams
+        (or other cameras) and can do some cool effects
+      </para>
+    </abstract>
+    <copyright>
+      <year>2007</year>
+      <holder>daniel g. siegel (dgsiegel gmail com)</holder>
+      <holder>Jaap A. Haitsma (jaap haitsma org)</holder>
+    </copyright>
+
+  <!-- translators: uncomment this:
+
+  <copyright>
+   <year>2006</year>
+   <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
+  </copyright>
+
+  -->
+
+<!-- An address can be added to the publisher information.  If a role is
+     not specified, the publisher/author is the same for all versions of the
+     document.  -->
+    <publisher role="maintainer">
+      <publishername>Joshua Henderson (joshhendo gmail com)</publishername>
+    </publisher>
+
+   &legal;
+   <!-- This file  contains link to license for the documentation (GNU FDL), and
+        other legal stuff such as "NO WARRANTY" statement. Please do not change
+        any of this. -->
+
+    <authorgroup>
+      <author>
+        <firstname>Jaap</firstname>
+        <surname>Haitsma</surname>
+	<email>jaap haitsma org</email>
+      </author>
+      <author>
+        <firstname>Joshua</firstname>
+        <surname>Henderson</surname>
+	<email>joshhendo gmail com</email>
+      </author>
+
+<!-- This is appropriate place for other contributors: translators,
+      maintainers,  etc. Commented out by default.
+       <othercredit role="translator">
+        <firstname>Latin</firstname>
+        <surname>Translator 1</surname>
+        <affiliation>
+          <orgname>Latin Translation Team</orgname>
+          <address> <email>translator gnome org</email> </address>
+        </affiliation>
+        <contrib>Latin translation</contrib>
+      </othercredit>
+-->
+    </authorgroup>
+
+    <revhistory>
+      <revision>
       <revision>
         <revnumber>0.1</revnumber>
         <date>2007-12-04</date>
@@ -92,123 +93,393 @@
           </para>
           <para role="publisher">Jaap A. Haitsma</para>
         </revdescription>
-      </revision>
-    </revhistory>
-
-    <legalnotice>
-      <title>Feedback</title>
-      <para>
-        To report a bug or make a suggestion regarding the &app; application or
-        this manual, follow the directions in the 
-        <ulink url="http://www.gnome.org/projects/cheese/";
-	  type="http">&application; Contact Page</ulink>.
-      </para>
-<!-- Translators may also add here feedback address for translations -->
-    </legalnotice>
-  </articleinfo>
-
-  <indexterm zone="index">
-    <primary>&application;</primary>
-  </indexterm>
-  <indexterm zone="index">
-    <primary>cheese</primary>
-  </indexterm>
-
-<!-- ============= Document Body ============================= -->
-<!-- ============= Introduction ============================== -->
-<section id="intro">
-  <title>Introduction</title>
-  <!-- manrevision 2.0 compatibility -->
-  <anchor id="aboutex"/>
-  <anchor id="notice"/>
-  <indexterm>
-    <primary>&application;</primary>
-    <secondary>Manual</secondary>
-    <tertiary>cheese</tertiary>
-  </indexterm>
-
-  <para>
-  &app; is a video and photo shoot application with cool effects
-  for the <systemitem>GNOME desktop</systemitem>
-  </para>
-
-</section>
-
-<section id="using">
-  <title>Usage</title>
-
-  <figure>
-  <title>&app; screenshot</title>
-    <screenshot>
-      <mediaobject>
-        <imageobject>
-          <imagedata fileref="figures/cheese-screenshot.jpg" format="JPG"/>
-        </imageobject>
-      </mediaobject>
-    </screenshot>
-  </figure>
-
-
-  <para>
-  Describe usage here
-  </para>
-</section>
-
-<section id="preferences">
-  <title>Preferences</title>
-
-  <para>
-    Describe preferences overhere
-  </para>
-
-
-</section>
-
-
-
-<section id="faq">
-  <title>Frequently Asked Questions</title>
-  <para>
-    These are questions the mailing list gets asked frequently.
-  </para>
-  <section id="faq-supported-webcams">
-    <title>Which cameras are supported</title>
-    <para>
-      Cheese uses gstreamer for video grabbing. So in principle cheese supports 
-      any camera that works with GStreamer. In principle that should be any camera
-      which support video4linux of video4linux2.
-    </para>
-  </section>
-
-  <section id="faq-webcam-not-working">
-    <title>Why is my camera not working?</title>
-    <para>
-       You most probably do not have the driver installed.
-    </para>
-  </section>
-</section>
-
-<section id="about">
-  <title>About</title>
-  <para>
-    &app; was written by daniel g. siegel <email>dgsiegel gmail com</email>.
-    To find more information about &app;, please visit the
-    <ulink url="http://www.gnome.org/projects/cheese"; type="http">
-    &application; web page</ulink>.
-  </para>
-  <para>
-    To report a bug or make a suggestion regarding this application you can file
-    a bug in our 
-    <ulink url="http://bugzilla.gnome.org/browse.cgi?product=cheese"; type="http">
-    bug tracker</ulink>.
-  </para>
-  <para>This program is distributed under the terms of the GNU
-    General Public license as published by the Free Software
-    Foundation; either version 2 of the License, or (at your option)
-    any later version. A copy of this license can be found at the
-    <ulink url="http://www.gnu.org/licenses/gpl.html"; type="http">GNU site</ulink>, or in the file
-    COPYING included with the source code of this program.
+      </revision>
+        <revnumber>0.2</revnumber>
+        <date>2008-01-12</date>
+        <revdescription>
+          <para role="author">Jaap A. Haitsma
+            <email>jaap haitsma org</email>
+          </para>
+          <para role="author">Joshua Henderson
+            <email>joshhendo gmail com</email>
+          </para>
+          <para role="publisher">Jaap A. Haitsma</para>
+        </revdescription>
+      </revision>
+    </revhistory>
+
+    <legalnotice>
+      <title>Feedback</title>
+      <para>
+        To report a bug or make a suggestion regarding the &app; application or
+        this manual, follow the directions in the 
+        <ulink url="http://www.gnome.org/projects/cheese/";
+	  type="http">&application; Contact Page</ulink>.
+      </para>
+<!-- Translators may also add here feedback address for translations -->
+    </legalnotice>
+  </articleinfo>
+
+  <indexterm zone="index">
+    <primary>&application;</primary>
+  </indexterm>
+  <indexterm zone="index">
+    <primary>cheese</primary>
+  </indexterm>
+
+<!-- ============= Document Body ============================= -->
+<!-- ============= Introduction ============================== -->
+<section id="intro">
+  <title>Introduction</title>
+  <!-- manrevision 2.0 compatibility -->
+  <anchor id="aboutex"/>
+  <anchor id="notice"/>
+  <indexterm>
+    <primary>&application;</primary>
+    <secondary>Manual</secondary>
+    <tertiary>cheese</tertiary>
+  </indexterm>
+
+  <para>
+  &app; is a video and photo shoot application with cool effects
+  for the <systemitem>GNOME desktop</systemitem>
+  </para>
+
+</section>
+
+<section id="using">
+  <title>Usage</title>
+  <para>
+    The main screen of &app; looks like the screen shot below
   </para>
-</section>
-
+
+  <figure>
+  <title>&app; screenshot</title>
+    <screenshot>
+      <mediaobject>
+        <imageobject>
+          <imagedata fileref="figures/cheese-screenshot.jpg" format="JPG"/>
+        </imageobject>
+      </mediaobject>
+    </screenshot>
+  </figure>
+
+  <para>
+    &app; defaults to photo mode, and needs to be changed to video mode if
+    desired.
+  </para>
+
+  <section id="using-effects">
+    <title>Effects</title>
+    <para>
+      To apply effects to the input of your webcam, click
+      the button labelled Effects. When you go to the
+      effects window, you will see a window similar to the image below
+      <figure>
+        <title>&app; effects screenshot</title>
+        <screenshot>
+          <mediaobject>
+            <imageobject>
+              <imagedata fileref="figures/cheese-effects-screenshot.png" format="PNG"/>
+            </imageobject>
+          </mediaobject>
+       </screenshot>
+      </figure>
+
+    </para>
+    
+    <para>
+      You are able to select numerous effects to apply to your photo. To apply
+      an effect, just click on the name or image above, and the button will turn
+      to a blue shade. Selecting multiple effects will apply all the effects to
+      your image (for example, if you apply âHulkâ and âHorizontal Flipâ, the
+      input from the webcam will be altered to have a green shade and be up side down).
+    </para>
+  </section>
+  
+  <section id="using-photomode">
+    <title>Photo Mode</title>
+    <para>
+      Photo mode is the default mode that &app; opens in. When not in photo mode,
+      click the button labelled âPhotoâ or press Alt â P to change to photo mode.
+      Photo mode will take a single photo every time the button labelled âTake a
+      photoâ or the Spacebar is pressed, and will save to disk.
+    </para>
+  </section>
+
+  <section id="using-videomode">
+    <title>Video Mode</title>
+    <para>
+      Video mode is a mode that allows you to take short videos using the webcam.
+      When not in video mode, click the button labelled âVideoâ or press Alt â V to
+      change to video mode. Video mode will start recording a video every time the
+      button labelled âStart Recordingâ or the Spacebar is pressed. The video will stop
+      recording and save to disk when the button labelled âStop Recordingâ
+      or the Spacebar is pressed.
+    </para>
+
+    <para>
+      The video mode does look any different to the screen shot of photo mode,
+      except that the button labelled âTake a photoâ will be either âStart Recordingâ
+      or âStop Recordingâ (depends if you are currently recording or not),
+      and the button labelled âVideoâ is greyed out, whereas the button
+      labelled âPhotoâ is not.
+    </para>
+  </section>
+</section>
+
+<section id="working-with">
+  <title>Working with photos and videos</title>
+  <section id="takingaphoto">
+    <title>Taking a photo</title>
+    <para>
+      To take a photo in &app;, be sure to be in âPhotoâ mode. 
+    </para>
+
+    <para>
+      To take a photo, apply the effects that you wish by clicking the button
+      labelled âEffectsâ, click on the effects desired as described in a previous section
+      and press the button labelled âBackâ. You should now have the effects that
+      you clicked on applied to the webcam input.
+    </para>
+
+    <para>
+      To take the photo, press the button labelled âTake a photoâ. You will then
+      see &application; count down from 3. At the end of the count, your entire screen
+      will flash white, and the photo that was just taken will appear in the photo
+      stream at the bottom of the program window.
+    </para>
+  </section>
+
+  <section id="recordingavideo">
+    <title>Taking a video</title>
+    <para>
+      To take a video in &app;, make sure that the âVideoâ button has been pressed
+    </para>
+
+    <para>
+      To start recording a video, press the button labelled âStart Recordingâ or press the Spacebar.
+      The time of how much video has been recorded will appear in the bottom right
+      hand corner.
+    </para>
+
+    <note>
+      <para>
+        If your video appears to be jerky or have a low
+        frame rate (only updating the picture every few seconds), it is very likely
+        that the recording will not have this and have a more constant and higher
+        frame rate. To stop recording, press the button labelled âStop Recordingâ.
+        The video recorded will appear in the photo stream at the bottom of the program.
+      </para>
+    </note>
+  </section>
+</section>
+
+<section id="sharing">
+  <title>Sharing Photos and Videos</title>
+  <section id="view">
+    <title>Viewing a photo or video</title>
+    <para>
+      To view a video or photo that has been taken, locate it in the photo stream and
+      double click on it. Alternatively, you can right click on it and select âOpenâ.
+      This will then open the file in the default application for that file type.
+    </para>
+  </section>
+
+  <section id="saving">
+    <title>Saving photos and videos to an alternate location</title>
+    <para>
+      To save a photo to an alternate place on your hard drive where you can easily
+      find them, fin the photo or video that you wish to save in the photo stream, right
+      click on it and select âSave Asâ from the pop-up menu. This will bring up a
+      standard âSave Fileâ dialog that will allow you to rename the photo if desired
+      and save to any location you wish.
+    </para>
+  </section>
+
+  <section id="delete">
+    <title>Deleting a photo</title>
+    <para>
+      To delete a photo from the photo stream, locate the photo you wish to delete in
+      the photo stream, left click on it once and press the delete button on your
+      keyboard. Alternatively, you can right click on it and click âDeleteâ.
+    </para>
+
+    <para>
+      You will be prompted if you wish to delete it from the photo stream. To confirm,
+      press the button labelled âMove to Trashâ.
+    </para>
+
+    <note>
+      <para>
+        This will only move the image to the trash/garbage bin, as well as remove from
+        your photo stream. This will not remove the photo from your computer. To remove
+        it from your trash, you will need to empty your trash.
+      </para>
+    </note>
+  </section>
+
+  <section id="email">
+    <title>Send a photo by e-mail</title>
+    <para>
+      Photos can be directly emailed from &app;. You will need to have the default mail
+      client set up with an email account, otherwise you will need to set one up. To email
+      a photo, locate the photo you wish to email in the photo stream, right click on
+      it and select âSend by Mailâ.
+    </para>
+
+    <para>
+      This will open the default mail client (for example, Evolution) and a new email
+      message with the photo as an attachment.
+    </para>
+  </section>
+
+  <section id="account-photo">
+    <title>Set as Account Photo</title>
+    <para>
+      To set a photo as your account photo (which can be viewed from System -> Preferences
+      -> About Me, and which will also appear if the login window displays a list of
+      user names with photos), locate the photo that you wish to set in &app;, right click
+      on it and select âSet as Account Photoâ
+    </para>
+  </section>
+
+  <section id="fspot">
+    <title>Export a photo to F-Spot</title>
+    <para>
+      To export a photo to F-Sport, locate the photo that you wish to export in your photo
+      stream, right click on it and select âExport to F-Spotâ. You will then be prompted from
+      F-Spot if you wish to import the photos that are sent to it.
+    </para>
+
+    <note>
+      <para>
+        Depending on the version of &app; that you are currently using, F-Spot may prompt you
+        to import the entire photo stream.
+      </para>
+    </note>
+  </section>
+</section>
+
+<!--<section id="preferences">
+  <title>Preferences</title>
+
+  <para>
+    Describe preferences over here
+  </para>
+</section>-->
+
+<section id="faq">
+  <title>Frequently Asked Questions</title>
+  <!--<para>
+    These are questions the mailing list gets asked frequently.
+  </para>-->
+
+  <section id="faq-sluggish">
+    <title>The video is sluggish/has a slow response. What can I do?</title>
+    <para>
+      You may have set "ximagesink" ("X Window System (No Xv)") as video-output.
+      This means, that your cpu is doing all the work. Change it to "xvimagesink"
+      ("X Window System (X11/XShm/Xv)") in order to let your graphics card do the work.
+    </para>
+
+    <para>
+      To change the settings, run "gstreamer-properties", click the Video tab
+      and change the appropriate settings.
+    </para>
+  </section>
+
+  <section id="faq-mac">
+    <title>I have a Mac with iSight and a ATI graphics card, and the colors are weird.</title>
+    <para>
+      This is a problem with the ATI graphics card, though there is a work around.
+      Change the video-output to custom and insert the following: "ffmpegcolorspace !
+      video/x-raw-yuv,format=(fourcc)YV12 ! ffmpegcolorspace ! xvimagesink".
+    </para>
+
+    <para>
+      To change the settings, run "gstreamer-properties", click the Video tab
+      and select custom from the drop down menu.
+    </para>
+  </section>
+
+  <section id="faq-work-gstreamer">
+    <title>My webcam works with gstreamer, but does not work with &application;. What's wrong?</title>
+    <para>
+      Using "gstreamer-properties" mentioned in the above question, try changing from
+      xvimagesink to ximageskink or vice-versa. If this still does not work run "cheese --verbose" on
+      the command line and copy the logging into a bug report in our 
+      <ulink url="http://bugzilla.gnome.org/browse.cgi?product=cheese"; type="http">
+      bug tracker</ulink>.
+    </para>
+  </section>
+
+  <section id="faq-work-other">
+    <title>My webcam works with other programs such as Ekiga, Camorama, but not with &application;. What's wrong?</title>
+    <para>
+      See if your webcam works when testing it in "gstreamer-properties". If it works
+      there, but not in &application;, please file a bug report in our 
+      <ulink url="http://bugzilla.gnome.org/browse.cgi?product=cheese"; type="http">
+      bug tracker</ulink>.
+    </para>
+  </section>
+
+  <section id="faq-store">
+    <title>Where does &application; store my photos?</title>
+    <para>
+      Your photos are stored in ~/.gnome2/cheese/media. You can also save
+      them to an alternate location from within &app;. Please see the help
+      topic titled "Saving photos and videos to an alternate location" for
+      information on this.
+    </para>
+  </section>
+
+  <section id="faq-quickcam">
+    <title>My Quickcam Express doesn't work with &application;...</title>
+    <para>
+      or gstreamer, and I see errors like "Not enough buffers. We got 1, we
+      want at least 2" in the &application; output. With driver "qc-usb".
+    </para>
+
+    <para>
+      Try running "qcset /dev/video0 compat=dblbuf" to enable double buffer
+      compatibility mode, then restart &application;
+    </para>
+  </section>
+
+  <section id="faq-supported-webcams">
+    <title>Which cameras are supported</title>
+    <para>
+      &app; uses gstreamer for video grabbing. So in principle &app; supports 
+      any camera that works with GStreamer. In principle that should be any camera
+      which support video4linux of video4linux2.
+    </para>
+  </section>
+</section>
+
+<section id="about">
+  <title>About</title>
+  <para>
+    &app; was initially written by daniel g. siegel <email>dgsiegel gmail com</email>.
+    as a Google Summer of Code project. Later Jaap A. Haitsma <email>jaap haitsma org</email> and also 
+    others joined daniel in improving Cheese.
+    To find more information about &app;, please visit the
+    <ulink url="http://www.gnome.org/projects/cheese"; type="http">
+    &application; web page</ulink>.
+  </para>
+  <para>
+    To report a bug or make a suggestion regarding this application you can file
+    a bug in our 
+    <ulink url="http://bugzilla.gnome.org/browse.cgi?product=cheese"; type="http">
+    bug tracker</ulink>.
+  </para>
+  <para>This program is distributed under the terms of the GNU
+    General Public license as published by the Free Software
+    Foundation; either version 2 of the License, or (at your option)
+    any later version. A copy of this license can be found at the
+    <ulink url="http://www.gnu.org/licenses/gpl.html"; type="http">GNU site</ulink>, or in the file
+    COPYING included with the source code of this program.
+  </para>
+</section>
+
 </article>

Added: trunk/help/C/figures/cheese-effects-screenshot.png
==============================================================================
Binary file. No diff available.

Modified: trunk/help/Makefile.am
==============================================================================
--- trunk/help/Makefile.am	(original)
+++ trunk/help/Makefile.am	Wed Jan 16 18:54:25 2008
@@ -6,7 +6,8 @@
 DOC_INCLUDES = 
 
 DOC_FIGURES = \
-	figures/cheese-screenshot.jpg 
-
-DOC_LINGUAS = oc sv
+	figures/cheese-screenshot.jpg \ 
+	figures/cheese-effects-screenshot.png
+ 
+DOC_LINGUAS = es oc sv
 



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]