[ddccontrol-cvs] SF.net SVN: ddccontrol: [749] trunk/ddccontrol

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Revision: 749
          http://ddccontrol.svn.sourceforge.net/ddccontrol/?rev=749&view=rev
Author:   el_cubano
Date:     2007-10-28 01:39:32 -0700 (Sun, 28 Oct 2007)

Log Message:
-----------
Review and update documentation

Modified Paths:
--------------
    trunk/ddccontrol/doc/about.xml
    trunk/ddccontrol/doc/install.xml
    trunk/ddccontrol/doc/main.xml
    trunk/ddccontrol/doc/supportedgc.xml
    trunk/ddccontrol/doc/techdocs.xml

Property Changed:
----------------
    trunk/ddccontrol/


Property changes on: trunk/ddccontrol
___________________________________________________________________
Name: svn:ignore
   - install-sh
libtool
ltmain.sh
missing
aclocal.m4
depcomp
config.sub
config.guess
config.rpath
autom4te.cache
Doxyfile
ddccontrol.kdevelop
ddccontrol.kdevelop.filelist
ddccontrol.kdevelop.pcs
ddccontrol.kdevses
Makefile
config.log
config.status
intltool-extract
intltool-extract.in
intltool-merge
intltool-merge.in
intltool-update
intltool-update.in
configure
Makefile.in
.exrc
m4
mkinstalldirs
ABOUT-NLS

   + install-sh
libtool
ltmain.sh
missing
aclocal.m4
depcomp
config.sub
config.guess
config.rpath
autom4te.cache
Doxyfile
ddccontrol.kdevelop
ddccontrol.kdevelop.filelist
ddccontrol.kdevelop.pcs
ddccontrol.kdevses
Makefile
config.log
config.status
intltool-extract
intltool-extract.in
intltool-merge
intltool-merge.in
intltool-update
intltool-update.in
configure
Makefile.in
.exrc
m4
mkinstalldirs
ABOUT-NLS
build


Modified: trunk/ddccontrol/doc/about.xml
===================================================================

--- trunk/ddccontrol/doc/about.xml	2007-10-28 08:37:57 UTC (rev 748)
+++ trunk/ddccontrol/doc/about.xml	2007-10-28 08:39:32 UTC (rev 749)
@@ -4,12 +4,12 @@
 <sect1 id="ddccontrol">
 <title>About DDCcontrol</title>
 <para>DDCcontrol is a tool used to control monitor parameters, like brightness 
-and contrast, without using the OSD (On Screen Display) and the buttons in front
+and contrast, without using the OSD (On Screen Display) or the buttons in front
 of the monitor.</para>
 <para>All the software provided by monitor manufacturers (NEC/Mitsubishi NaviSet
 and Samsung MagicTune) are closed-source and only runs on Windows.
 DDCcontrol is open-source and runs on Linux.</para>
-<para>There is two versions of this tool, a command line version, and an 
+<para>There are two parts to this tool: a command line version, and a 
 user-friendly Gnome GUI.</para>
 </sect1>
  

Modified: trunk/ddccontrol/doc/install.xml
===================================================================
--- trunk/ddccontrol/doc/install.xml	2007-10-28 08:37:57 UTC (rev 748)
+++ trunk/ddccontrol/doc/install.xml	2007-10-28 08:39:32 UTC (rev 749)
@@ -2,7 +2,7 @@
 <title>Install notes</title>
 
 <sect1 id="requirement">
-<title>Software Requirement</title>
+<title>Software Requirements</title>
 <para>To compile and run DDCcontrol, you need to have these packages installed:</para>
 <itemizedlist mark='bullet'>
 <listitem>
@@ -24,15 +24,15 @@
 <para>In addition to the library packages, you also need the development
 packages, which are not usually installed. For example, on Debian, their names
 are <filename>libxml2-dev</filename>, <filename>pciutils-dev</filename> and
-<filename>libgtk2.0-dev</filename>. Others distributions probably have similar
-packages names. On Fedora Core 5, you will also need
+<filename>libgtk2.0-dev</filename>. Other distributions probably have similar
+package names. On Fedora Core 5, you will also need
 <filename>gnome-panel-devel</filename> package.
 </para>
 <note>
 <para>
 You don't need pci-utils if you don't use direct PCI memory access, and you 
 don't need gtk+ if you don't plan to use the Gnome GUI. Usually, this is not the
-case, so you will need these packages.
+case, so you will almost certainly want these packages for compiling ddccontrol.
 </para>
 </note>
 </sect1>
