telegnome r28 - in trunk: . doc doc/C



Author: cjwatson
Date: Sun Apr 27 21:28:20 2008
New Revision: 28
URL: http://svn.gnome.org/viewvc/telegnome?rev=28&view=rev

Log:
Convert to gnome-doc-utils.
* doc/C/telegnome.sgml: Rename to ...
* doc/C/telegnome.xml: ... this. Convert to DocBook XML V4.1.2
article. Add abstract. Mark myself as maintainer. Add revhistory.
* doc/C/Makefile.am, doc/C/topic.dat: Remove.
* doc/telegnome.omf.in: New file.
* doc/Makefile.am: Include gnome-doc-utils.make. Add dist-hook. Set
DOC_MODULE.
* Makefile.am (EXTRA_DIST): Remove m4/ChangeLog. Add
gnome-doc-utils.make.
(DISTCLEANFILES): Set to gnome-doc-utils.make.
* configure.in: Add AC_CONFIG_MACRO_DIR and GNOME_DOC_INIT.
(AC_CONFIG_FILES): Remove doc/C/Makefile.
* NEWS: Document conversion.

Added:
   trunk/doc/C/telegnome.xml
      - copied, changed from r26, /trunk/doc/C/telegnome.sgml
   trunk/doc/telegnome.omf.in
Removed:
   trunk/doc/C/Makefile.am
   trunk/doc/C/telegnome.sgml
   trunk/doc/C/topic.dat
Modified:
   trunk/   (props changed)
   trunk/ChangeLog
   trunk/Makefile.am
   trunk/NEWS
   trunk/configure.in
   trunk/doc/   (props changed)
   trunk/doc/C/   (props changed)
   trunk/doc/Makefile.am

Modified: trunk/Makefile.am
==============================================================================
--- trunk/Makefile.am	(original)
+++ trunk/Makefile.am	Sun Apr 27 21:28:20 2008
@@ -1,8 +1,11 @@
 SUBDIRS=src po pixmaps doc
 
-EXTRA_DIST = config.rpath m4/ChangeLog \
+EXTRA_DIST = config.rpath \
 	$(srcdir)/telegnome.desktop \
-	BUGS
+	BUGS \
+	gnome-doc-utils.make
+
+DISTCLEANFILES = gnome-doc-utils.make
 
 Internetdir=$(datadir)/gnome/apps/Internet
 Internet_DATA= telegnome.desktop

Modified: trunk/NEWS
==============================================================================
--- trunk/NEWS	(original)
+++ trunk/NEWS	Sun Apr 27 21:28:20 2008
@@ -2,7 +2,7 @@
 ==========================
 
 New maintainer (Colin Watson).
-Port to GNOME 2 and GnomeVFS.
+Port to GNOME 2, GnomeVFS, and gnome-doc-utils.
 
 Translations:
   az (Vasif ÄsmayÄloÄlu MD), fr (fred), pt_BR (Ricardo Soares GuimarÃes),

Modified: trunk/configure.in
==============================================================================
--- trunk/configure.in	(original)
+++ trunk/configure.in	Sun Apr 27 21:28:20 2008
@@ -1,6 +1,7 @@
 AC_INIT
 AC_PREREQ(2.50)
 AC_CONFIG_SRCDIR([src/main.c])
+AC_CONFIG_MACRO_DIR([m4])
 
 AM_CONFIG_HEADER(config.h)
 AM_INIT_AUTOMAKE(telegnome, 0.0.10)
@@ -10,6 +11,7 @@
 GNOME_COMMON_INIT
 GNOME_DEBUG_CHECK
 GNOME_COMPILE_WARNINGS([maximum])
+GNOME_DOC_INIT
 
 AC_ISC_POSIX
 AC_PROG_CC
@@ -34,6 +36,5 @@
 	   src/Makefile
 	   po/Makefile.in
 	   doc/Makefile
-	   doc/C/Makefile
 	 ])
 AC_OUTPUT

Copied: trunk/doc/C/telegnome.xml (from r26, /trunk/doc/C/telegnome.sgml)
==============================================================================
--- /trunk/doc/C/telegnome.sgml	(original)
+++ trunk/doc/C/telegnome.xml	Sun Apr 27 21:28:20 2008
@@ -1,8 +1,16 @@
-<!DOCTYPE book PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.0//EN">
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"; [
+  <!ENTITY version "0.1.0">
+]>
 
