From 1f62f2aef9981c834a9b128b67f3acc69d986348 Mon Sep 17 00:00:00 2001 From: Dmitry Kalyanov Date: Sun, 16 Aug 2009 10:11:33 +0400 Subject: [PATCH] Stub for Gtk documentation --- doc/Makefile | 17 +++++-- doc/common.texi.inc | 97 +++++++++++++++++++++++++++++++++++++++ doc/gtk.texi | 127 +++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 238 insertions(+), 3 deletions(-) create mode 100644 doc/common.texi.inc create mode 100644 doc/gtk.texi diff --git a/doc/Makefile b/doc/Makefile index 8bb2372..120b32d 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,4 +1,4 @@ -all: doc.html tutorial.html gobject/index.html gobject.pdf gobject/style.css +all: doc.html tutorial.html gobject/index.html gobject.pdf gtk/index.html gtk.pdf doc.html: doc.xml xsltproc -o $@ /usr/share/sgml/docbook/xsl-stylesheets/html/docbook.xsl $< @@ -10,12 +10,23 @@ index.html: doc.xml xsltproc /usr/share/sgml/docbook/xsl-stylesheets/html/chunk.xsl $< gobject/style.css: style.css - cp $< $@ + ([ -x gobject ] || mkdir gobject) && cp $< $@ -gobject/index.html: gobject.texi +gobject/index.html: gobject.texi gobject/style.css + makeinfo --html --css-ref=style.css $< + sbcl --noinform --no-sysinit --no-userinit --load colorize-lisp-examples.lisp $@ + +gtk/style.css: style.css + ([ -x gtk ] || mkdir gtk) && cp $< $@ + +gtk/index.html: gtk.texi gtk/style.css makeinfo --html --css-ref=style.css $< sbcl --noinform --no-sysinit --no-userinit --load colorize-lisp-examples.lisp $@ gobject.pdf: gobject.texi pdftex $< + pdftex $< + +gtk.pdf: gtk.texi + pdftex $< pdftex $< \ No newline at end of file diff --git a/doc/common.texi.inc b/doc/common.texi.inc new file mode 100644 index 0000000..8fd57e3 --- /dev/null +++ b/doc/common.texi.inc @@ -0,0 +1,97 @@ +@c @documentencoding utf-8 + +@macro Function {args} +@defun \args\ +@end defun +@end macro + +@macro Macro {args} +@defmac \args\ +@end defmac +@end macro + +@macro Accessor {args} +@deffn {Accessor} \args\ +@end deffn +@end macro + +@macro GenericFunction {args} +@deffn {Generic Function} \args\ +@end deffn +@end macro + +@macro ForeignType {args} +@deftp {Foreign Type} \args\ +@end deftp +@end macro + +@macro Variable {args} +@defvr {Special Variable} \args\ +@end defvr +@end macro + +@macro Condition {args} +@deftp {Condition Type} \args\ +@end deftp +@end macro + +@macro cffi +@acronym{CFFI} +@end macro + +@macro impnote {text} +@quotation +@strong{Implementor's note:} @emph{\text\} +@end quotation +@end macro + +@c Info "requires" that x-refs end in a period or comma, or ) in the +@c case of @pxref. So the following implements that requirement for +@c the "See also" subheadings that permeate this manual, but only in +@c Info mode. +@ifinfo +@macro seealso {name} +@ref{\name\}. +@end macro +@end ifinfo + +@ifnotinfo +@alias seealso = ref +@end ifnotinfo + +@c Typeset comments in roman font for the TeX output. +@iftex +@alias lispcmt = r +@end iftex +@ifnottex +@alias lispcmt = asis +@end ifnottex + +@c My copy of makeinfo is not generating any HTML for @result{} for +@c some odd reason. (It certainly used to...) +@ifhtml +@macro result +=> +@end macro +@end ifhtml + +@c Similar macro to @result. Its purpose is to work around the fact +@c that ⇒ does not work properly inside @lisp. +@ifhtml +@macro res +@html +⇒ +@end html +@end macro +@end ifhtml + +@ifnothtml +@alias res = result +@end ifnothtml + +@c ============================= Macros ============================= + + +@c Show types, functions, and concepts in the same index. +@syncodeindex tp cp +@syncodeindex fn cp diff --git a/doc/gtk.texi b/doc/gtk.texi new file mode 100644 index 0000000..a17e2ae --- /dev/null +++ b/doc/gtk.texi @@ -0,0 +1,127 @@ +\input texinfo @c -*-texinfo-*- +@c %**start of header (This is for running texinfo on a region.) +@setfilename gtk.info +@settitle CL-Gtk2-GObject +@c %**end of header (This is for running texinfo on a region.) + +@c @documentencoding utf-8 + +@macro Function {args} +@defun \args\ +@end defun +@end macro + +@macro Macro {args} +@defmac \args\ +@end defmac +@end macro + +@macro Accessor {args} +@deffn {Accessor} \args\ +@end deffn +@end macro + +@macro GenericFunction {args} +@deffn {Generic Function} \args\ +@end deffn +@end macro + +@macro ForeignType {args} +@deftp {Foreign Type} \args\ +@end deftp +@end macro + +@macro Variable {args} +@defvr {Special Variable} \args\ +@end defvr +@end macro + +@macro Condition {args} +@deftp {Condition Type} \args\ +@end deftp +@end macro + +@macro cffi +@acronym{CFFI} +@end macro + +@macro impnote {text} +@quotation +@strong{Implementor's note:} @emph{\text\} +@end quotation +@end macro + +@c Info "requires" that x-refs end in a period or comma, or ) in the +@c case of @pxref. So the following implements that requirement for +@c the "See also" subheadings that permeate this manual, but only in +@c Info mode. +@ifinfo +@macro seealso {name} +@ref{\name\}. +@end macro +@end ifinfo + +@ifnotinfo +@alias seealso = ref +@end ifnotinfo + +@c Typeset comments in roman font for the TeX output. +@iftex +@alias lispcmt = r +@end iftex +@ifnottex +@alias lispcmt = asis +@end ifnottex + +@c My copy of makeinfo is not generating any HTML for @result{} for +@c some odd reason. (It certainly used to...) +@ifhtml +@macro result +=> +@end macro +@end ifhtml + +@c Similar macro to @result. Its purpose is to work around the fact +@c that ⇒ does not work properly inside @lisp. +@ifhtml +@macro res +@html +⇒ +@end html +@end macro +@end ifhtml + +@ifnothtml +@alias res = result +@end ifnothtml + +@c ============================= Macros ============================= + + +@c Show types, functions, and concepts in the same index. +@syncodeindex tp cp +@syncodeindex fn cp + +@titlepage +@title CL-GTK2 +@subtitle A Common Lisp binding for Gtk+ +@author Dmitry Kalyanov +@end titlepage + +@contents + +@ifnottex +@node Top +@top cl-gtk2-gtk +@end ifnottex + +@menu +* Introduction:: +@end menu + +@node Introduction +@chapter Introduction + +CL-GTK2 intro + +@bye -- 1.7.10.4