brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
8668a019a0
mutter/doc/cookbook/Makefile.am

144 lines
4.0 KiB
Makefile
Raw Normal View History

cookbook: Add example code The cookbook should also include fully functional code examples. We can even XInclude them into the docbook XML itself. The examples should be built with the coobook, so that we can always make sure they are up to date.
2010-07-18 09:53:06 +00:00
SUBDIRS = examples
cookbook: Split the cookbook chapters Use separate files, to avoid making the XML too big and uneditable. This breaks the PDF build.
2010-07-01 10:29:46 +00:00
NULL =
[cookbook] Build the Cookbook as a devhelp document Instead of creating stand-alone HTML files, use XSLT to transform the DocBook into a DevHelp file, so that we can read the Cookbook inside DevHelp -- just like the API reference.
2009-09-02 17:11:06 +00:00
HTML_DIR = $(datadir)/gtk-doc/html
TARGET_DIR = $(HTML_DIR)/clutter-cookbook
cookbook: Split the cookbook chapters Use separate files, to avoid making the XML too big and uneditable. This breaks the PDF build.
2010-07-01 10:29:46 +00:00
XML_FILES = \
actors.xml \
animations.xml \
events.xml \
introduction.xml \
recipe-template.xml \
textures.xml \
$(NULL)
cookbook: Clean up build Create two HTML versions of the cookbook: • single page • multiple pages Use the online version of the DocBook XHTML XSL, and disable the PDF generation until we can restore it.
2010-07-01 11:17:01 +00:00
XSLTOPTS = \
--stringparam html.stylesheet style.css \
--stringparam chapter.autolabel 1 \
--stringparam appendix.autolabel 1 \
--stringparam section.autolabel 1 \
--stringparam gtkdoc.bookname "clutter-cookbook" \
--stringparam gtkdoc.version @CLUTTER_API_VERSION@ \
--path $(top_srcdir)/doc/common \
--xinclude
XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current
XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl
build: Distcheck fixes
2010-06-30 10:55:52 +00:00
HTML_FILES = html/*.html
cookbook: Fix build so CSS files get installed I had changed the build so CSS files get put into the HTML build directory; but done it in such a way that they were then being ignored during install. Fixed this.
2010-07-06 15:22:47 +00:00
CSS_FILES = html/*.css
cookbook: Add a missing image to the list
2010-07-16 16:20:38 +00:00
IMAGE_FILES = \
images/clutter-logo.png \
images/textures-reflection.png \
cookbook: Added a recipe about making an actor transparent Explains how to make an actor transparent so that other actors are visible through it. Also explains a bit more generally about opacity and how it's computed from the actor, container, and color; and how actor visibility is affected by depth (fog) and depth order.
2010-07-15 18:47:53 +00:00
images/actors-opacity.png \
Merge remote branch 'elliot/cookbook-actor-opacity' Conflicts: doc/cookbook/Makefile.am
2010-07-16 16:23:36 +00:00
images/actors-opacity-container-affects-opacity.png \
cookbook: Add an empty recipe for shadows under text Currently, it's just an example and an image, but it should be easy to flesh it out properly for the "Text" chapter.
2010-07-18 09:56:35 +00:00
images/text-shadow.png \
cookbook: Add a missing image to the list
2010-07-16 16:20:38 +00:00
$(NULL)
cookbook: Added recipe for fading actors in/out Added a recipe showing how to fade actors in/out by animating their opacity property, using both implicit animations and ClutterState.
2010-07-16 11:34:44 +00:00
VIDEO_FILES = \
videos/animations-fading-out.ogv \
videos/animations-fading-in-then-out.ogv \
cookbook: Added recipe for animated rotation of an actor New recipe covering how to animate rotation of an actor (in all axes). Covers various factors affecting rotation animation (like orientation of axes, parent rotation/orientation), as well as trying to make rotations easier to visualise (e.g. describing how rotation direction is affected by those factors, how a rotation can be expected to look when animated). Uses implicit animations for code examples. Also refers to a full code example which uses ClutterState.
2010-07-21 13:50:32 +00:00
videos/animations-rotating-x-minus-45.ogv \
videos/animations-rotating-y-45.ogv \
videos/animations-rotating-z-90.ogv \
videos/animations-rotating-x-minus-180-with-y-minus-96.ogv \
videos/animations-rotating-x-minus-180-with-z-minus-96.ogv \
videos/animations-rotating-x-centered.ogv \
videos/animations-rotating-y-centered.ogv \
videos/animations-rotating-z-centered.ogv \
videos/animations-rotating-container-reverses-direction.ogv \
cookbook: Added recipe for fading actors in/out Added a recipe showing how to fade actors in/out by animating their opacity property, using both implicit animations and ClutterState.
2010-07-16 11:34:44 +00:00
$(NULL)
[cookbook] Build the Cookbook as a devhelp document Instead of creating stand-alone HTML files, use XSLT to transform the DocBook into a DevHelp file, so that we can read the Cookbook inside DevHelp -- just like the API reference.
2009-09-02 17:11:06 +00:00
cookbook: Added support for inline video Amended Makefile to copy content of videos directory into installation directories. Also copies videos and images into the html/ directory during the build, so that the built cookbook can be viewed locally (for testing without having to install). Added an XSLT template to transform Docbook <inlinemediaobject> elements into HTML 5 <video> elements, with a fallback to link to the video displayed for browsers without HTML 5 support. Added note to "Contributing" appendix explaining how to put video into a recipe.
2010-07-15 12:27:02 +00:00
EXTRA_DIST = \
clutter-cookbook.xml.in \
$(IMAGE_FILES) \
$(XML_FILES) \
$(VIDEO_FILES)
[cookbook] Build the Cookbook as a devhelp document Instead of creating stand-alone HTML files, use XSLT to transform the DocBook into a DevHelp file, so that we can read the Cookbook inside DevHelp -- just like the API reference.
2009-09-02 17:11:06 +00:00
Add the Clutter Cookbook to the build The "Clutter Cookbook" is a document designed to contain solutions to common problems applications developers might encounter when using Clutter. It is meant as a companion to the API reference but it requires knowledge of the Clutter API and framework.
2008-12-11 16:57:46 +00:00
CLEANFILES = \
pdf-build.stamp \
docs: Clean up the additional documentation build • Make the manual a DevHelp book • Make the generation of PDFs of the cookbook and the manual optional • Consequently, make the hard dependency on jw optional • Clean up the checks and build for the additional documentation
2009-09-03 12:04:59 +00:00
html-build.stamp
Add the Clutter Cookbook to the build The "Clutter Cookbook" is a document designed to contain solutions to common problems applications developers might encounter when using Clutter. It is meant as a companion to the API reference but it requires knowledge of the Clutter API and framework.
2008-12-11 16:57:46 +00:00
pdf-build.stamp: clutter-cookbook.xml
SP_ENCODING=XML SP_CHARSET_FIXED=YES \
build: Distcheck fixes
2010-06-30 10:55:52 +00:00
$(JW) -b pdf $(top_builddir)/doc/cookbook/clutter-cookbook.xml \
&& mv -f clutter-cookbook.pdf clutter-cookbook-@CLUTTER_API_VERSION@.pdf \
[cookbook] Build the Cookbook as a devhelp document Instead of creating stand-alone HTML files, use XSLT to transform the DocBook into a DevHelp file, so that we can read the Cookbook inside DevHelp -- just like the API reference.
2009-09-02 17:11:06 +00:00
&& echo timestamp > $(@F)
Add the Clutter Cookbook to the build The "Clutter Cookbook" is a document designed to contain solutions to common problems applications developers might encounter when using Clutter. It is meant as a companion to the API reference but it requires knowledge of the Clutter API and framework.
2008-12-11 16:57:46 +00:00
[cookbook] Build the Cookbook as a devhelp document Instead of creating stand-alone HTML files, use XSLT to transform the DocBook into a DevHelp file, so that we can read the Cookbook inside DevHelp -- just like the API reference.
2009-09-02 17:11:06 +00:00
html-build.stamp: clutter-cookbook.xml
cookbook: Added support for inline video Amended Makefile to copy content of videos directory into installation directories. Also copies videos and images into the html/ directory during the build, so that the built cookbook can be viewed locally (for testing without having to install). Added an XSLT template to transform Docbook <inlinemediaobject> elements into HTML 5 <video> elements, with a fallback to link to the video displayed for browsers without HTML 5 support. Added note to "Contributing" appendix explaining how to put video into a recipe.
2010-07-15 12:27:02 +00:00
if [ ! -d html ] ; then mkdir html ; fi && \
if [ ! -d html/images ] ; then mkdir html/images ; fi && \
if [ ! -d html/videos ] ; then mkdir html/videos ; fi && \
cookbook: Add example code The cookbook should also include fully functional code examples. We can even XInclude them into the docbook XML itself. The examples should be built with the coobook, so that we can always make sure they are up to date.
2010-07-18 09:53:06 +00:00
if [ ! -d html/examples ] ; then mkdir html/examples ; fi && \
cookbook: Clean up build Create two HTML versions of the cookbook: • single page • multiple pages Use the online version of the DocBook XHTML XSL, and disable the PDF generation until we can restore it.
2010-07-01 11:17:01 +00:00
$(XSLTPROC) $(XSLTOPTS) -o clutter-cookbook.html $(XSL_XHTML_URI) $(top_builddir)/doc/cookbook/clutter-cookbook.xml && \
cookbook: Added support for inline video Amended Makefile to copy content of videos directory into installation directories. Also copies videos and images into the html/ directory during the build, so that the built cookbook can be viewed locally (for testing without having to install). Added an XSLT template to transform Docbook <inlinemediaobject> elements into HTML 5 <video> elements, with a fallback to link to the video displayed for browsers without HTML 5 support. Added note to "Contributing" appendix explaining how to put video into a recipe.
2010-07-15 12:27:02 +00:00
$(XSLTPROC) $(XSLTOPTS) -o html/ cookbook.xsl $(top_builddir)/doc/cookbook/clutter-cookbook.xml && \
cp $(top_srcdir)/doc/common/style.css html/ && \
if [[ "$(VIDEO_FILES)" != "" ]] ; then \
for file in `ls $(VIDEO_FILES)`; do \
cp $$file html/videos/ ; \
done \
fi && \
cp images/* html/images/ && \
cookbook: Add example code The cookbook should also include fully functional code examples. We can even XInclude them into the docbook XML itself. The examples should be built with the coobook, so that we can always make sure they are up to date.
2010-07-18 09:53:06 +00:00
cp examples/*.c html/examples/ && \
cookbook: Clean up build Create two HTML versions of the cookbook: • single page • multiple pages Use the online version of the DocBook XHTML XSL, and disable the PDF generation until we can restore it.
2010-07-01 11:17:01 +00:00
echo timestamp > $(@F)
Add the Clutter Cookbook to the build The "Clutter Cookbook" is a document designed to contain solutions to common problems applications developers might encounter when using Clutter. It is meant as a companion to the API reference but it requires knowledge of the Clutter API and framework.
2008-12-11 16:57:46 +00:00
docs: Clean up the additional documentation build • Make the manual a DevHelp book • Make the generation of PDFs of the cookbook and the manual optional • Consequently, make the hard dependency on jw optional • Clean up the checks and build for the additional documentation
2009-09-03 12:04:59 +00:00
if ENABLE_PDFS
cookbook: Clean up build Create two HTML versions of the cookbook: • single page • multiple pages Use the online version of the DocBook XHTML XSL, and disable the PDF generation until we can restore it.
2010-07-01 11:17:01 +00:00
#pdf_target = pdf-build.stamp
pdf_target =
docs: Clean up the additional documentation build • Make the manual a DevHelp book • Make the generation of PDFs of the cookbook and the manual optional • Consequently, make the hard dependency on jw optional • Clean up the checks and build for the additional documentation
2009-09-03 12:04:59 +00:00
else
pdf_target =
endif
if ENABLE_DOCS
all-local: html-build.stamp $(pdf_target)
Add the Clutter Cookbook to the build The "Clutter Cookbook" is a document designed to contain solutions to common problems applications developers might encounter when using Clutter. It is meant as a companion to the API reference but it requires knowledge of the Clutter API and framework.
2008-12-11 16:57:46 +00:00
else
all-local:
endif
clean-local:
docs: Clean up the additional documentation build • Make the manual a DevHelp book • Make the generation of PDFs of the cookbook and the manual optional • Consequently, make the hard dependency on jw optional • Clean up the checks and build for the additional documentation
2009-09-03 12:04:59 +00:00
@rm -rf html ; \
rm -f *.pdf ; \
[cookbook] Build the Cookbook as a devhelp document Instead of creating stand-alone HTML files, use XSLT to transform the DocBook into a DevHelp file, so that we can read the Cookbook inside DevHelp -- just like the API reference.
2009-09-02 17:11:06 +00:00
rm -f *.stamp
Add the Clutter Cookbook to the build The "Clutter Cookbook" is a document designed to contain solutions to common problems applications developers might encounter when using Clutter. It is meant as a companion to the API reference but it requires knowledge of the Clutter API and framework.
2008-12-11 16:57:46 +00:00
uninstall-local:
install-data-local:
build: Distcheck fixes
2010-06-30 10:55:52 +00:00
installfiles=`echo ./html/*`; \
if test "$$installfiles" = './html/*'; \
[cookbook] Build the Cookbook as a devhelp document Instead of creating stand-alone HTML files, use XSLT to transform the DocBook into a DevHelp file, so that we can read the Cookbook inside DevHelp -- just like the API reference.
2009-09-02 17:11:06 +00:00
then echo '-- Nothing to install' ; \
Add the Clutter Cookbook to the build The "Clutter Cookbook" is a document designed to contain solutions to common problems applications developers might encounter when using Clutter. It is meant as a companion to the API reference but it requires knowledge of the Clutter API and framework.
2008-12-11 16:57:46 +00:00
else \
[cookbook] Build the Cookbook as a devhelp document Instead of creating stand-alone HTML files, use XSLT to transform the DocBook into a DevHelp file, so that we can read the Cookbook inside DevHelp -- just like the API reference.
2009-09-02 17:11:06 +00:00
$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) ; \
cookbook: Fix build so CSS files get installed I had changed the build so CSS files get put into the HTML build directory; but done it in such a way that they were then being ignored during install. Fixed this.
2010-07-06 15:22:47 +00:00
for file in `ls $(HTML_FILES) $(CSS_FILES)`; do \
Add the Clutter Cookbook to the build The "Clutter Cookbook" is a document designed to contain solutions to common problems applications developers might encounter when using Clutter. It is meant as a companion to the API reference but it requires knowledge of the Clutter API and framework.
2008-12-11 16:57:46 +00:00
if [ -f $$file ]; then \
basefile=`echo $$file | sed -e 's,^.*/,,'`; \
[cookbook] Build the Cookbook as a devhelp document Instead of creating stand-alone HTML files, use XSLT to transform the DocBook into a DevHelp file, so that we can read the Cookbook inside DevHelp -- just like the API reference.
2009-09-02 17:11:06 +00:00
$(INSTALL_DATA) $$file $(DESTDIR)$(TARGET_DIR)/$$basefile; \
Add the Clutter Cookbook to the build The "Clutter Cookbook" is a document designed to contain solutions to common problems applications developers might encounter when using Clutter. It is meant as a companion to the API reference but it requires knowledge of the Clutter API and framework.
2008-12-11 16:57:46 +00:00
fi \
done; \
[cookbook] Build the Cookbook as a devhelp document Instead of creating stand-alone HTML files, use XSLT to transform the DocBook into a DevHelp file, so that we can read the Cookbook inside DevHelp -- just like the API reference.
2009-09-02 17:11:06 +00:00
fi; \
build: Distcheck fixes
2010-06-30 10:55:52 +00:00
if [ -d ./images ]; \
[cookbook] Build the Cookbook as a devhelp document Instead of creating stand-alone HTML files, use XSLT to transform the DocBook into a DevHelp file, so that we can read the Cookbook inside DevHelp -- just like the API reference.
2009-09-02 17:11:06 +00:00
then \
$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)/images ; \
build: Distcheck fixes
2010-06-30 10:55:52 +00:00
for file in `ls $(IMAGE_FILES)`; do \
[cookbook] Build the Cookbook as a devhelp document Instead of creating stand-alone HTML files, use XSLT to transform the DocBook into a DevHelp file, so that we can read the Cookbook inside DevHelp -- just like the API reference.
2009-09-02 17:11:06 +00:00
if [ -f $$file ]; \
then \
Add the Clutter Cookbook to the build The "Clutter Cookbook" is a document designed to contain solutions to common problems applications developers might encounter when using Clutter. It is meant as a companion to the API reference but it requires knowledge of the Clutter API and framework.
2008-12-11 16:57:46 +00:00
basefile=`echo $$file | sed -e 's,^.*/,,'`; \
[cookbook] Build the Cookbook as a devhelp document Instead of creating stand-alone HTML files, use XSLT to transform the DocBook into a DevHelp file, so that we can read the Cookbook inside DevHelp -- just like the API reference.
2009-09-02 17:11:06 +00:00
$(INSTALL_DATA) $$file $(DESTDIR)$(TARGET_DIR)/images/$$basefile; \
Add the Clutter Cookbook to the build The "Clutter Cookbook" is a document designed to contain solutions to common problems applications developers might encounter when using Clutter. It is meant as a companion to the API reference but it requires knowledge of the Clutter API and framework.
2008-12-11 16:57:46 +00:00
fi \
done; \
[cookbook] Build the Cookbook as a devhelp document Instead of creating stand-alone HTML files, use XSLT to transform the DocBook into a DevHelp file, so that we can read the Cookbook inside DevHelp -- just like the API reference.
2009-09-02 17:11:06 +00:00
fi; \
cookbook: Added support for inline video Amended Makefile to copy content of videos directory into installation directories. Also copies videos and images into the html/ directory during the build, so that the built cookbook can be viewed locally (for testing without having to install). Added an XSLT template to transform Docbook <inlinemediaobject> elements into HTML 5 <video> elements, with a fallback to link to the video displayed for browsers without HTML 5 support. Added note to "Contributing" appendix explaining how to put video into a recipe.
2010-07-15 12:27:02 +00:00
if [ -d ./videos ] && [[ "$(VIDEO_FILES)" != "" ]] ; \
then \
$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)/videos ; \
for file in `ls $(VIDEO_FILES)`; do \
if [ -f $$file ]; \
then \
basefile=`echo $$file | sed -e 's,^.*/,,'`; \
$(INSTALL_DATA) $$file $(DESTDIR)$(TARGET_DIR)/videos/$$basefile; \
fi \
done; \
fi; \
cookbook: Re-style Use a modified version of the Poky Handbook CSS for the HTML version of the Cookbook. Promote Elliot as author. Re-license from the GPLv2.0 to the CC BY-NC-SA 2.0.
2010-06-30 16:18:15 +00:00
$(INSTALL_DATA) html/clutter-cookbook.devhelp $(DESTDIR)$(TARGET_DIR)/clutter-cookbook.devhelp
Add the Clutter Cookbook to the build The "Clutter Cookbook" is a document designed to contain solutions to common problems applications developers might encounter when using Clutter. It is meant as a companion to the API reference but it requires knowledge of the Clutter API and framework.
2008-12-11 16:57:46 +00:00
.PHONY : doc
Reference in New Issue Copy Permalink