Commit c89de432 authored by Emmanuele Bassi's avatar Emmanuele Bassi

docs: Remove manual/

The programmers manual never materialized, and its role has been taken
by both the cookbook and the API reference.
parent b1910679
......@@ -37,10 +37,6 @@ depcomp
/doc/cookbook/*.stamp
/doc/cookbook/clutter-cookbook.xml
/doc/cookbook/clutter-cookbook.html
/doc/manual/*.pdf
/doc/manual/html
/doc/manual/*.stamp
/doc/manual/clutter-manual.xml
doc/reference/clutter/clutter-*.txt
!/doc/reference/clutter/clutter-sections.txt
doc/reference/clutter/html
......
......@@ -980,8 +980,6 @@ AC_CONFIG_FILES([
doc/reference/cally/Makefile
doc/reference/cally/cally-docs.xml
doc/common/Makefile
doc/manual/Makefile
doc/manual/clutter-manual.xml
doc/cookbook/Makefile
doc/cookbook/clutter-cookbook.xml
doc/cookbook/examples/Makefile
......
......@@ -8,7 +8,7 @@ if ENABLE_DOCS
SUBDIRS += common cookbook
endif
DIST_SUBDIRS = reference common cookbook manual
DIST_SUBDIRS = reference common cookbook
EXTRA_DIST = \
CODING_STYLE \
......
HTML_DIR = $(datadir)/gtk-doc/html
TARGET_DIR = $(HTML_DIR)/clutter-manual
HTML_FILES = $(srcdir)/html/*.html
IMAGE_FILES = $(srcdir)/images/*.png
EXTRA_DIST = $(IMAGE_FILES)
CLEANFILES = \
pdf-build.stamp \
html-build.stamp
pdf-build.stamp: clutter-manual.xml
SP_ENCODING=XML SP_CHARSET_FIXED=YES \
$(JW) -b pdf $(top_builddir)/doc/manual/clutter-manual.xml \
&& mv -f $(srcdir)/clutter-manual.pdf clutter-manual-@CLUTTER_API_VERSION@.pdf \
&& echo timestamp > $(@F)
html-build.stamp: clutter-manual.xml
$(mkinstalldirs) html \
&& $(XSLTPROC) --nonet --xinclude -o html/ \
--path $(top_srcdir)/doc/common \
--path . \
--stringparam gtkdoc.bookname "clutter-manual" \
--stringparam gtkdoc.version @CLUTTER_API_VERSION@ \
$(srcdir)/ref-html-style.xsl \
$(top_builddir)/doc/manual/clutter-manual.xml \
&& echo timestamp > $(@F)
if ENABLE_PDFS
pdf_target = pdf-build.stamp
else
pdf_target =
endif
if ENABLE_DOCS
all-local: html-build.stamp $(pdf_target)
else
all-local:
endif
clean-local:
@rm -rf html ; \
rm -f *.pdf ; \
rm -f *.stamp
uninstall-local:
install-data-local:
installfiles=`echo $(srcdir)/html/*`; \
if test "$$installfiles" = '$(srcdir)/html/*'; \
then echo '-- Nothing to install' ; \
else \
$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) ; \
for file in `ls $(srcdir)/$(HTML_FILES)`; do \
if [ -f $$file ]; then \
basefile=`echo $$file | sed -e 's,^.*/,,'`; \
$(INSTALL_DATA) $$file $(DESTDIR)$(TARGET_DIR)/$$basefile; \
fi \
done; \
fi; \
if [ -d $(srcdir)/images ]; \
then \
$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)/images ; \
for file in `ls $(srcdir)/$(IMAGE_FILES)`; do \
if [ -f $$file ]; \
then \
basefile=`echo $$file | sed -e 's,^.*/,,'`; \
$(INSTALL_DATA) $$file $(DESTDIR)$(TARGET_DIR)/images/$$basefile; \
fi \
done; \
fi; \
$(INSTALL_DATA) $(top_srcdir)/doc/common/style.css $(DESTDIR)$(TARGET_DIR)/style.css; \
$(INSTALL_DATA) $(srcdir)/html/clutter-manual.devhelp $(DESTDIR)$(TARGET_DIR)/clutter-manual.devhelp
.PHONY : doc
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY apiversion "@CLUTTER_API_VERSION@">
<!ENTITY appurl "http://www.clutter-project.org/docs">
<!ENTITY author_mail "mallum@o-hand.com">
]>
<book lang="en">
<bookinfo>
<author>
<firstname>Matthew</firstname>
<surname>Allum</surname>
<address><email>&author_mail;</email></address>
</author>
<copyright>
<year>2007</year>
</copyright>
<legalnotice>
<para>This document is distributed under the terms of
the GNU General Public License as published by the Free
Software Foundation; either version 2 of the License,
or (at your option) any later version.</para>
<para>A copy of this license can be found in the file COPYING included with the source code of this program.</para>
</legalnotice>
<title>Clutter Application Developer Manual</title>
<releaseinfo>for Clutter &apiversion;</releaseinfo>
</bookinfo>
<chapter id="intro">
<title>Introduction</title>
<section>
<title>About Clutter</title>
<para>FIXME</para>
</section>
<section>
<title>About this document</title>
<para>
This documentation is available in various formats like HTML, text and PDF. The latest version is
always available at <ulink url="&appurl;">&appurl;</ulink>.
</para>
</section>
<section>
<title>Where to get it</title>
<para>
You can obtain Clutter from <ulink url="&appurl;">&appurl;</ulink>
or perhaps from your distributor.
</para>
</section>
<section>
<title>License</title>
<para>
Clutter is distributed under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
A copy of this license can be found in the file COPYING included with the source code of this
program.
</para>
</section>
</chapter>
<chapter id="installation">
<title>Installation</title>
<section>
<title>Requirements</title>
<para>
</para>
<para>
</para>
</section>
<section id="binary_packages">
<title>Binary packages</title>
<para>
</para>
</section>
</chapter>
<appendix id="FAQ">
<title>Frequently Asked Questions</title>
<qandaset defaultlabel='qanda'>
<qandaentry>
<question>
<para>Why do Clutter applications run <emphasis>really</emphasis> slowly on Intel cards even though direct rendering support is reported.</para>
</question>
<answer>
<para>There is a bug in some versions of the Intel drivers that causes the driver to 'stall' when attempting to sync to vblank (as Clutter does by default). The fix is to either upgrade your drivers or set 'CLUTTER_VBLANK=none' when running Clutter applications.</para>
</answer>
</qandaentry>
</qandaset>
</appendix>
<appendix id="contrib">
<title>Contributing to this document</title>
<para>This document is written in Docbook XML. The source file for it is located in the subdirectory "doc/manual" of the source directory of Clutter.</para>
</appendix>
</book>
<?xml version='1.0'?>
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
version='1.0'
xmlns="http://www.w3.org/TR/xhtml1/transitional"
exclude-result-prefixes="#default">
<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"/>
<!-- Use stylesheet -->
<xsl:param name="html.stylesheet" select="'style.css'"/>
<xsl:param name="chunker.output.encoding" select="'UTF-8'"/>
</xsl:stylesheet>
body address
{
line-height: 1.3;
margin: .6em 0;
}
body blockquote
{
margin-top: .75em;
line-height: 1.5;
margin-bottom: .75em;
}
html body
{
margin: 1em 2% 1em 2%;
line-height: 1.2;
background-color: #ffffff;
}
body pre
{
margin: .75em 0;
line-height: 1.3;
color: #4f3f3f;
font-weight: bold;
}
body div
{
margin: 0;
}
dl
{
margin: .4em 0;
line-height: 1.2;
}
.legalnotice
{
font-size: small;
}
h1,h2,h3,h4,h5,h6,
div.example p b,
.question,
div.table p b,
div.procedure p b
{
color: #990000;
}
.option
{
color: #0000ca;
font-weight: bold;
}
.parameter
{
color: #007a00;
font-weight: bold;
}
a
{
color: #000000;
}
a:hover
{
color: #3c3c3c;
border-bottom: 1px solid #dc0000;
}
hr
{
background-color: #9c9c9c;
border-style: none;
height: 1px;
}
li
{
list-style-type: square;
}
.programlisting, .screen
{
background-color: #F8F9FD;
border-color: #907777;
border-width: 1px;
border-style: solid;
padding: 0.5em;
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment