diff options
Diffstat (limited to 'doc/kig')
30 files changed, 2495 insertions, 0 deletions
diff --git a/doc/kig/Makefile.am b/doc/kig/Makefile.am new file mode 100644 index 00000000..bafa3f6c --- /dev/null +++ b/doc/kig/Makefile.am @@ -0,0 +1,5 @@ + +KDE_LANG = en +KDE_DOCS = AUTO +KDE_MANS = AUTO + diff --git a/doc/kig/constructed_a_point.png b/doc/kig/constructed_a_point.png Binary files differnew file mode 100644 index 00000000..300957ad --- /dev/null +++ b/doc/kig/constructed_a_point.png diff --git a/doc/kig/constructed_script_object.png b/doc/kig/constructed_script_object.png Binary files differnew file mode 100644 index 00000000..5c8a1ddd --- /dev/null +++ b/doc/kig/constructed_script_object.png diff --git a/doc/kig/constructing_a_circle.png b/doc/kig/constructing_a_circle.png Binary files differnew file mode 100644 index 00000000..e3666db9 --- /dev/null +++ b/doc/kig/constructing_a_circle.png diff --git a/doc/kig/constructing_a_circle_2.png b/doc/kig/constructing_a_circle_2.png Binary files differnew file mode 100644 index 00000000..b66e9982 --- /dev/null +++ b/doc/kig/constructing_a_circle_2.png diff --git a/doc/kig/edit_types_dialog.png b/doc/kig/edit_types_dialog.png Binary files differnew file mode 100644 index 00000000..54f27194 --- /dev/null +++ b/doc/kig/edit_types_dialog.png diff --git a/doc/kig/index.docbook b/doc/kig/index.docbook new file mode 100644 index 00000000..ff3c3623 --- /dev/null +++ b/doc/kig/index.docbook @@ -0,0 +1,998 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY kseg "<application>KSeg</application>"> +<!ENTITY cabri "<application>Cabri</application>"> +<!ENTITY drgeo "<application>Dr.Geo</application>"> +<!ENTITY package "kdeedu"> +<!ENTITY kappname "&kig;"> +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE"> +<!-- change language only here --> +] +> + +<book lang="&language;"> + +<bookinfo> +<title>The &kig; Handbook</title> + +<authorgroup> +<author> +<firstname>Dominique</firstname> <surname>Devriese</surname> +<affiliation> +<address><email>devriese@kde.org</email></address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + + +<copyright> +<year>2002</year><year>2003</year><year>2004</year> <holder>Dominique +Devriese</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2005-08-20</date> <releaseinfo>0.10.5</releaseinfo> + +<abstract> +<para> +&kig; is a &kde; application for Interactive Geometry. +</para> +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KDE-Edu</keyword> +<keyword>Kig</keyword> +<keyword>Interactive Geometry</keyword> +<keyword>KGeo</keyword> +<keyword>Cabri</keyword> +<keyword>Dr.Geo</keyword> +<keyword>KSeg</keyword> +</keywordset> +</bookinfo> + + +<chapter id="introduction"> +<title>Introduction</title> + +<para> +&kig; is an application for Interactive Geometry. It's intended +to serve two purposes: +</para> + +<itemizedlist> +<listitem><para> Allow students to interactively explore +mathematical figures and concepts using the computer. +</para></listitem> + +<listitem><para> Serve as a <acronym>WYSIWYG</acronym> tool for +drawing mathematical figures and including them in other +documents.</para></listitem> +</itemizedlist> + +<para> +You can report problems in &kig; using the internal bug +reporting tool +(<menuchoice><guimenu>Help</guimenu><guimenuitem>Report +Bug...</guimenuitem></menuchoice>), or just contact me at +<email>toscano.pino@tiscali.it</email>. +</para> +<para> +Since &kig; supports macros and the construction of locuses, it allows for +some +rather advanced macros to be defined. If you have created an +interesting macro, which you think might be useful for other +people, please mail it to me at +<email>toscano.pino@tiscali.it</email>, so I can include it in the +distribution (if you do this, it will be licensed under the +terms of &kig;'s license, the <ulink +url="http://www.gnu.org/licenses/licenses.html#GPL">GPL</ulink>, +so that other people can freely use and adapt it). +</para> +</chapter> + + +<chapter id="using-kig-basic"> +<title>Basic usage</title> +<section id="constructing-objects"> +<title>Constructing Objects</title> +<section id="constructing-points"> +<title>Constructing points</title> +<para> +You can construct points in several ways:</para> +<itemizedlist> +<listitem> +<para> +Select <menuchoice><guimenu>Objects</guimenu> +<guisubmenu>Points</guisubmenu> +<guimenuitem>Point</guimenuitem></menuchoice> from the +menubar or +press the appropriate button in the toolbar. You can +then construct a point by clicking at the desired +position in the window.</para> <note><para>Actually, this +works the same way for constructing other objects as +well: click on the desired menubar entry or toolbar +button and select the necessary items to construct +the object.</para></note> +</listitem> +<listitem> +<para> +Since you often need to construct points, simply +clicking somewhere in the screen with the &MMB; will +construct a point for you, without going to a menu or +button. +</para> +</listitem> +<listitem> +<para> +You can construct points while you are building other +objects in the background, optionally selecting them +for the object you are building. For more on this, +see <xref linkend="constructing-other-objects" />. +</para> +</listitem> +</itemizedlist> + +<screenshot> +<screeninfo>A point has been constructed</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="constructed_a_point.png" +format="PNG"/> +</imageobject> +<textobject> +<phrase>A point has been constructed</phrase> +</textobject> +</mediaobject> +</screenshot> +</section> + +<section id="constructing-other-objects"> +<title>Constructing Other Objects</title> +<para> +Constructing objects other than points is usually done by +selecting the appropriate entry in the +<guimenu>Objects</guimenu> menu, or by clicking on one of +the toolbar buttons. +</para> +<screenshot> +<screeninfo>Constructing a circle</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="constructing_a_circle.png" +format="PNG"/> +</imageobject> +<textobject> +<phrase>Constructing a circle</phrase> +</textobject> +</mediaobject> +</screenshot> +<para> +This will start the construction of the chosen object type. +All of these types require arguments. For example, if you +selected to construct a circle by center and point, you will need to +give two points: one for the center, and one for the point on +the circle. +</para> +<para> +These arguments are objects too, which can also be selected, simply by +clicking on them. When you move the cursor over an argument you want to use to +construct an object, a preliminary image will be shown of the object, so you will +know what it will look like. For objects that require points as arguments, you +can place a new point at the +current cursor position and select it by clicking the &LMB;. +</para> +<para> +You can always cancel the construction of the new object by +pressing the &Esc; button or by clicking +on the <guiicon>Stop</guiicon> button (red octagon with an +<quote>X</quote>) on the toolbar. +</para> +<screenshot> +<screeninfo>Constructing a circle.</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="constructing_a_circle_2.png" +format="PNG"/> +</imageobject> +<textobject> +<phrase>Constructing a circle</phrase> +</textobject> +</mediaobject> +</screenshot> +</section> +</section> + +<section id="selecting-objects"> +<title>Selecting Objects</title> +<para> +Selecting objects can be done in two ways: +</para> +<itemizedlist> +<listitem> +<para> +Simply clicking on an object causes that object to be selected, clearing the +current selection. If you +want to select multiple objects simultaneously, hold down the &Ctrl; key while +clicking on an object. +</para> +</listitem> +<listitem> +<para> +By clicking and dragging on an empty spot on the screen, +you can select all objects within the rectangle that is +created. This action will clear the current selection. As +in the previous case, holding down the &Ctrl; key allows you +to keep the current selection. +</para> +</listitem> +</itemizedlist> +<para> +When you have more than one object under the mouse, you can easily +choose which object select or add to the current selection. Click +with the &LMB;, while holding the &Shift; key, to have a popup with +all the objects under the mouse. Then, you can select the object +you need. As said before, the behaviour of the &Ctrl; key will +affect the selection. +</para> + +<screenshot> +<screeninfo>Selecting objects</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="selecting_objects.png" format="PNG"/> +</imageobject> +<textobject> +<phrase>Selecting objects</phrase> +</textobject> +</mediaobject> +</screenshot> +</section> + +<section id="moving-objects"> +<title>Moving Objects</title> +<para> +To move objects, you must first <link +linkend="selecting-objects">select</link> them. +</para> +<para> +When the objects you want to move are selected, you can start +moving them by &LMB; clicking and dragging any one of them. When you are done, +simply release the &LMB;. +</para> +<note><para>For some types of objects (especially when defined by +complicated locuses), moving them can be slow on old hardware. This +is unfortunate, but inevitable, given the calculations involved. +</para></note> <note><para>If you &RMB; click one of the selected objects, and +choose +<guimenuitem>Move</guimenuitem>, moving the mouse will move the object. When the +object is moved to the desired position, another &LMB; click will stop the +moving of the object.</para></note> +</section> +<section id="deleting-objects"> +<title>Deleting objects</title> +<para> +Deleting objects is done by first <link +linkend="selecting-objects">selecting</link> them, and next doing either of +these: +<itemizedlist> +<listitem> +<para> +Press the <keycap>Delete</keycap> key. +</para> +</listitem> +<listitem> +<para> +Press the <guiicon>delete</guiicon> button on the toolbar. +</para> +</listitem> +<listitem> +<para> +<mousebutton>Right</mousebutton>-click on one of the +objects, and select +<guimenuitem>Delete</guimenuitem> +in the <link linkend="objects-context-menus">context +menu</link> that appears. +</para> +</listitem> +</itemizedlist> +</para> +</section> + +<section id="showing-hiding-objects"> +<title>Showing and hiding objects</title> +<para> +In &kig;, objects can be hidden. This is done by selecting +the objects, &RMB; clicking one of +them, and selecting +<guimenuitem>Hide</guimenuitem> in +the <link linkend="objects-context-menus">context menu</link> +that appears. +</para> +<para> +To unhide the objects, use the +<menuchoice><guimenu>Edit</guimenu><guimenuitem>Unhide +all</guimenuitem></menuchoice>. This will unhide all +currently hidden objects. +</para> + +<section id="night-vision"> +<title>Night Vision</title> +<para> +Night Vision is a particular way of working with hidden +objects. When you have to move or change something in one or +more object but without unhiding all the hidden objects you +have, then the night vision mode will be of benefit to you. +</para> +<para> +Basically, it allows you to see the hidden objects as if they +were visible, so that you can manipulate them as you would normally. +In Night Vision mode, the hidden objects will be visible with +a grey colour. +</para> +<para> +To toggle the night vision mode, use +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Wear +Infrared Glasses</guimenuitem></menuchoice>. +</para> +</section> +</section> + +<section id="undo-redo"> +<title>Undo/Redo</title> +<para> +In &kig;, you can undo almost any change you make in the +document. Just use the +<guiicon>undo</guiicon>/<guiicon>redo</guiicon> buttons on the +toolbar, or the appropriate shortcuts. +</para> +</section> + +<section id="full-screen-mode"> +<title>Full Screen Mode</title> +<para> +&kig; also has a Full Screen mode. To use it, click the +appropriate button on the toolbar, or select +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Full +Screen Mode</guimenuitem></menuchoice>. +</para> +<para> +To leave Full Screen mode, +&RMB; click the screen at a place +where there is no object present, and select +<guimenuitem>Exit Full Screen Mode</guimenuitem>, or press the +&Esc; key. +</para> +</section> +</chapter> + + +<chapter id="kig-object-types"> +<title>&kig; Object Types</title> +<para> +&kig; supports a rather large number of object types. Please +note that not all of the available object types are shown in the +toolbars: there are some objects that you can only +construct via the <guimenu>Objects</guimenu> menu in the menu +bar. Of course, as with all &kde; applications, the contents of the toolbars are +configurable. Try out the +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +Toolbars...</guimenuitem></menuchoice> option if you want to do this. +</para> +</chapter> + + +<chapter id="using-advanced"> +<title>Advanced Usage</title> +<section id="objects-context-menus"> +<title>Context Menus</title> +<para> +&kig; has context menus for its objects. Try +&RMB; clicking on an object in order to see +a context menu appear. There are many options: for +constructing other objects, setting colours, and even hiding, +moving or deleting objects. Some objects have options of +their own (⪚ you can redefine certain points to be +constrained to a line if they previously weren't, &etc;). +These options should be very straightforward to understand. +</para> +</section> + +<section id="document-context-menus"> +<title>Document context menus</title> +<para> +<mousebutton>Right</mousebutton>-clicking on the document (&ie; not on an +object) will +present a popup that you can use to start constructing a new object, change the +coordinate system used, show hidden +objects, and even zoom in and zoom out of the document. +</para> +</section> + +<section id="defining-macros"> +<title>Defining Macros</title> +<para> +One of the more advanced features in &kig; is its support for +macros. This allows you to define new types of objects from +other ones which are defined already. +</para> +<para> +For example: Suppose you want to make a macro for constructing +a circle from three points on it. You would input three points, +then construct some perpendiculars and midpoints +until you find the center. Now you can use the existing +<quote>Construct a circle by center and point</quote> command +(using one of the three points as the point for this command). The +following image should make this a bit more clear: +</para> +<screenshot> +<screeninfo>Test running macros</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="test_run_macro.png" format="PNG"/> +</imageobject> +<textobject> +<phrase>Test running macros</phrase> +</textobject> +</mediaobject> +</screenshot> + +<para> +Next comes defining the macro. Select <guimenuitem>New +macro</guimenuitem> from the <guimenu>Type</guimenu> menu, or +click on the button on the toolbar. A wizard will appear and +ask you to select the given objects. In our example, these +are the three points. Select the three points (click on them +to select, click again to unselect) and click the +<guibutton>Next</guibutton> button to continue. Finally, +select the last objects (only the circle in our example). +</para> + +<screenshot> +<screeninfo>The macro wizard</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="macro_wizard.png" format="PNG"/> +</imageobject> +<textobject> +<phrase>The macro wizard</phrase> +</textobject> +</mediaobject> +</screenshot> + +<para> After the previous steps are completed, click the +<guibutton>Next</guibutton> button to continue. Enter a name +and optionally a description for your new type, and click the +<guibutton>Finish</guibutton> button. Your macro type is now +finished. +</para> + +<para> +To use the new macro type, click its button on the toolbar or +use the <guimenu>Objects</guimenu> menu. Constructing a macro +object is just like constructing any other object. +</para> +<screenshot> +<screeninfo>Using your new type</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="macros_at_work.png" format="PNG"/> +</imageobject> +<textobject> +<phrase>Using your new type</phrase> +</textobject> +</mediaobject> +</screenshot> +</section> + +<section id="working-with-types"> +<title>Working with types</title> +<para> +As you saw in the previous chapter, &kig; allows you to create +your own objects. &kig; also makes sure that once you have +created an object, it is saved on exit and loaded on startup. +You do not have to manually save or load macro definitions. +However, &kig; does allow you to do more with the macros. If +you select <menuchoice><guimenu>Types</guimenu><guimenuitem>Manage +Types...</guimenuitem></menuchoice> from the menu, you will see +a dialog where you can edit your types. It allows you to modify +the existant types, delete types that are no longer used, export +them to a file, or even load them from another file. +</para> +<screenshot> +<screeninfo>Edit Types Dialog</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="edit_types_dialog.png" format="PNG"/> +</imageobject> +<textobject> +<phrase>The Edit Types Dialog</phrase> +</textobject> +</mediaobject> +</screenshot> +</section> + +<section id="text-labels"> +<title>Text labels</title> +<para> +&kig; allows you to add text labels to a construction. This +is very useful for adding names, explanations or other text +to constructions. &kig; can also display variable information +about objects (also known as <quote>properties</quote>). +</para> +<para> +To start constructing a text label, simply press the +<guibutton>Text Label</guibutton> button in the &kig; toolbar or +select <menuchoice><guimenu>Objects</guimenu><guisubmenu>Other +</guisubmenu><guimenuitem>Text label</guimenuitem> +</menuchoice> in the menubar. +</para> +<para> +Next, you have to choose a location for the text label. You +can either just select a random location on the screen, or +choose to <quote>attach</quote> the label to an object. +</para> +<screenshot> +<screeninfo>Attaching a label to a circle...</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="text_label_attaching.png" format="PNG"/> +</imageobject> +<textobject> +<phrase>Attaching a label to a circle...</phrase> +</textobject> +</mediaobject> +</screenshot> +<para> +After you have selected where to put the label, the text label dialog appears. +Here, you can type in +the text that you want in the new label, and click +<guibutton>Finish</guibutton>. You should now see the label in your document. +</para> +<screenshot> +<screeninfo>The Text Label Dialog</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="text_label_wizard.png" format="PNG"/> +</imageobject> +<textobject> +<phrase>The Text Label Dialog</phrase> +</textobject> +</mediaobject> +</screenshot> +<para> +The previous example was a simple one, and limited to just +text. However, there is also support for showing variable +information about objects in a label (⪚ you can construct a +label with the text <quote>This segment is %1 units +long.</quote> where <token>%1</token> would be dynamically +replaced with the length of a specific segment). +</para> +<para> +To do this, enter a text with a number of placeholders ( +<token>%1</token>, <token>%2</token> &etc;) in it. +Then, press the <guibutton>Next</guibutton> button to +continue. If you want to change the text or variables later, +you can go back using the <guibutton>Back</guibutton> button. +</para> +<para> +The wizard now shows the text you entered with all +placeholders replaced by something like <guilabel>argument +1</guilabel>. Selecting the property connected to a certain argument is +done by first clicking on the argument in question. Then click +on the object that you need and that has this property, and +then select the property itself in the popup +menu that appears. For instance, in the example above, you +would click <guilabel>argument 1</guilabel>, click on the +correct segment in the main &kig; window, and select the +property <guilabel>Length</guilabel>. Afterwards, you can +fill in the rest of the variable parts, or select another +property for one of the variable parts if you wish to change +it. When you are ready, click the +<guibutton>Finish</guibutton> button to complete the +construction of the text label. +</para> +<screenshot> +<screeninfo>Selecting a property for a variable +part</screeninfo> +<mediaobject> +<imageobject> +<imagedata +fileref="text_label_wizard__select_property.png" +format="PNG"/> +</imageobject> +<textobject> +<phrase>Selecting a property for a variable part</phrase> +</textobject> +</mediaobject> +</screenshot> +</section> + +<section id="locuses"> +<title>Locuses</title> +<para> +&kig; supports the use of locuses. A locus is mathematically defined as +the set of all points or lines that satisfy or are determined by specific +conditions; as in <quote>the locus of points +equidistant from a given point is a circle</quote>. +Let's look at an example of how to use locuses in &kig;: +</para> +<para> +Consider the following geometrical construction: We draw a +circle, and a point that can move only along its circumference +(construct this point by positioning the cursor on a circle, and clicking +the &MMB;. If you then try to move the resulting point, +you'll see that you cannot move it off the circle). Then, we +draw a segment from that point to the center of the circle, +and the midpoint of that segment. +</para> +<screenshot> +<screeninfo>A simple construction using a locus</screeninfo> +<mediaobject> +<imageobject> +<imagedata +fileref="simple_locus_construction.png" +format="PNG"/> +</imageobject> +<textobject> +<phrase>A simple construction using a locus</phrase> +</textobject> +</mediaobject> +</screenshot> +<para> +Now if you move the point that is constrained to the circle, +you'll see that the second point moves along with it. If you +were to hold a pen at the second point, and move the +first point around the entire circle, a new circle, half the +size of the other would be drawn. The path that the second point +travels while the first one moves around the circle is its locus. +</para> +<para> +Actually constructing the locus of a point is very easy. Click +the <guiicon>locus</guiicon> button in the toolbar, or select +<menuchoice><guimenu>Objects</guimenu> +<guisubmenu>Other</guisubmenu> +<guimenuitem>Locus</guimenuitem> +</menuchoice> +from the menubar. Then select the constrained point as the +moving point (the text <guilabel>Moving Point</guilabel> will +appear as you move the mouse over it), and the other as the +dependent point. The locus of the dependent point will then be drawn. +</para> +</section> +</chapter> + +<chapter id="scripting"> +<title>Scripting</title> +<para> +&kig; allows you to create custom types in the Python +scripting language. This is a very advanced feature, and I know +of only one other Interactive Geometry program that has a similar +functionality (the <acronym>GNOME</acronym> program &drgeo;). +</para> +<para> +Python Scripting in &kig; basically allows you to create your +own objects from certain parent objects. For example, if you are a math +teacher, and you have some fancy way +of calculating an interesting point on a conic, then instead of +messing with complex constructions and macros, you could just +write down in Python code how the point is to be calculated and +then &kig; will show it for you. +</para> +<para> +Suppose you were not aware of the &kig; built-in type <quote>Mid Point</quote>, +and you wanted to show the midpoint of two given points. You +would then click on the <guibutton>Python Script</guibutton> +button in the toolbar, or select +<menuchoice><guimenu>Objects</guimenu><guisubmenu>Other</guisubmenu> +<guimenuitem>Python Script</guimenuitem></menuchoice> from the +menubar. You are then presented with a wizard that allows you +to proceed. +</para> +<screenshot> +<screeninfo>The Script Object Wizard</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="script_wizard.png" format="PNG"/> +</imageobject> +<textobject> +<phrase>The Script Object Wizard</phrase> +</textobject> +</mediaobject> +</screenshot> +<para> +The first thing you have to do is select the arguments for the +script object. In our example, this means the two points of +which we want to show the midpoint. Select them in the &kig; +main window, and click <guibutton>Next</guibutton> to proceed. +</para> +<para> +Now you are presented with a text edit box where you can enter +the code for you script object. Template code and some comments +are already in place. It is important to make sure that your +code is valid Python code. People familiar with Python will +notice that we are actually defining a Python function called +<function>calc</function>. It is therefore necessary to adhere +to the Python rules for defining functions. For example, every +line of the function should start with a <keysym>Tab</keysym>. +The first line not starting with a <keysym>tab</keysym> ends the +definition of the function. +</para> +<para> +The Python function that we want to define is called +<function>calc</function>, and in our case it accepts two arguments. +These are the objects you have selected as arguments in the +previous screen. You need as many arguments as you have +selected there. They are called <parameter>arg1</parameter> and +<parameter>arg2</parameter>, but you can change their names to +something more meaningful if you want. +</para> +<para> +In the function, you can do all sorts of calculations that you +deem necessary, using the two arguments if needed. You should +return the object you want to define. In our case, this is a +<classname>Point</classname> object. The two arguments are also +<classname>Point</classname> objects, and we +can use the <function>Point.coordinate()</function> function to +define the coordinates of the two given points. +</para> +<para> +The calculation necessary in our example is very simple, we +simply add the two sets of coordinates, and divide the new set +by two. We then construct a new point using the result. +The Python code needed is:</para> + +<programlisting> +def calc( a, b ): +m = ( a.coordinate() + b.coordinate() ) / 2; +return Point( m ) +</programlisting> + +<screenshot> +<screeninfo>Entering the code</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="script_wizard_entering_code.png" format="PNG"/> +</imageobject> +<textobject> +<phrase>Entering the code for the midpoint in the Script Object +wizard.</phrase> +</textobject> +</mediaobject> +</screenshot> +<para> +If you now click the <guibutton>Finish</guibutton> button, +the new object will appear in the &kig; document. If you move +one of the points, the newly created point will move along +with it. Much more powerful objects can be built in this way: +you are encouraged to try it out. +</para> +<screenshot> +<screeninfo>Constructed a Script Object</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="constructed_script_object.png" format="PNG" /> +</imageobject> +<textobject> +<phrase> +The newly constructed Script Object. +</phrase> +</textobject> +</mediaobject> +</screenshot> +<para> +All objects in &kig; can be used in the Python code. As we have +seen above, points are of the <classname>Point</classname> class, and you +can use ⪚ the <function>Point.coordinate()</function> method. You can +also return all kinds of objects, not just a <classname>Point</classname>. +Many more classes and methods are available in the &kig; Python code, +and a more complete reference is provided <ulink +url="http://edu.kde.org/kig/manual/scripting-api/index.html">on +the &kig; website</ulink>. +</para> +</chapter> + +<chapter id="kig-features"> +<title>&kig; Features</title> + +<itemizedlist> +<listitem> +<para> +&kig; is an open source application. This means that you +are free to use and modify it any way you like it. +Distributing &kig; is subject to some restrictions, +basically that everyone should have the same rights to use +&kig;, including your modifications, as you and me. +</para> +<para> +Free software programs are developed in a very open +spirit, and its developers are usually very responsive to +user feedback. Therefore, if you have any questions, +complaints, or whatever about &kig;, please let the author +know at <email>toscano.pino@tiscali.it</email>. +</para> +</listitem> +<listitem> +<para> +&kig; is a KPart application, which means that you can +embed it into other &kde; software. If you open a <literal +role="extension">.kig</literal> file in &konqueror;, it +can be opened directly in the &konqueror; screen without +the need to start an external application. +</para> +</listitem> +<listitem> +<para> +Working with &kig; should be very straightforward. +Constructing objects is easy and interactive, with +preliminary results being shown, &etc;. Moving, selecting +and building all work as one would expect them to. Undo +support should also be very intuitive. +</para> +</listitem> +<listitem> +<para> +&kig; supports macros to be defined in a straightforward +manner. These objects are presented to the user like +normal objects. They are saved on exit and loaded on +startup, so that they aren't lost on exit. You can +manage these objects in the <guilabel>Manage Types</guilabel> +dialog (see <xref linkend="working-with-types" />). You can export +them +to files, import them from files, edit and delete them. +</para> +</listitem> +<listitem> +<para> +&kig; saves its data in a clear &XML; format. +</para> +</listitem> +<listitem> +<para> +&kig; supports the construction of locuses. +</para> +</listitem> +<listitem> +<para> +&kig; allows you to export a &kig; file to some interesting +formats, like images, <application>XFig</application> and +<application>LaTeX</application> files, and <acronym>SVG</acronym> +vectorial images. This is rather useful, because not all programs +support the &kig; file format yet. +</para> +</listitem> +<listitem> +<para> +&kig; has a very flexible transformation system. +</para> +</listitem> +<listitem> +<para> +&kig; aims to be compatible with its competitors. This is +why it supports the &kgeo; file format, the &kseg; file +format and partially the &drgeo; and &cabri; formats; morover, +support for other formats is planned. +</para> +</listitem> +</itemizedlist> +</chapter> + + +<chapter id="faq"> +<title>Questions and Answers</title> + +&reporting.bugs; &updating.documentation; +</chapter> + + +<chapter id="credits"> +<title>Credits and License</title> + +<para> +&kig; +</para> +<para> +&kig; copyright 2002-2004 Dominique Devriese +<email>devriese@kde.org</email> +</para> + +<para> +Documentation copyright 2002-2004 Dominique +Devriese <email>devriese@kde.org</email>. +</para> + +<para> +Documentation copyright 2004-2005 Pino Toscano +<email>toscano.pino@tiscali.it</email>. +</para> + +<para> +Reviewed by &Philip.Rodrigues; &Philip.Rodrigues.mail;. +</para> +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> +&underFDL; &underGPL; +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="getting-kig"> +<title>How to obtain &kig;</title> + +&install.intro.documentation; + +</sect1> + +<sect1 id="compilation"> +<title>Compilation and Installation</title> +&install.compile.documentation; +</sect1> + +</appendix> + +<appendix id="contributing"> +<title>Contribute</title> +<section id="kig-is-free"> +<title>Free Software</title> +<para> +&kig; is <ulink +url="http://www.gnu.org/philosophy/philosophy.html#AboutFreeSoftware"> +Free Software</ulink>. This means that its source code is +freely available on the Internet, and everyone can use it, +read it, modify it, and distribute it. I work on it as a +hobby project, and I have already learned a lot about +programming, C++, &kde;/&Qt;, math, software collaboration and open +source projects in the process. +</para> +</section> + +<section id="contribute-to-kig"> +<title>Contribute</title> +<para> +In this chapter I want to point out to you (the user) the +rights that &kig;'s license gives you. As with all free +software, you are allowed (and encouraged) to fix problems +you encounter while using it, to add features you miss, to +distribute your modified program, and to send these +modifications to me at <email>toscano.pino@tiscali.it</email>, so +that I can include them in the next version for others to +enjoy. Please note I personally have no financial interest in this +project whatsoever. +</para> +<para> +If you are uncertain of your rights to use this software, or +other people's right to use any modifications you make to this +program &etc;, please read the license. You can find it in the +<filename>COPYING</filename> file in the &kig; source tree or +the <guilabel>license</guilabel> tab in the <guilabel>About +Kig</guilabel> dialog. +</para> +</section> + +<section id="howto-contribute"> +<title>How to contribute ?</title> +<para> +Any contributions are welcome. If you don't like the icons, +or think that the manual needs updating, or if you have this really +cool macro that you want to share with the world, do not +hesitate to send it to me. Please note that your +contributions will be distributed under the terms of the &GNU; +<acronym>GPL</acronym>; you can find the terms of this license in the +<filename>COPYING</filename> file in the &kig; source tree, +and in the <link linkend="credits">Credits and +Licenses</link> chapter in this manual. +</para> +</section> +</appendix> + +&documentation.index; +</book> +<!-- +Local Variables: +mode: xml +End: +-->
\ No newline at end of file diff --git a/doc/kig/macro_wizard.png b/doc/kig/macro_wizard.png Binary files differnew file mode 100644 index 00000000..5b84a1b9 --- /dev/null +++ b/doc/kig/macro_wizard.png diff --git a/doc/kig/macros_at_work.png b/doc/kig/macros_at_work.png Binary files differnew file mode 100644 index 00000000..0f4b9807 --- /dev/null +++ b/doc/kig/macros_at_work.png diff --git a/doc/kig/man-kig.1.docbook b/doc/kig/man-kig.1.docbook new file mode 100644 index 00000000..0f1d4b1c --- /dev/null +++ b/doc/kig/man-kig.1.docbook @@ -0,0 +1,109 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!ENTITY % English "INCLUDE"> +]> + +<refentry lang="&language;"> +<refentryinfo> +<title>KDE User's Manual</title> +<author><personname> +<firstname>Ben</firstname> +<surname>Burton</surname> +</personname><email>bab@debian.org</email></author> +<date>May 25, 2005</date> +<productname>K Desktop Environment</productname> +</refentryinfo> + +<refmeta> +<refentrytitle><command>kig</command></refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname><command>kig</command></refname> +<refpurpose>an interactive geometry program for &kde;</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>kig</command> +<group choice="opt"><option>-c, --convert-to-native</option> +<group choice="opt"><option>-o, --outfile <replaceable>filename</replaceable></option> +</group> +</group> +<arg choice="opt">KDE Generic Options</arg> +<arg choice="opt">Qt Generic Options</arg> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1> +<title>Description</title> +<para>&kig; is an application for interactive geometry. It is intended to +serve two purposes:</para> +<itemizedlist><listitem><para>To allow students to interactively explore +mathematical figures and concepts using the computer;</para></listitem> +<listitem><para>To serve as a WYSIWYG tool for drawing mathematical figures and +including them in other documents.</para></listitem></itemizedlist> +<para>With this program you can do geometry on a computer just like you +would on a blackboard in a classroom. However the program allows you to +move and change parts of a geometrical drawing so that you can see how other +parts change as a result.</para> +<para>&kig; supports loci and user-defined macros. It also imports and +exports both to and from foreign file formats including +<application>Cabri</application>, <application>Dr. Geo</application>, +&kgeo;, <application>KSeg</application> and <application>XFig</application>.</para> +<para>This application is part of the official &kde; edutainment module.</para> +</refsect1> + +<refsect1> +<title>Options</title> +<para>App options, in a variablelist</para> + +<variablelist> +<varlistentry> +<term><option>-c, --convert-to-native</option></term> +<listitem><para>Do not show a &GUI;. Instead convert the specified file to +native &kig; format. The native &kig; file will be written to standard +output unless <option>--outfile</option> is passed.</para></listitem> +</varlistentry> +<varlistentry> +<term><option>-o, --outfile <replaceable>filename</replaceable></option></term> +<listitem><para>Used with <option>--convert-to-native</option> to specify +where to save the newly created &kig; file. Not specifying this option, or +providing a filename of <filename>-</filename> will output the file to +standard output.</para> +</listitem> +</varlistentry> +</variablelist> + +</refsect1> + +<refsect1> +<title>See Also</title> +<para>More detailed user documentation is available from <ulink +url="help:/kig">help:/kig</ulink> +(either enter this <acronym>URL</acronym> into &konqueror;, or run +<userinput><command>khelpcenter</command> +<parameter>help:/kig</parameter></userinput>).</para> + +<para>There is also further information available at the <ulink +url="http://edu.kde.org/kig/">&kde; Edutainment website</ulink>.</para> +</refsect1> + +<refsect1> +<title>Authors</title> +<para>&kig; was written by +<personname><firstname>Dominique</firstname><surname>Devriese</surname></personname> +<email>devriese@kde.org</email>, +<personname><firstname>Maurizio</firstname><surname>Paolini</surname></personname> +<email>paolini@dmf.bs.unicatt.it</email>, +<personname><firstname>Franco</firstname><surname>Pasquarelli</surname></personname> +<email>pasqui@dmf.bs.unicatt.it</email>, +<personname><firstname>Pino</firstname><surname>Toscano</surname></personname> +<email>toscano.pino@tiscali.it</email>, and others.</para> +<para>This man page based on the one prepared for Debian by +<personname><firstname>Ben</firstname><surname>Burton</surname></personname> +<email>bab@debian.org</email>.</para> +</refsect1> + +</refentry> diff --git a/doc/kig/script_wizard.png b/doc/kig/script_wizard.png Binary files differnew file mode 100644 index 00000000..cbf9a3a8 --- /dev/null +++ b/doc/kig/script_wizard.png diff --git a/doc/kig/script_wizard_entering_code.png b/doc/kig/script_wizard_entering_code.png Binary files differnew file mode 100644 index 00000000..ce4ea4a1 --- /dev/null +++ b/doc/kig/script_wizard_entering_code.png diff --git a/doc/kig/scripting-api/Doxyfile.scripting-api.in b/doc/kig/scripting-api/Doxyfile.scripting-api.in new file mode 100644 index 00000000..ab665dae --- /dev/null +++ b/doc/kig/scripting-api/Doxyfile.scripting-api.in @@ -0,0 +1,1156 @@ +# Doxyfile 1.3.7 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a hash (#) is considered a comment and will be ignored +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" ") + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = "Kig Python Scripting API" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = @KIGVERSION@ + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = ./build + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 2 levels of 10 sub-directories under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of source +# files, where putting all generated files in the same directory would otherwise +# cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, +# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en +# (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese, +# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. + +OUTPUT_LANGUAGE = English + +# This tag can be used to specify the encoding used in the generated output. +# The encoding is not always determined by the language that is chosen, +# but also whether or not the output is meant for Windows or non-Windows users. +# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES +# forces the Windows encoding (this is the default for the Windows binary), +# whereas setting the tag to NO uses a Unix-style encoding (the default for +# all platforms other than Windows). + +USE_WINDOWS_ENCODING = NO + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is used +# as the annotated text. Otherwise, the brief description is used as-is. If left +# blank, the following values are used ("$name" is automatically replaced with the +# name of the entity): "The $name class" "The $name widget" "The $name file" +# "is" "provides" "specifies" "contains" "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited +# members of a class in the documentation of that class as if those members were +# ordinary class members. Constructors, destructors and assignment operators of +# the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = NO + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like the Qt-style comments (thus requiring an +# explicit @brief command for a brief description. + +JAVADOC_AUTOBRIEF = YES + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the DETAILS_AT_TOP tag is set to YES then Doxygen +# will output the detailed description near the top, like JavaDoc. +# If set to NO, the detailed description appears after the member +# documentation. + +DETAILS_AT_TOP = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 2 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources +# only. Doxygen will then generate output that is more tailored for Java. +# For instance, namespaces will be presented as packages, qualified scopes +# will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = YES + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = YES + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# users are advised to set this option to NO. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = NO + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = NO + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = creating-python-scripting-doc + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = NO + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = @top_srcdir@/kig/misc/coordinate.h \ + @top_srcdir@/kig/misc/common.h \ + @top_srcdir@/kig/misc/conic-common.h \ + @top_srcdir@/kig/misc/cubic-common.h \ + @top_srcdir@/kig/misc/kigtransform.h \ + @top_srcdir@/kig/objects/object_imp.h \ + @top_srcdir@/kig/objects/curve_imp.h \ + @top_srcdir@/kig/objects/point_imp.h \ + @top_srcdir@/kig/objects/line_imp.h \ + @top_srcdir@/kig/objects/conic_imp.h \ + @top_srcdir@/kig/objects/cubic_imp.h \ + @top_srcdir@/kig/objects/bogus_imp.h \ + @top_srcdir@/kig/objects/circle_imp.h \ + @top_srcdir@/kig/objects/other_imp.h \ + @top_srcdir@/kig/scripting/python-scripting-api-dox-mainpage.dox + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp +# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories +# that are symbolic links (a Unix filesystem feature) are excluded from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. + +EXCLUDE_PATTERNS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command <filter> <input-file>, where <filter> +# is the value of the INPUT_FILTER tag, and <input-file> is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. + +INPUT_FILTER = "sed -e 's,BogusImp,BogusObject,g' -e 's,StringImp,StringObject,g' -e 's,IntImp,IntObject,g' -e 's,DoubleImp,DoubleObject,g' -e 's,TransformationImp,TransformationObject,g' -e 's,HierarchyImp,HierarchyObject,g' -e 's,InvalidImp,InvalidObject,g' -e 's/\([a-zA-Z]*\)Imp/\1/g'" + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES (the default) +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES (the default) +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = YES + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = YES + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. + +HTML_HEADER = @srcdir@/header.html + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = @srcdir@/footer.html + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = @srcdir@/doxygen.css + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = YES + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = YES + +# This tag can be used to set the number of enum values (range [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + +ENUM_VALUES_PER_LINE = 4 + +# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be +# generated containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# probably better off using the HTML help feature. + +GENERATE_TREEVIEW = NO + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = NO + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4wide + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = NO + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = NO + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_PREDEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# in the INCLUDE_PATH (see below) will be search if a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse the +# parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or +# super classes. Setting the tag to NO turns the diagrams off. Note that this +# option is superseded by the HAVE_DOT option below. This is only a fallback. It is +# recommended to install and use dot, since it yields more powerful graphs. + +CLASS_DIAGRAMS = YES + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = YES + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# the CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will +# generate a call dependency graph for every global function or class method. +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable call graphs for selected +# functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are png, jpg, or gif +# If left blank png will be used. + +DOT_IMAGE_FORMAT = png + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found on the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width +# (in pixels) of the graphs generated by dot. If a graph becomes larger than +# this value, doxygen will try to truncate the graph, so that it fits within +# the specified constraint. Beware that most browsers cannot cope with very +# large images. + +MAX_DOT_GRAPH_WIDTH = 1024 + +# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height +# (in pixels) of the graphs generated by dot. If a graph becomes larger than +# this value, doxygen will try to truncate the graph, so that it fits within +# the specified constraint. Beware that most browsers cannot cope with very +# large images. + +MAX_DOT_GRAPH_HEIGHT = 1024 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes that +# lay further from the root node will be omitted. Note that setting this option to +# 1 or 2 may greatly reduce the computation time needed for large code bases. Also +# note that a graph may be further truncated if the graph's image dimensions are +# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). +# If 0 is used for the depth value (the default), the graph is not depth-constrained. + +MAX_DOT_GRAPH_DEPTH = 0 + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- + +# The SEARCHENGINE tag specifies whether or not a search engine should be +# used. If set to NO the values of all tags below this one will be ignored. + +SEARCHENGINE = NO diff --git a/doc/kig/scripting-api/Makefile.am b/doc/kig/scripting-api/Makefile.am new file mode 100644 index 00000000..1fd75153 --- /dev/null +++ b/doc/kig/scripting-api/Makefile.am @@ -0,0 +1,7 @@ +# generate the Kig Python Scriptin APIdocs from the Kig source code + +all-local: build-kig-python-scripting-apidocs +build-kig-python-scripting-apidocs: +# cat $(srcdir)/Doxyfile.scripting-api.in | sed -e 's#KIGVERSION#@KIGVERSION@#g' | sed -e 's#TOPSRCDIR#$(top_srcdir)#g' | sed -e 's#SRCDIR#$(srcdir)#g' > Doxyfile.scripting-api + doxygen Doxyfile.scripting-api + cp bottom1.png bottom2.png docheadergears.png grad.png headerbg.png build/html diff --git a/doc/kig/scripting-api/README b/doc/kig/scripting-api/README new file mode 100644 index 00000000..1f9b6062 --- /dev/null +++ b/doc/kig/scripting-api/README @@ -0,0 +1,14 @@ +This directory contains mostly the things necessary for generating the +Kig Python Scripting API documentation from the Kig source code. This +file serves to answer two questions: + +1 Why is this in its own directory ? Because, when I tried putting it + in the directory above, the KDE_DOCS am_edit feature installed the + Doxyfile and stuff in the documentation dir, which is bogus. + +2 You copied doxygen.css, footer.html, header.html, headerbg.png, + docheadergears.png, grad.png, bottom1.png and bottom2.png from + kdelibs/doc/common, why didn't you use the already installed version + in kde_htmldir/common ? -> because Kig is supposed to run on + various KDE installations ( ranging from 3.1 to HEAD ), and I don't + think the images in there are guaranteed not to change.. diff --git a/doc/kig/scripting-api/bottom1.png b/doc/kig/scripting-api/bottom1.png Binary files differnew file mode 100644 index 00000000..cf26bf4f --- /dev/null +++ b/doc/kig/scripting-api/bottom1.png diff --git a/doc/kig/scripting-api/bottom2.png b/doc/kig/scripting-api/bottom2.png Binary files differnew file mode 100644 index 00000000..05151553 --- /dev/null +++ b/doc/kig/scripting-api/bottom2.png diff --git a/doc/kig/scripting-api/configure.in.in b/doc/kig/scripting-api/configure.in.in new file mode 100644 index 00000000..61b79189 --- /dev/null +++ b/doc/kig/scripting-api/configure.in.in @@ -0,0 +1 @@ +dnl AC_OUTPUT( doc/kig/scripting-api/Doxyfile.scripting-api ) diff --git a/doc/kig/scripting-api/docheadergears.png b/doc/kig/scripting-api/docheadergears.png Binary files differnew file mode 100644 index 00000000..d2a64b78 --- /dev/null +++ b/doc/kig/scripting-api/docheadergears.png diff --git a/doc/kig/scripting-api/doxygen.css b/doc/kig/scripting-api/doxygen.css new file mode 100644 index 00000000..2982c55e --- /dev/null +++ b/doc/kig/scripting-api/doxygen.css @@ -0,0 +1,156 @@ +/******************************************************************************* + Adapted from the doxygen.css in kdelibs/doc/common by domi +********************************************************************************/ + +/******************************************************************************* + + Style sheet for kdelibs doxygen documentation. + Copyright (c) Anders Lund <anders@alweb.dk> 2002 + + This script is made available under the terms of the General Public License. + You should have received a copy of the GNU General Public License + along with this software; see the file COPYING. If not, write to + the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, + Boston, MA 02110-1301, USA. + +********************************************************************************/ + +body { + margin: 0px; + color: black; + background-color: white; +} + +a { + color: #0000C0; +} + +/* decorative header */ +div.header { + background-color: #0855C5; + background-image: url("headerbg.png"); +} +div.header table { + padding: 0px; + margin: 0px +} +div.header table tr td h1 { + color: white; + font: bold 20pt monospace; + padding-top: 0.5em; +} + +/* global lind buttons at bottom of decorative header */ +table.links { + float: right; + border:0; + padding-left:1px +} +table.links td a { + color: white +} +table.links td:hover { + background-color:#0C4293; +} +table.links td a:hover { + color: white; + background-color:#0C4293 +} +table.links td { + border-left: 1px solid #4A81D5; + padding: 0px 12px 0px 12px; + background-color:#0E4EAF; + font-size:9pt; + /*font-weight: bold;*/ +} + +/* little gradient below decorative/navigation header */ +div#hgrad { + height: 12px; + background-image: url("grad.png"); +} + +/* contents part of page */ +div.text { + margin: 12px +} + +/* contents, mostly equivalent to the default doxugen style sheet */ +H1 { text-align: center; } +CAPTION { font-weight: bold } +A.qindex {} +A.qindexRef {} +A.el { text-decoration: none; font-weight: bold } +A.elRef { font-weight: bold } +A.code { text-decoration: none; font-weight: normal; color: #4444ee } +A.codeRef { font-weight: normal; color: #4444ee } +A:hover { text-decoration: none; background-color: #ececec } +DL.el { margin-left: -1cm } +DIV.fragment { width: 100%; border: none; background-color: #ffffee; padding: 12px } +DIV.ah { background-color: navy; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px } +TD.md { background-color: #ececec; font-weight: bold; } +TD.mdname1 { background-color: #ececec; font-weight: bold; color: #602020; } +TD.mdname { background-color: #ececec; font-weight: bold; color: #602020; width: 600px; } +DIV.groupHeader { margin-left: 16px; margin-top: 12px; margin-bottom: 6px; font-weight: bold } +DIV.groupText { margin-left: 16px; font-style: italic; font-size: smaller } +BODY { background: white } +TD.indexkey { + background-color: #e0eef8; + font-weight: bold; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px +} +TD.indexvalue { + background-color: #e0eef8; + font-style: normal; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px +} +FONT.keyword { color: #008000 } +FONT.keywordtype { color: #604020 } +FONT.keywordflow { color: #e08000 } +FONT.comment { color: #800000 } +FONT.preprocessor { color: #806020 } +FONT.stringliteral { color: #002080 } +FONT.charliteral { color: #008080 } + + + +/* kde decoration at bottom */ +div#bottom-nav { + position : relative; + background-color: transparent; + /*width : 100%;*/ + /*top: 0px; + left: 0px; + right: 0px; + margin-left: 0px; + margin-right:0px;*/ + margin-top: 12px; + height: 50px; + background-image : url('bottom1.png'); + background-repeat : repeat-x; +} + +/* copyright etc at bottom */ +div.bottom { + margin: 12px; + font-size: 9pt; + text-align: right; +} +div.bottom a { + color: #aaaaaa +} + diff --git a/doc/kig/scripting-api/footer.html b/doc/kig/scripting-api/footer.html new file mode 100644 index 00000000..6d94781b --- /dev/null +++ b/doc/kig/scripting-api/footer.html @@ -0,0 +1,15 @@ +<!-- Adapted from the footer.html in kdelibs/doc/common by domi --> +</div> +<div id="bottom-nav"> +<img src="bottom2.png" align="right" height="59" width="227" alt="KDE Logo"> +</div> +<div class="bottom"> +This file is part of the documentation for kdelibs $projectnumber. +</div> +<div class="bottom" style="color:#cccccc"> +Documentation copyright © 1996-2002 the KDE developers.<br> +Generated on $datetime by +<a href="http://www.doxygen.org/index.html">doxygen</a> $doxygenversion written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, © 1997-2001 +</div> +</body> +</html> diff --git a/doc/kig/scripting-api/grad.png b/doc/kig/scripting-api/grad.png Binary files differnew file mode 100644 index 00000000..b0c7f409 --- /dev/null +++ b/doc/kig/scripting-api/grad.png diff --git a/doc/kig/scripting-api/header.html b/doc/kig/scripting-api/header.html new file mode 100644 index 00000000..e491908a --- /dev/null +++ b/doc/kig/scripting-api/header.html @@ -0,0 +1,34 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!-- Adapted from the header.html in kdelibs/doc/common by domi --> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> + <title>$title ($projectname)</title> + <link href="doxygen.css" rel="stylesheet" type="text/css"> +</head> +<body> + <div class="header"> + <table border="0" cellspacing="0" cellpadding="0"> + <tr> + <td rowspan="2" width="92"> + <a href="index.html" title="The Kig Python Scripting API documentation main page"><img src="docheadergears.png" style="border:0px;" alt=""></a> + </td> + <td width="95%"> + <h1>$projectname Documentation</h1> + </td> + </tr> + <tr> + <td valign="bottom"> + <table class="links" border=0 cellspacing=0> + <tr> + <td><a href="index.html">Overview</a></td> + <td><a href="hierarchy.html" title="Inheritance list, sorted roughly alphabetically">Class Hierarchy</a></td> + <td><a href="classes.html" title="Alphabetical list of classes">Classes</a></td> + <td><a href="annotated.html" title="Classes, structs, unions and interfaces with brief descriptions">Classes (annotated)</a></td> + <td><a href="functions.html" title="Documented class members with links to the classes they belong to">Members</a></td> + </tr> + </table> + </td></tr></table> + </div> + <div id="hgrad"></div> + <div class="text"> diff --git a/doc/kig/scripting-api/headerbg.png b/doc/kig/scripting-api/headerbg.png Binary files differnew file mode 100644 index 00000000..cb7481fe --- /dev/null +++ b/doc/kig/scripting-api/headerbg.png diff --git a/doc/kig/selecting_objects.png b/doc/kig/selecting_objects.png Binary files differnew file mode 100644 index 00000000..4ab53e9f --- /dev/null +++ b/doc/kig/selecting_objects.png diff --git a/doc/kig/simple_locus_construction.png b/doc/kig/simple_locus_construction.png Binary files differnew file mode 100644 index 00000000..53d0fd6b --- /dev/null +++ b/doc/kig/simple_locus_construction.png diff --git a/doc/kig/test_run_macro.png b/doc/kig/test_run_macro.png Binary files differnew file mode 100644 index 00000000..3680da3e --- /dev/null +++ b/doc/kig/test_run_macro.png diff --git a/doc/kig/text_label_attaching.png b/doc/kig/text_label_attaching.png Binary files differnew file mode 100644 index 00000000..5f7468ec --- /dev/null +++ b/doc/kig/text_label_attaching.png diff --git a/doc/kig/text_label_wizard.png b/doc/kig/text_label_wizard.png Binary files differnew file mode 100644 index 00000000..d6b2190f --- /dev/null +++ b/doc/kig/text_label_wizard.png diff --git a/doc/kig/text_label_wizard__select_property.png b/doc/kig/text_label_wizard__select_property.png Binary files differnew file mode 100644 index 00000000..ac385c0c --- /dev/null +++ b/doc/kig/text_label_wizard__select_property.png |