-<book id="telegnome">
-  <bookinfo>
+<article id="telegnome">
+  <articleinfo>
     <title>TeleGNOME User's Guide</title>
+    <abstract role="description">
+      <para>
+	TeleGNOME downloads and displays Teletext pages from the Internet.
+      </para>
+    </abstract>
     <authorgroup>
       <author>
 	<firstname>Arjan</firstname> <surname>Scherpenisse</surname>
@@ -28,7 +36,7 @@
 	  </address>
 	</affiliation>
       </author>
-      <author>
+      <author role="maintainer">
 	<firstname>Colin</firstname> <surname>Watson</surname>
 	<affiliation>
 	  <address>
@@ -39,6 +47,8 @@
     </authorgroup>
     <copyright>
       <year>1999, 2000</year> <holder>Arjan Scherpenisse</holder>
+    </copyright>
+    <copyright>
       <year>2008</year> <holder>Colin Watson</holder>
     </copyright>
     <legalnotice>
@@ -61,90 +71,91 @@
       <para>For more details see the file COPYING in the source
 	distribution of GNOME.</para>
     </legalnotice>
-  </bookinfo>
+    <revhistory>
+      <revision>
+	<revnumber>TeleGNOME User's Guide &version;</revnumber>
+	<date>2008-04-27</date>
+      </revision>
+    </revhistory>
+  </articleinfo>
  
-  <toc></toc>
-
-  <chapter id="users-manual">
-    <title>TeleGNOME users manual.</title>
-    <sect1 id="intro">
-      <title>Introduction</title>
-      <para>TBD.</para>
-    </sect1>    
+  <sect1 id="intro">
+    <title>Introduction</title>
+    <para>TBD.</para>
+  </sect1>    
+  
+  <sect1 id="ui">
+    <title>The User Interface</title> 
     
-    <sect1 id="ui">
-      <title>The User Interface.</title> 
-      
-      <para>The main interface consists of a menubar, a toolbar, the
-       currently viewed page, and the status bar.</para>
-      
-      <sect2>
-	<title>the menu</title> 
+    <para>The main interface consists of a menubar, a toolbar, the
+     currently viewed page, and the status bar.</para>
+    
+    <sect2>
+      <title>The menu</title> 
 
-	<para>The menubar consists of 3 pull-down menus, called
-	"File", "Settings", and "Help". The following options are
-	available in each of these menus.</para>
-	
-	<itemizedlist>
-	  <listitem>
-	    <para>File</para>
-	  </listitem>
-	  <listitem>
-	    <para>Settings</para>
-	  </listitem>
-	  <listitem>
-	    <para>Channels</para>
-	  </listitem>
-	  <listitem>
-	    <para>Help</para>
-	  </listitem>
-	</itemizedlist>
-      </sect2>
-    </sect1>
+      <para>The menubar consists of 3 pull-down menus, called
+      "File", "Settings", and "Help". The following options are
+      available in each of these menus.</para>
+      
+      <itemizedlist>
+	<listitem>
+	  <para>File</para>
+	</listitem>
+	<listitem>
+	  <para>Settings</para>
+	</listitem>
+	<listitem>
+	  <para>Channels</para>
+	</listitem>
+	<listitem>
+	  <para>Help</para>
+	</listitem>
+      </itemizedlist>
+    </sect2>
+  </sect1>
 
-    <sect1 id="using">
-      
-      <title>Using TeleGNOME.</title>
-      
-      <para>Normal teletext consists of a series of pages, which are
-      transmitted in quick succession by the broadcaster. Whenever you
-      want your TV to tune in on a specific page, your TV will capture
-      that page only and show it on the screen.</para>
+  <sect1 id="using">
     
