gtk-doc r633 - in trunk: . tests/gobject/src

[stefkost svn gnome org]

Author: stefkost
Date: Wed Jan  7 12:00:43 2009
New Revision: 633
URL: http://svn.gnome.org/viewvc/gtk-doc?rev=633&view=rev

Log:
	* TODO:
	  Ideas about syntax highlighing.
	* style-classic.css:
	  Old color scheme.
	* style.css:
	  Use tango colors. Simplify css.
	* tests/gobject/src/gobject.c:
	  Tell what language this is.



Added:
   trunk/style-classic.css
Modified:
   trunk/ChangeLog
   trunk/TODO
   trunk/style.css
   trunk/tests/gobject/src/gobject.c

Modified: trunk/TODO
==============================================================================
--- trunk/TODO	(original)
+++ trunk/TODO	Wed Jan  7 12:00:43 2009
@@ -168,7 +168,21 @@
 e.g. copyright and legalnotice
 
 = styling =
-xsl produces inline style tag for warnings. We could add a red frame and a warning sign /!\.
+== warnings ==
+xsl produces inline style tag for warnings (e.g. deprecation). We could add a
+colored frame and a warning sign /!\.
+== source code examples==
+http://bugzilla.gnome.org/show_bug.cgi?id=536928
+We could also run a postprocessing script in gtkdoc-mkhtml.
+perl modules:
+  http://search.cpan.org/~palant/Syntax-Highlight-Universal-0.4/Universal.pm
+  http://search.cpan.org/~jamadam/Syntax-Highlight-Engine-Simple-0.08/lib/Syntax/Highlight/Engine/Simple.pm
+  http://search.cpan.org/~hanje/Syntax-Highlight-Engine-Kate-0.04/lib/Syntax/Highlight/Engine/Kate.pod
+    - not packaged for ubuntu
+tools:
+  source-highlight (/usr/bin/source-highlight)
+  source-highlight -i../tests/gobject/examples/gobject.c -o./gobject.html -n -t4 -sc
+  source-highlight -i../tests/gobject/examples/gobject.c -o./gobject.html -n -t4 -sc -cstyle.css --no-doc
 
 = documentation best practises #518427 =
 * we'd like offer a more complete skelleton

Added: trunk/style-classic.css
==============================================================================
--- (empty file)
+++ trunk/style-classic.css	Wed Jan  7 12:00:43 2009
@@ -0,0 +1,179 @@
+.synopsis, .classsynopsis
+{
+  background: #eeeeee;
+  border: solid 1px #aaaaaa;
+  padding: 0.5em;
+}
+.programlisting
+{
+  background: #eeeeff;
+  border: solid 1px #aaaaff;
+  padding: 0.5em;
+}
+.variablelist
+{
+  padding: 4px;
+  margin-left: 3em;
+}
+.variablelist td:first-child
+{
+  vertical-align: top;
+}
+
+/* this is needed so that the local anchors are displayed below the naviagtion */
+ media screen {
+  sup a.footnote
+  {
+    position: relative;
+    top: 0em ! important;
+  }
+  div.refnamediv a[name], div.refsect1 a[name]
+  {
+    position: relative;
+    top: -4.5em;
+  }
+  table.navigation#top
+  {
+    background: #ffeeee;
+    border: solid 1px #ffaaaa;
+    margin-top: 0;
+    margin-bottom: 0;
+    position: fixed;
+    top: 0;
+    left: 0;
+    height: 2em;
+    z-index: 1;
+  }
+  .navigation a
+  {
+    color: #770000;
+  }
+  .navigation a:visited
+  {
+    color: #550000;
+  }
+  td.shortcuts
+  {
+    color: #770000;
+    font-size: 80%;
+    white-space: nowrap;
+  }
+  div.refentry, div.chapter, div.reference, div.part, div.book, div.glossary, div.sect1, div.appendix, div.preface
+  {
+    position: relative;
+    top: 3em;
+    z-index: 0;
+  }
+  div.glossary, div.index
+  {
+    position: relative;
+    top: 2em;
+    z-index: 0;
+  }
+  div.refnamediv
+  {
+    margin-top: 2em;
+  }
+  body
+  {
+    padding-bottom: 20em;
+  }
+}
+ media print {
+  table.navigation {
+    visibility: collapse;
+    display: none;
+  }
+  div.titlepage table.navigation {
+    visibility: visible;
+    display: table;
+    background: #ffeeee;
+    border: solid 1px #ffaaaa;
+    margin-top: 0;
+    margin-bottom: 0;
+    top: 0;
+    left: 0;
+    height: 2em;
+  }
+}
+
+.navigation .title
+{
+  font-size: 200%;
+}
+
+
+div.gallery-float
+{
+  float: left;
+  padding: 10px;
+}
+div.gallery-float img
+{
+  border-style: none;
+}
+div.gallery-spacer
+{
+  clear: both;
+}
+a
+{
+  text-decoration: none;
+}
+a:hover
+{
+  text-decoration: underline;
+  color: #FF0000;
+}
+
+div.table table
+{
+  border-collapse: collapse;
+  border-spacing: 0px;
+  border: solid 1px #777777;
+}
+
+div.table table td, div.table table th
+{
+  border: solid 1px #777777;
+  padding: 3px;
+  vertical-align: top;
+}
+
+div.table table th
+{
+  background-color: #eeeeee;
+}
+
+hr
+{
+  color: #777777;
+  background: #777777;
+  border: none 0px;
+  height: 1px;
+  clear: both;
+}
+
+.footer
+{
+  padding-top: 3.5em;
+  color: #777777;
+  text-align: center;
+  font-size: 80%;
+}
+
+.warning
+{
+  border: solid 1px #cccc33;
+  background: #ffffee;
+  padding: 0.5em;
+  border-width: 1px;
+}
+.warning h3
+{
+  margin-top: 0.0em
+}
+.warning p
+{
+  margin-bottom: 0.0em
+}

Modified: trunk/style.css
==============================================================================
--- trunk/style.css	(original)
+++ trunk/style.css	Wed Jan  7 12:00:43 2009
@@ -1,13 +1,15 @@
 .synopsis, .classsynopsis
 {
-  background: #eeeeee;
-  border: solid 1px #aaaaaa;
+  /* tango:aluminium 1/2 */
+  background: #eeeeec;
+  border: solid 1px #d3d7cf;
   padding: 0.5em;
 }
 .programlisting
 {
-  background: #eeeeff;
-  border: solid 1px #aaaaff;
+  /* tango:sk blue 0/1 */
+  background: #e6f3ff;
+  border: solid 1px #729fcf;
   padding: 0.5em;
 }
 .variablelist
@@ -34,8 +36,9 @@
   }
   table.navigation#top
   {
-    background: #ffeeee;
-    border: solid 1px #ffaaaa;
+    /* tango:scarlet red 0/1 */
+    background: #ffe6e6;
+    border: solid 1px #ef2929;
     margin-top: 0;
     margin-bottom: 0;
     position: fixed;
@@ -44,17 +47,19 @@
     height: 2em;
     z-index: 1;
   }
-  .navigation a
+  .navigation a, a:visited
   {
-    color: #770000;
+    /* tango:scarlet red 3 */
+    color: #a40000;
   }
-  .navigation a:visited
+  .navigation a:hover
   {
-    color: #550000;
+    /* tango:scarlet red 1 */
+    color: #ef2929;
   }
   td.shortcuts
   {
-    color: #770000;
+    color: #cc0000;
     font-size: 80%;
     white-space: nowrap;
   }
@@ -87,8 +92,9 @@
   div.titlepage table.navigation {
     visibility: visible;
     display: table;
-    background: #ffeeee;
-    border: solid 1px #ffaaaa;
+    /* tango:scarlet red 0/1 */
+    background: #ffe6e6;
+    border: solid 1px #ef2929;
     margin-top: 0;
     margin-bottom: 0;
     top: 0;
@@ -102,7 +108,6 @@
   font-size: 200%;
 }
 
-
 div.gallery-float
 {
   float: left;
@@ -116,44 +121,48 @@
 {
   clear: both;
 }
-a
+
+a, a:visited
 {
   text-decoration: none;
+  /* tango:sky blue 2 */
+  color: #3465a4;
 }
 a:hover
 {
   text-decoration: underline;
-  color: #FF0000;
+  /* tango:sky blue 1 */
+  color: #729fcf;
 }
 
 div.table table
 {
   border-collapse: collapse;
   border-spacing: 0px;
-  border-style: solid;
-  border-color: #777777;
-  border-width: 1px;
+  /* tango:aluminium 3 */
+  border: solid 1px #babdb6;
 }
 
 div.table table td, div.table table th
 {
-  border-style: solid;
-  border-color: #777777;
-  border-width: 1px;
+  /* tango:aluminium 3 */
+  border: solid 1px #babdb6;
   padding: 3px;
   vertical-align: top;
 }
 
 div.table table th
 {
-  background-color: #eeeeee;
+  /* tango:aluminium 2 */
+  background-color: #d3d7cf;
 }
 
 hr
 {
-  color: #777777;
-  background: #777777;
-  border: 0;
+  /* tango:aluminium 3 */
+  color: #babdb6;
+  background: #babdb6;
+  border: none 0px;
   height: 1px;
   clear: both;
 }
@@ -161,15 +170,17 @@
 .footer
 {
   padding-top: 3.5em;
-  color: #777777;
+  /* tango:aluminium 3 */
+  color: #babdb6;
   text-align: center;
   font-size: 80%;
 }
 
 .warning
 {
-  border: solid 1px #cccc33;
-  background: #ffffee;
+  /* tango:orange 0/1 */
+  background: #ffeed9;
+  border: solid 1px #ffb04f;
   padding: 0.5em;
   border-width: 1px;
 }

Modified: trunk/tests/gobject/src/gobject.c
==============================================================================
--- trunk/tests/gobject/src/gobject.c	(original)
+++ trunk/tests/gobject/src/gobject.c	Wed Jan  7 12:00:43 2009
@@ -16,7 +16,7 @@
  *
  * You can also change parameters:
  * <informalexample>
- * <programlisting><xi:include xmlns:xi="http://www.w3.org/2003/XInclude"; parse="text" href="../../examples/gobject.c" /></programlisting>
+ * <programlisting language="c"><xi:include xmlns:xi="http://www.w3.org/2003/XInclude"; parse="text" href="../../examples/gobject.c" /></programlisting>
  * </informalexample>
  */