gtk-doc r641 - in trunk: . tests/gobject/docs

[stefkost svn gnome org]

Author: stefkost
Date: Fri Jan  9 22:16:02 2009
New Revision: 641
URL: http://svn.gnome.org/viewvc/gtk-doc?rev=641&view=rev

Log:
	* HACKING:
	* TODO:
	* configure.in:
	* gtkdoc-fixxref.in:
	  Look for source-highlight and highlight. Not perfect yet, highlight uses
	  different classes in the css :/.
	* tests/gobject/docs/tester-docs.xml:
	  More header data in the examples.



Modified:
   trunk/ChangeLog
   trunk/HACKING
   trunk/TODO
   trunk/configure.in
   trunk/gtkdoc-fixxref.in
   trunk/tests/gobject/docs/tester-docs.xml

Modified: trunk/HACKING
==============================================================================
--- trunk/HACKING	(original)
+++ trunk/HACKING	Fri Jan  9 22:16:02 2009
@@ -38,3 +38,13 @@
 if we want a icon on the newsfeed, we should copy a icon like on
   http://ftp.acc.umu.se/pub/GNOME/sources/rhythmbox/rhythmbox.png
   e.g. /usr/share/icons/hicolor/48x48/apps/devhelp.png
+  
+Optimizing & Meassuring
+=======================
+
+cd tests/gobject/docs/html
+time xsltproc --nonet --xinclude --stringparam gtkdoc.bookname "tester" --stringparam gtkdoc.version "1.12" ../../../../gtk-doc.xsl ../tester-docs.xml
+~ 3 sec.
+time saxon ../tester-docs.xml ../../../../gtk-doc.xsl gtkdoc.bookname="tester" gtkdoc.version="1.12"
+~ 53 sec.
+

Modified: trunk/TODO
==============================================================================
--- trunk/TODO	(original)
+++ trunk/TODO	Fri Jan  9 22:16:02 2009
@@ -185,11 +185,13 @@
   source-highlight -i./tests/gobject/examples/gobject.c -o$HOME/temp/gobject.html -n -t4 -sc -cstyle.css --no-doc
   source-highlight -i./tests/gobject/examples/gobject.c -o$HOME/temp/gobject.xml -n -t4 -sc -f docbook
   
+  highlight -itests/gobject/examples/gobject.c -o$HOME/temp/gobject.xml -l -H -f -j2
+  
 if we highlight to docbook, we just get emphasis (bold)
 if we hightlight to html we get colors, we need to cehck what tags we should process though:
 <pre class="programlisting"> is used for all code boxes.
 <div class="informalexample"><pre class="programlisting"> is used for examples.
-
+  
 links in the same module only work once its installed
 
 = documentation best practises #518427 =

Modified: trunk/configure.in
==============================================================================
--- trunk/configure.in	(original)
+++ trunk/configure.in	Fri Jan  9 22:16:02 2009
@@ -80,6 +80,25 @@
 JH_CHECK_XML_CATALOG([http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl],
    [DocBook XSL Stylesheets])
 
+dnl
+dnl Check for syntax highlighters
+dnl
+HIGHLIGHT_OPTIONS=""
+AC_PATH_PROG([HIGHLIGHT], [source-highlight])
+if test -n "$HIGHLIGHT"; then
+  HIGHLIGHT_OPTIONS="-n -t4 -sc -cstyle.css --no-doc -i"
+else
+  AC_PATH_PROG([HIGHLIGHT], [highlight])
+  if test -n "$HIGHLIGHT"; then
+    HIGHLIGHT_OPTIONS="-l -H -f -j2"
+  else
+    dnl test for other highlighters here
+    AC_MSG_ERROR([no syntax highlighter found])
+  fi
+fi
+AC_SUBST([HIGHLIGHT_OPTIONS])
+
+
 #
 # Set PACKAGE_DATA_DIR so we can find the script containing common routines.
 #
@@ -196,6 +215,9 @@
 test x$scrollkeeper_config != xno \
     && AC_MSG_NOTICE([** Scrollkeeper support enabled]) \
     || AC_MSG_NOTICE([   Scrollkeeper support disabled])
+test -n "$HIGHLIGHT" \
+    && AC_MSG_NOTICE([** Syntax highlighting of examples enabled, using $HIGHLIGHT]) \
+    || AC_MSG_NOTICE([   Syntax highlighting of examples disabled])
 test x$build_tests != xno \
     && AC_MSG_NOTICE([** Building regression tests]) \
     || AC_MSG_NOTICE([   Skipping regression tests])

Modified: trunk/gtkdoc-fixxref.in
==============================================================================
--- trunk/gtkdoc-fixxref.in	(original)
+++ trunk/gtkdoc-fixxref.in	Fri Jan  9 22:16:02 2009
@@ -291,13 +291,12 @@
     $source =~ s/[\s\n]+$//gs;
     # write source to a temp file
     my $temp_source_file="$MODULE_DIR/_temp_src.$$";
-    open (NEWFILE, ">$temp_source_file")
-	|| die "Can't open $temp_source_file: $!";
+    open (NEWFILE, ">$temp_source_file") || die "Can't open $temp_source_file: $!";
     print NEWFILE $source;
     close (NEWFILE);
     
     # format source
-    my $highlighted_source=`source-highlight -i$temp_source_file -n -t4 -sc -cstyle.css --no-doc`;
+    my $highlighted_source=` HIGHLIGHT@ @HIGHLIGHT_OPTIONS $temp_source_file`;
     $highlighted_source =~ s%^<\!-- .*? -->%%gs;
     $highlighted_source =~ s%<pre><tt>(.*?)</tt></pre>%$1%gs;
     # revert double entity replacement

Modified: trunk/tests/gobject/docs/tester-docs.xml
==============================================================================
--- trunk/tests/gobject/docs/tester-docs.xml	(original)
+++ trunk/tests/gobject/docs/tester-docs.xml	Fri Jan  9 22:16:02 2009
@@ -7,8 +7,11 @@
 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude";>
   <bookinfo>
     <title>tester Reference Manual</title>
+    <corpauthor>
+      The <ulink url="http://www.gtk.org/gtk-doc";>gtk-doc team</ulink>.
+    </corpauthor>
     <releaseinfo>
-      for tester [VERSION].
+      Reference Manual for tester [VERSION].
       The latest version of this documentation can be found on-line at
       <ulink role="online-location" url="http://[SERVER]/tester/index.html";>http://[SERVER]/tester/</ulink>.
     </releaseinfo>