-      <para>Every page can have subpages, that is: the page consists
-      of a couple of subpages. This way the numbering of pages can
-      stay the same, but the amount of information in a page can vary.
-      For example: the page that serves the news (101 on Dutch TV) can
-      have just a few items of information (nothing happened in the
-      world), and thus have no subpages, or it can have a lot of
-      items, spread out on subpages.  These subpages are usually
-      automatically updated on your TV, timed by an interval in which
-      the page can be read. This means that if you want to see subpage
-      7 and the current displayed subpage is 3, you'll have to wait
-      some time. This can be very annoying. Also, if the timing is to
-      fast, the page may have disappeared before you've read it, which
-      means that you'll have to wait for the page to come up
-      again.</para>
+    <title>Using TeleGNOME</title>
     
-      <para>Using <application>TeleGNOME</application> is very similar to using teletext on any
-      regular television set, but without the sometimes irritating
-      long waits for a page to come up.</para>
-
-      <para>Just like teletext on a TV, you can simply type a page
-      number and press <keycap>ENTER</keycap> to load that page. This
-      number can be any number served by the current teletext channel,
-      and it is not restricted to the numbers shown on the current
-      page.</para>
-
-      <para>You can load subpages directly by typing the page number, a
-      dash or a slash and the subpage number. For example: if you want
-      to load the second page of page 201, just type
-      <keycap>201/2</keycap>.</para>
-
-      <para>When you're ready to read the next subpage (if any) you
-      can press the <keycap>next</keycap> button. This will load the
-      next subpage. Alternatively you can just enter the requested
-      subpage immediately using the keyboard.</para>
-    </sect1>
-  </chapter>
-</book>
+    <para>Normal teletext consists of a series of pages, which are
+    transmitted in quick succession by the broadcaster. Whenever you
+    want your TV to tune in on a specific page, your TV will capture
+    that page only and show it on the screen.</para>
+  
+    <para>Every page can have subpages, that is: the page consists
+    of a couple of subpages. This way the numbering of pages can
+    stay the same, but the amount of information in a page can vary.
+    For example: the page that serves the news (101 on Dutch TV) can
+    have just a few items of information (nothing happened in the
+    world), and thus have no subpages, or it can have a lot of
+    items, spread out on subpages.  These subpages are usually
+    automatically updated on your TV, timed by an interval in which
+    the page can be read. This means that if you want to see subpage
+    7 and the current displayed subpage is 3, you'll have to wait
+    some time. This can be very annoying. Also, if the timing is to
+    fast, the page may have disappeared before you've read it, which
+    means that you'll have to wait for the page to come up
+    again.</para>
+  
+    <para>Using <application>TeleGNOME</application> is very similar to using teletext on any
+    regular television set, but without the sometimes irritating
+    long waits for a page to come up.</para>
+
+    <para>Just like teletext on a TV, you can simply type a page
+    number and press <keycap>ENTER</keycap> to load that page. This
+    number can be any number served by the current teletext channel,
+    and it is not restricted to the numbers shown on the current
+    page.</para>
+
+    <para>You can load subpages directly by typing the page number, a
+    dash or a slash and the subpage number. For example: if you want
+    to load the second page of page 201, just type
+    <keycap>201/2</keycap>.</para>
+
+    <para>When you're ready to read the next subpage (if any) you
+    can press the <keycap>next</keycap> button. This will load the
+    next subpage. Alternatively you can just enter the requested
+    subpage immediately using the keyboard.</para>
+  </sect1>
+</article>

Modified: trunk/doc/Makefile.am
==============================================================================
--- trunk/doc/Makefile.am	(original)
+++ trunk/doc/Makefile.am	Sun Apr 27 21:28:20 2008
@@ -1,3 +1,7 @@
-SUBDIRS = C
+include $(top_srcdir)/gnome-doc-utils.make
 
 dist_man1_MANS = telegnome.1
+
+dist-hook: doc-dist-hook
+
+DOC_MODULE = telegnome

Added: trunk/doc/telegnome.omf.in
==============================================================================
--- (empty file)
+++ trunk/doc/telegnome.omf.in	Sun Apr 27 21:28:20 2008
@@ -0,0 +1,9 @@
+<?xml version="1.0" standalone="no"?>
+<omf>
+  <resource>
+    <subject category="GNOME|Internet"/>
+    <type>manual</type>
+    <relation seriesid="8ab86798-1492-11dd-8e16-f739167a86d0"/>
+    <rights type="GNU GPL" license.version="2" holder="Arjan Scherpenisse"/>
+  </resource>
+</omf>



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