From: Mike Sheldon Date: Sat, 28 Mar 2009 20:06:45 +0000 (+0000) Subject: Initial check-in of tutorial files X-Git-Url: https://err.no/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e75f3866829af56999e785160346bb59cdefebc1;p=libchamplain Initial check-in of tutorial files --- diff --git a/docs/tutorial/en/champlain-tutorial.docbook b/docs/tutorial/en/champlain-tutorial.docbook new file mode 100644 index 0000000..56190c0 --- /dev/null +++ b/docs/tutorial/en/champlain-tutorial.docbook @@ -0,0 +1,236 @@ + + + + + +]> + + + + + Conquering The World With Python And Champlain + + + Michael + Sheldon + + + 2009-03-22 + + 0.10.1 + + + This is a step-by-step tutorial which will introduce champlain concepts and how to make use of them from within Python. It is released under the GNU Free Documentation License a copy of which can be found in Appendix A. + + + + + + Introduction + + This tutorial will try introduce most concepts within in champlain and explain how they can be used from within Python. The target audience for this tutorial is programmers with past Python and GTK experience, no experience of either champlain or clutter will be assumed. Chapter 2 will introduce a number of concepts from champlain individually. Chapter 3 will then provide a detailed account of the creation of a simple game from scratch using champlain. Chapter 4 will give an example of creating a plugin for an existing application to add mapping capabilities. + + + Examples + + Each chapter contains a number of examples, the source code for these can be downloaded from the Conquering The World With Python And Champlain website. + + + + + + Concepts + + This chapter introduces many of the fundamental concepts of champlain in very simple standalone programs. All of the examples will build upon basics outlined in the initialisation section, apart from this the examples can be read in any order and do not depend on one another. The techniques described here will later be used in a more complicated setting in chapter 3 and chapter 4, so it is advisable to acquaint yourself with most of them prior to moving on to the later chapters. + + + Initialisation + + This section will introduce the minimal steps required to get a champlain based application off the ground. The final result will be a window displaying tiles from the Open Street Map project, as pictured below. The user will be able to interact with this map by dragging the map to move around and double clicking to zoom in. + +
+ Initialisation Screenshot + + + +
+ + + Required Modules + + + Modules + +import gobject, clutter, champlain + + + + In addition to the champlain python module, the gobject and clutter modules are also required. The gobject module will only be used briefly as part of the initialisation stage, since champlain is a gobject based library gobject.threads_init() must be called before it can be used. The clutter module on the other hand plays a much more direct role in champlain programs and relevant clutter functions will be covered in detail throughout this tutorial. + + Clutter is a toolkit for creating visually impressive graphical user interfaces on top of OpenGL or OpenGL|ES making clutter based application suitable for use on both the desktop and in embedded environments. Further information about clutter can be found at the clutter website, this tutorial will only cover the aspects of clutter which are needed for common champlain usage, for a more in-depth look at clutter it is recommended that you read the official clutter documentation. + + + + Module Initialisation + + + Module Initialisation + +gobject.threads_init() +clutter.init() + + + + As mentioned in the previous section gobject.threads_init() must be called before making use of any champlain methods, in addition to this it is necessary to also run the clutter.init() function to initialise clutter. + + + + The Clutter Stage + + + Clutter Stage + +stage = clutter.stage_get_default() +stage.set_size(800, 600) + + + + This retrieves clutter's default stage, this can be thought of as the canvas upon which all drawing operations will take place. Using clutter in this manner will provide a standalone window containing just the stage. The size of the stage is then set to 800x600, which will result in the display window also being 800x600. At this point the window will not yet be visible to the user. + + + + Clutter Terms + Stage - The canvas upon which actors are drawn. + Actor - A visual element that can be displayed on the stage. This could be anything from a position marker to the champlain map itself. + + + + + + The Champlain View + + + Champlain View + +view = champlain.View() +view.set_size(800, 600) +stage.add(view) + + + + A champlain view is a type of clutter actor which displays the map itself, by default this will be tile images from the Open Street Map project retrieved on-demand over the internet. The map displayed in a view can be changed by assigning a new map source, as discussed later in the map sources section. The view size is then set to match the stage size of 800x600 and finally the view is added to the stage, ready to be displayed when the stage is made visible. + + + + Displaying The Stage + + + Displaying The Stage + +stage.show() +clutter.main() + + + + Finally we make the window visible by calling stage.show() and start the clutter main loop by calling clutter.main(). The clutter main loop handles all display updates, input and event dispatching. No code after the clutter.main() will execute until the main loop has stopped running. This is the equivalent of the gtk.main() function in GTK applications, as both clutter and GTK are gobject based it's not necessary to call clutter.main() in a GTK program, as the GTK main loop will handle everything. + + + + Full Listing + + Initialisation + +&examples-init; + + + + + + + Views + + + + + Properties + + + + + + Moving Around + + + + + + + Layers + + + + + + Markers + + + + + Label Markers + + + + + + Image Markers + + + + + + Custom Markers + + + + + + Animated Markers + + + + + + + Map Sources + + + + + Embedding Within GTK + + + + + Proxy Support + + + + + + Starting From Scratch + + This chapter will cover the creation of a simple game based around champlain's mapping and marker capabilities. + + + + Writing A Plugin + + In this chapter a plugin is written for an existing application to add mapping facilities. + + + + &license; + + diff --git a/docs/tutorial/en/fdl-license b/docs/tutorial/en/fdl-license new file mode 100644 index 0000000..fa8fdef --- /dev/null +++ b/docs/tutorial/en/fdl-license @@ -0,0 +1,356 @@ + GNU Free Documentation License + Version 1.1, March 2000 + + Copyright (C) 2000 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + +0. PREAMBLE + +The purpose of this License is to make a manual, textbook, or other +written document "free" in the sense of freedom: to assure everyone +the effective freedom to copy and redistribute it, with or without +modifying it, either commercially or noncommercially. Secondarily, +this License preserves for the author and publisher a way to get +credit for their work, while not being considered responsible for +modifications made by others. + +This License is a kind of "copyleft", which means that derivative +works of the document must themselves be free in the same sense. It +complements the GNU General Public License, which is a copyleft +license designed for free software. + +We have designed this License in order to use it for manuals for free +software, because free software needs free documentation: a free +program should come with manuals providing the same freedoms that the +software does. But this License is not limited to software manuals; +it can be used for any textual work, regardless of subject matter or +whether it is published as a printed book. We recommend this License +principally for works whose purpose is instruction or reference. + + +1. APPLICABILITY AND DEFINITIONS + +This License applies to any manual or other work that contains a +notice placed by the copyright holder saying it can be distributed +under the terms of this License. The "Document", below, refers to any +such manual or work. Any member of the public is a licensee, and is +addressed as "you". + +A "Modified Version" of the Document means any work containing the +Document or a portion of it, either copied verbatim, or with +modifications and/or translated into another language. + +A "Secondary Section" is a named appendix or a front-matter section of +the Document that deals exclusively with the relationship of the +publishers or authors of the Document to the Document's overall subject +(or to related matters) and contains nothing that could fall directly +within that overall subject. (For example, if the Document is in part a +textbook of mathematics, a Secondary Section may not explain any +mathematics.) The relationship could be a matter of historical +connection with the subject or with related matters, or of legal, +commercial, philosophical, ethical or political position regarding +them. + +The "Invariant Sections" are certain Secondary Sections whose titles +are designated, as being those of Invariant Sections, in the notice +that says that the Document is released under this License. + +The "Cover Texts" are certain short passages of text that are listed, +as Front-Cover Texts or Back-Cover Texts, in the notice that says that +the Document is released under this License. + +A "Transparent" copy of the Document means a machine-readable copy, +represented in a format whose specification is available to the +general public, whose contents can be viewed and edited directly and +straightforwardly with generic text editors or (for images composed of +pixels) generic paint programs or (for drawings) some widely available +drawing editor, and that is suitable for input to text formatters or +for automatic translation to a variety of formats suitable for input +to text formatters. A copy made in an otherwise Transparent file +format whose markup has been designed to thwart or discourage +subsequent modification by readers is not Transparent. A copy that is +not "Transparent" is called "Opaque". + +Examples of suitable formats for Transparent copies include plain +ASCII without markup, Texinfo input format, LaTeX input format, SGML +or XML using a publicly available DTD, and standard-conforming simple +HTML designed for human modification. Opaque formats include +PostScript, PDF, proprietary formats that can be read and edited only +by proprietary word processors, SGML or XML for which the DTD and/or +processing tools are not generally available, and the +machine-generated HTML produced by some word processors for output +purposes only. + +The "Title Page" means, for a printed book, the title page itself, +plus such following pages as are needed to hold, legibly, the material +this License requires to appear in the title page. For works in +formats which do not have any title page as such, "Title Page" means +the text near the most prominent appearance of the work's title, +preceding the beginning of the body of the text. + + +2. VERBATIM COPYING + +You may copy and distribute the Document in any medium, either +commercially or noncommercially, provided that this License, the +copyright notices, and the license notice saying this License applies +to the Document are reproduced in all copies, and that you add no other +conditions whatsoever to those of this License. You may not use +technical measures to obstruct or control the reading or further +copying of the copies you make or distribute. However, you may accept +compensation in exchange for copies. If you distribute a large enough +number of copies you must also follow the conditions in section 3. + +You may also lend copies, under the same conditions stated above, and +you may publicly display copies. + + +3. COPYING IN QUANTITY + +If you publish printed copies of the Document numbering more than 100, +and the Document's license notice requires Cover Texts, you must enclose +the copies in covers that carry, clearly and legibly, all these Cover +Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on +the back cover. Both covers must also clearly and legibly identify +you as the publisher of these copies. The front cover must present +the full title with all words of the title equally prominent and +visible. You may add other material on the covers in addition. +Copying with changes limited to the covers, as long as they preserve +the title of the Document and satisfy these conditions, can be treated +as verbatim copying in other respects. + +If the required texts for either cover are too voluminous to fit +legibly, you should put the first ones listed (as many as fit +reasonably) on the actual cover, and continue the rest onto adjacent +pages. + +If you publish or distribute Opaque copies of the Document numbering +more than 100, you must either include a machine-readable Transparent +copy along with each Opaque copy, or state in or with each Opaque copy +a publicly-accessible computer-network location containing a complete +Transparent copy of the Document, free of added material, which the +general network-using public has access to download anonymously at no +charge using public-standard network protocols. If you use the latter +option, you must take reasonably prudent steps, when you begin +distribution of Opaque copies in quantity, to ensure that this +Transparent copy will remain thus accessible at the stated location +until at least one year after the last time you distribute an Opaque +copy (directly or through your agents or retailers) of that edition to +the public. + +It is requested, but not required, that you contact the authors of the +Document well before redistributing any large number of copies, to give +them a chance to provide you with an updated version of the Document. + + +4. MODIFICATIONS + +You may copy and distribute a Modified Version of the Document under +the conditions of sections 2 and 3 above, provided that you release +the Modified Version under precisely this License, with the Modified +Version filling the role of the Document, thus licensing distribution +and modification of the Modified Version to whoever possesses a copy +of it. In addition, you must do these things in the Modified Version: + +A. Use in the Title Page (and on the covers, if any) a title distinct + from that of the Document, and from those of previous versions + (which should, if there were any, be listed in the History section + of the Document). You may use the same title as a previous version + if the original publisher of that version gives permission. +B. List on the Title Page, as authors, one or more persons or entities + responsible for authorship of the modifications in the Modified + Version, together with at least five of the principal authors of the + Document (all of its principal authors, if it has less than five). +C. State on the Title page the name of the publisher of the + Modified Version, as the publisher. +D. Preserve all the copyright notices of the Document. +E. Add an appropriate copyright notice for your modifications + adjacent to the other copyright notices. +F. Include, immediately after the copyright notices, a license notice + giving the public permission to use the Modified Version under the + terms of this License, in the form shown in the Addendum below. +G. Preserve in that license notice the full lists of Invariant Sections + and required Cover Texts given in the Document's license notice. +H. Include an unaltered copy of this License. +I. Preserve the section entitled "History", and its title, and add to + it an item stating at least the title, year, new authors, and + publisher of the Modified Version as given on the Title Page. If + there is no section entitled "History" in the Document, create one + stating the title, year, authors, and publisher of the Document as + given on its Title Page, then add an item describing the Modified + Version as stated in the previous sentence. +J. Preserve the network location, if any, given in the Document for + public access to a Transparent copy of the Document, and likewise + the network locations given in the Document for previous versions + it was based on. These may be placed in the "History" section. + You may omit a network location for a work that was published at + least four years before the Document itself, or if the original + publisher of the version it refers to gives permission. +K. In any section entitled "Acknowledgements" or "Dedications", + preserve the section's title, and preserve in the section all the + substance and tone of each of the contributor acknowledgements + and/or dedications given therein. +L. Preserve all the Invariant Sections of the Document, + unaltered in their text and in their titles. Section numbers + or the equivalent are not considered part of the section titles. +M. Delete any section entitled "Endorsements". Such a section + may not be included in the Modified Version. +N. Do not retitle any existing section as "Endorsements" + or to conflict in title with any Invariant Section. + +If the Modified Version includes new front-matter sections or +appendices that qualify as Secondary Sections and contain no material +copied from the Document, you may at your option designate some or all +of these sections as invariant. To do this, add their titles to the +list of Invariant Sections in the Modified Version's license notice. +These titles must be distinct from any other section titles. + +You may add a section entitled "Endorsements", provided it contains +nothing but endorsements of your Modified Version by various +parties--for example, statements of peer review or that the text has +been approved by an organization as the authoritative definition of a +standard. + +You may add a passage of up to five words as a Front-Cover Text, and a +passage of up to 25 words as a Back-Cover Text, to the end of the list +of Cover Texts in the Modified Version. Only one passage of +Front-Cover Text and one of Back-Cover Text may be added by (or +through arrangements made by) any one entity. If the Document already +includes a cover text for the same cover, previously added by you or +by arrangement made by the same entity you are acting on behalf of, +you may not add another; but you may replace the old one, on explicit +permission from the previous publisher that added the old one. + +The author(s) and publisher(s) of the Document do not by this License +give permission to use their names for publicity for or to assert or +imply endorsement of any Modified Version. + + +5. COMBINING DOCUMENTS + +You may combine the Document with other documents released under this +License, under the terms defined in section 4 above for modified +versions, provided that you include in the combination all of the +Invariant Sections of all of the original documents, unmodified, and +list them all as Invariant Sections of your combined work in its +license notice. + +The combined work need only contain one copy of this License, and +multiple identical Invariant Sections may be replaced with a single +copy. If there are multiple Invariant Sections with the same name but +different contents, make the title of each such section unique by +adding at the end of it, in parentheses, the name of the original +author or publisher of that section if known, or else a unique number. +Make the same adjustment to the section titles in the list of +Invariant Sections in the license notice of the combined work. + +In the combination, you must combine any sections entitled "History" +in the various original documents, forming one section entitled +"History"; likewise combine any sections entitled "Acknowledgements", +and any sections entitled "Dedications". You must delete all sections +entitled "Endorsements." + + +6. COLLECTIONS OF DOCUMENTS + +You may make a collection consisting of the Document and other documents +released under this License, and replace the individual copies of this +License in the various documents with a single copy that is included in +the collection, provided that you follow the rules of this License for +verbatim copying of each of the documents in all other respects. + +You may extract a single document from such a collection, and distribute +it individually under this License, provided you insert a copy of this +License into the extracted document, and follow this License in all +other respects regarding verbatim copying of that document. + + + +7. AGGREGATION WITH INDEPENDENT WORKS + +A compilation of the Document or its derivatives with other separate +and independent documents or works, in or on a volume of a storage or +distribution medium, does not as a whole count as a Modified Version +of the Document, provided no compilation copyright is claimed for the +compilation. Such a compilation is called an "aggregate", and this +License does not apply to the other self-contained works thus compiled +with the Document, on account of their being thus compiled, if they +are not themselves derivative works of the Document. + +If the Cover Text requirement of section 3 is applicable to these +copies of the Document, then if the Document is less than one quarter +of the entire aggregate, the Document's Cover Texts may be placed on +covers that surround only the Document within the aggregate. +Otherwise they must appear on covers around the whole aggregate. + + +8. TRANSLATION + +Translation is considered a kind of modification, so you may +distribute translations of the Document under the terms of section 4. +Replacing Invariant Sections with translations requires special +permission from their copyright holders, but you may include +translations of some or all Invariant Sections in addition to the +original versions of these Invariant Sections. You may include a +translation of this License provided that you also include the +original English version of this License. In case of a disagreement +between the translation and the original English version of this +License, the original English version will prevail. + + +9. TERMINATION + +You may not copy, modify, sublicense, or distribute the Document except +as expressly provided for under this License. Any other attempt to +copy, modify, sublicense or distribute the Document is void, and will +automatically terminate your rights under this License. However, +parties who have received copies, or rights, from you under this +License will not have their licenses terminated so long as such +parties remain in full compliance. + + +10. FUTURE REVISIONS OF THIS LICENSE + +The Free Software Foundation may publish new, revised versions +of the GNU Free Documentation License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. See +http:///www.gnu.org/copyleft/. + +Each version of the License is given a distinguishing version number. +If the Document specifies that a particular numbered version of this +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that specified version or +of any later version that has been published (not as a draft) by the +Free Software Foundation. If the Document does not specify a version +number of this License, you may choose any version ever published (not +as a draft) by the Free Software Foundation. + + +ADDENDUM: How to use this License for your documents + +To use this License in a document you have written, include a copy of +the License in the document and put the following copyright and +license notices just after the title page: + + Copyright (c) YEAR YOUR NAME. + Permission is granted to copy, distribute and/or modify this document + under the terms of the GNU Free Documentation License, Version 1.1 + or any later version published by the Free Software Foundation; + with the Invariant Sections being LIST THEIR TITLES, with the + Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. + A copy of the license is included in the section entitled "GNU + Free Documentation License". + +If you have no Invariant Sections, write "with no Invariant Sections" +instead of saying which ones are invariant. If you have no +Front-Cover Texts, write "no Front-Cover Texts" instead of +"Front-Cover Texts being LIST"; likewise for Back-Cover Texts. + +If your document contains nontrivial examples of program code, we +recommend releasing these examples in parallel under your choice of +free software license, such as the GNU General Public License, +to permit their use in free software. diff --git a/docs/tutorial/en/license.docbook b/docs/tutorial/en/license.docbook new file mode 100644 index 0000000..15cda9c --- /dev/null +++ b/docs/tutorial/en/license.docbook @@ -0,0 +1,19 @@ + +License + + +This document is released under Free Documentation license; the terms of this license +are detailed below. + + + +Free Documentation License + + + +&fdl-license; + + + + + diff --git a/docs/tutorial/en/style.dsl b/docs/tutorial/en/style.dsl new file mode 100644 index 0000000..20f2fee --- /dev/null +++ b/docs/tutorial/en/style.dsl @@ -0,0 +1,109 @@ + + + + + + ]]> + + + ]]> +]> + + + + + +;; =================================================================== +;; Generic Parameters +;; (Generic currently means: both print and html) + +(define %chapter-autolabel% #t) +(define %section-autolabel% #t) +(define (toc-depth nd) 3) + + + + + + +;; =================================================================== +;; Print Parameters +;; Call: jade -d champlain.dsl#print + +(define %paper-type% "A4") ;; use A4 paper +(define ($left-footer$ #!optional (gi (gi))) ;; show champlain logo + (make external-graphic + entity-system-id: "../../images/libchamplain.png" + notation-system-id: "PNG")) +(define %head-after-factor% 0.2) ;; not much whitespace after orderedlist head +(define ($paragraph$) ;; more whitespace after paragraph than before + (make paragraph + first-line-start-indent: (if (is-first-para) + %para-indent-firstpara% + %para-indent%) + space-before: (* %para-sep% 4) + space-after: (/ %para-sep% 4) + quadding: %default-quadding% + hyphenate?: %hyphenation% + language: (dsssl-language-code) + (process-children))) + + + + + + +;; =================================================================== +;; HTML Parameters +;; Call: jade -d champlain.dsl#html + +; === File names === +(define %root-filename% "index") ;; name for the root html file +(define %html-ext% ".html") ;; default extension for html output files +(define %html-prefix% "") ;; prefix for all filenames generated (except root) +(define %use-id-as-filename% #t) ;; uses ID value, if present, as filename + ;; otherwise a code is used to indicate level + ;; of chunk, and general element number + ;; (nth element in the document) +(define use-output-dir #f) ;; output in separate directory? +(define %output-dir% "HTML") ;; if output in directory, it's called HTML + +; === HTML settings === +(define %html-pubid% "-//W3C//DTD HTML 4.01 Transitional//EN") ;; Nearly true :-( +(define %html40% #t) + +; === Rendering === +(define %admon-graphics% #t) ;; use symbols for Caution|Important|Note|Tip|Warning +(define ($user-header-navigation$ #!optional + (prev (empty-node-list)) + (next (empty-node-list)) + (prevm (empty-node-list)) + (nextm (empty-node-list))) + (make sequence + (make element gi: "A" + attributes: (list (list "HREF" "http://projects.gnome.org/libchamplain/")) + (make empty-element gi: "IMG" + attributes: (list (list "SRC" "../../images/libchamplain.png") + (list "BORDER" "0") + (list "ALT" "libchamplain")))) +)) + +; === Books only === +(define %generate-book-titlepage% #t) +(define %generate-book-toc% #t) +(define ($generate-chapter-toc$) #f) ;; never generate a chapter TOC in books + +; === Articles only === +(define %generate-article-titlepage% #t) +(define %generate-article-toc% #t) ;; make TOC + + + + + + + diff --git a/docs/tutorial/examples/python/chapter2/01-initialisation.py b/docs/tutorial/examples/python/chapter2/01-initialisation.py new file mode 100755 index 0000000..c3bede7 --- /dev/null +++ b/docs/tutorial/examples/python/chapter2/01-initialisation.py @@ -0,0 +1,24 @@ +#!/usr/bin/env python + +import gobject, clutter, champlain + +#Initialise modules +gobject.threads_init() +clutter.init() + +#Get the clutter stage +stage = clutter.stage_get_default() +stage.set_size(800, 600) + +#Create a Champlain view +view = champlain.View() +view.set_size(800, 600) + +#Add the view to the stage +stage.add(view) + +#Make the stage visible +stage.show() + +#Begin the clutter main loop +clutter.main() diff --git a/docs/tutorial/images/chapter2/01-initialisation.png b/docs/tutorial/images/chapter2/01-initialisation.png new file mode 100644 index 0000000..3694d70 Binary files /dev/null and b/docs/tutorial/images/chapter2/01-initialisation.png differ diff --git a/docs/tutorial/images/libchamplain.png b/docs/tutorial/images/libchamplain.png new file mode 100644 index 0000000..82383ca Binary files /dev/null and b/docs/tutorial/images/libchamplain.png differ