@@ -128,4 +128,14 @@
 </itemizedlist>
 </sect2>
 </sect1>
+
+<sect1 id="debian">
+<title>Installation on Debian (and derivatives)</title>
+<para>The ddccontrol and ddccontrol-db packages are available in Debian (and
+derivatives).  You simply need to install the ddccontrol package and all the
+proper dependencies will be installed along with it.  For example:</para>
+<screen format="linespecific">
+# apt-get install ddccontrol
+</screen>
+</sect1>
 </chapter>

Modified: trunk/ddccontrol/doc/main.xml
===================================================================
--- trunk/ddccontrol/doc/main.xml	2007-10-28 08:37:57 UTC (rev 748)
+++ trunk/ddccontrol/doc/main.xml	2007-10-28 08:39:32 UTC (rev 749)
@@ -21,8 +21,18 @@
 <surname>Boichat</surname>
 <email>ni...@bo...</email>
 </author>
+<author>
+<firstname>Roberto</firstname>
+<othername>C.</othername>
+<surname>Sanchez</surname>
+<email>ro...@co...</email>
+</author>
 
-<copyright><year>2005-2006</year>
+<copyright><year>2007</year>
+<holder>Roberto C. Sanchez</holder>
+</copyright>
+<copyright>
+<year>2005-2006</year>
 <holder>Nicolas Boichat</holder>
 </copyright>
 

Modified: trunk/ddccontrol/doc/supportedgc.xml
===================================================================
--- trunk/ddccontrol/doc/supportedgc.xml	2007-10-28 08:37:57 UTC (rev 748)
+++ trunk/ddccontrol/doc/supportedgc.xml	2007-10-28 08:39:32 UTC (rev 749)
@@ -2,18 +2,18 @@
 <title>Supported graphics cards</title>
 <sect2>
 <title><filename>/dev/i2c-*</filename> versus PCI memory</title>
-<para>To control a monitor, DDCcontrol must access to the I2C bus of the
+<para>To control a monitor, DDCcontrol must access the I2C bus of the
 graphics card. There are two methods to do so: the first one uses
 <filename>/dev/i2c-*</filename> devices provided by kernel drivers (abbreviated
-by dev in tables), the second one reads and writes directly in the card PCI
-memory (abbreviated by PCI in the tables).</para>
-<para>Depending on your hardware, one method or the other works, or even both.</para>
+as dev in tables), the second one reads and writes directly in the card PCI
+memory (abbreviated as PCI in the tables).</para>
+<para>Depending on your hardware, one method or the other may work.  Even both may work.</para>
 </sect2>
 <sect1>
 <title>ATI Radeon series</title>
 <sect2>
 <title>Direct PCI memory access support</title>
-<para>Almost every ATI cards should work with direct PCI memory access, even if it has not been very extensively tested.</para>
+<para>Almost every ATI card should work with direct PCI memory access, even if it has not been very extensively tested.</para>
 <para>To use it, you have nothing special to do, everything is done by DDCcontrol.</para>
 </sect2>
 <sect2>
@@ -44,7 +44,7 @@
   <guimenuitem>DDC/I2C for ATI Radeon support</guimenuitem>
 </menuchoice>.
 <warning>
-	<para>The <filename>radeonfb</filename> kernel module may cause system instability (crashes or screen corruption) when used at the same time as used the ATI closed source drivers.</para>
+	<para>The <filename>radeonfb</filename> kernel module may cause system instability (crashes or screen corruption) when used at the same time as the ATI closed source drivers.</para>
 	<para>This is why we recommend that you use direct PCI memory access with 
 		ATI cards.</para>
 </warning>
@@ -170,7 +170,7 @@
 </listitem>
 </itemizedlist>
 <warning>
-<para>These kernel modules is <emphasis>not</emphasis> compatible with binary
+<para>These kernel modules are <emphasis>not</emphasis> compatible with binary
 nVidia X drivers, which are the only drivers for nVidia cards to provide 3D
 acceleration.</para>
 <para>This is why we recommend that you either use direct PCI memory access with 
@@ -180,14 +180,14 @@
 </sect2>
 <sect2>
 <title>Direct PCI memory access support</title>
-<para>Almost every nVidia cards work with direct PCI memory access, and this
+<para>Almost every nVidia card works with direct PCI memory access, and this
 method is compatible with the nVidia proprietary drivers.</para>
 <para>To use it, you have nothing special to do, everything is done by 
 DDCcontrol.</para>
 </sect2>
 <sect3>
 <title>nVidia cards support table</title>
-<para>Most of these nVidia cards have been reported to work, but others models
+<para>Most of these nVidia cards have been reported to work, but other models
 should also work. If yours is not listed, please send a message to one of the
 DDCcontrol mailing lists (see <xref linkend="report"/>).</para>
 <informaltable frame="all">

Modified: trunk/ddccontrol/doc/techdocs.xml
===================================================================
--- trunk/ddccontrol/doc/techdocs.xml	2007-10-28 08:37:57 UTC (rev 748)
+++ trunk/ddccontrol/doc/techdocs.xml	2007-10-28 08:39:32 UTC (rev 749)
@@ -4,24 +4,26 @@
 <title>Translation (I18N) guide</title>
 <para>Author: Nicolas Boichat &lt;nicolas -at- boichat.ch&gt;</para>
 <para>
-You want to translate ddccontrol to your favorite language? Then, this guide is for you!
+Do you want to translate ddccontrol to your favorite language? Then, this guide is for you!
 </para>
 <para>
-The distribution is splitted in two packages, <filename>ddccontrol</filename>
+The distribution is split in two packages: <filename>ddccontrol</filename>
 (the main program), and <filename>ddccontrol-db</filename> (monitor database).
 </para>
 <para>
-Tools you need: <filename>cvs</filename>,
+Tools you need: <filename>subversion</filename>,
 <filename>automake</filename>/<filename>autoconf</filename>,
 <filename>gettext</filename>, <filename>make</filename>,
 <filename>poedit</filename> (or another tool, or a simple text editor).
 </para>
 <para>
-First, you need to check-out the sources from the CVS repository
+First, you need to check-out the sources from the Subversion repository
 (see
-<ulink url="http://sourceforge.net/cvs/?group_id=117933">project CVS page</ulink>,
-Anonymous CVS Access section). Note you need to perform this operation,
-and the following ones, on both ddccontrol and ddccontrol-db modules (there are
+<ulink url="http://sourceforge.net/svn/?group_id=117933">project Subversion page</ulink>,
+Subversion Access section).
+</para>
+<para>Note you need to perform the following operations
+in both the trunk/ddccontrol and trunk/ddccontrol-db directories (there are
 strings to translate in the main program, and in the database).
 </para>
 <para>
@@ -42,34 +44,27 @@
 </para>
 <para>
 Then open your <filename>.po</filename> file, and translate the strings! I
-recommend that you use a tool like <ulink url="http://poedit.sf.net/">poedit</ulink>
-to edit it, as it warns visually you when strings are wrong, and offers spellcheck,
-but it's your choice .-)
+recommend that you use a tool like <ulink url="http://poedit.sf.net/">poedit</ulink>,
+as it warns you visually when strings are wrong, and offers spellcheck.
+But it's your choice .
 </para>
 <para>
 When you are finished, it would be nice to test if it works by installing and
 running the software, but it is not mandatory, particularly if you don't have
-the needed hardware (i.e. a monitor supporting DDC/CI).
+the needed hardware (i.e. a monitor supporting DDC/CI).  Then, sending the completed
+<filename>.po</filename> files to
+<ulink url="mailto:ddc...@li...">ddccontrol-devel</ulink>.
 </para>
 <para>
-Then, I give you two possibilities for sending the completed
-<filename>.po</filename> files, either you send them to
-<ulink url="mailto:bac...@li...">bacula-devel</ulink>,
-or I give you a CVS write access (in this case, please send me your SourceForge
-ID). The later (CVS) is of course my prefered, as it is less work for me, but if
-you don't feel comfortable with CVS, and don't have time to learn, e-mail is ok too.
+It is a good idea that you subscribe to <filename>ddccontrol-devel</filename>,
+particularly if you have problems to translate some technical strings.
+This way it is not necessary to explain the same terms repeatedly to all translators .
 </para>
 <para>
-I suggest that you subscribe to <filename>ddccontrol-devel</filename>,
-particularly if you have problems to translate some technical strings. So
-I don't have to explain many times the same terms to all translators .-)
+Also, if you encounter mistakes in the original English strings, please report those
+as well.
 </para>
 <para>
-Also, as some of you probably have a better English level than mine, it
-would be really nice to report English mistakes in the original strings
-if you find some.
-</para>
-<para>
 List of languages with active translators:
 <itemizedlist mark='bullet'>
 <listitem>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.


