Changeset 10:55e2f7712e87 in lemon-tutorial

Timestamp:

10/30/08 18:13:33 (15 years ago)

Author:

Alpar Juttner <alpar@…>

Branch:

default

Phase:

public

Message:

TOC and section numbering are generated from toc.txt

Files:

• .hgignore (modified) (1 diff)
• Doxyfile (modified) (2 diffs)
• Makefile (modified) (1 diff)
• getting_started.dox (modified) (4 diffs)
• install.dox (modified) (8 diffs)
• intro.dox (modified) (3 diffs)
• license.dox (modified) (1 diff)
• mainpage.dox (modified) (1 diff)
• titlegen.py (added)
• toc.txt (added)

.hgignore

@@ -16 +16 @@
 ^html/.*
 ^gen-images/.*
+^gen-dox/.*

Doxyfile

@@ -71 +71 @@
 SHOW_NAMESPACES        = NO
 FILE_VERSION_FILTER    = 
-LAYOUT_FILE            = DoxygenLayout.xml
+LAYOUT_FILE            = ./DoxygenLayout.xml
 #---------------------------------------------------------------------------
 # configuration options related to warning and progress messages
@@ -85 +85 @@
 # configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT                  = . \
+INPUT                  = ./gen-dox \
                          ./demo
 INPUT_ENCODING         = UTF-8

Makefile

@@ -16 +16 @@
 
 html: $(PNG_IMAGES)
+        -mkdir gen-dox
+        ./titlegen.py
         doxygen Doxyfile
 

getting_started.dox

@@ -18 +18 @@
 
 /**
-\page hello_lemon Compile Your First Code
+[PAGE]hello_lemon[PAGE] Compile Your First Code
 
 If you have installed LEMON on your system you can paste the following
@@ -53 +53 @@
 Now let us compile this simple example program.
 
-\section hello_lemon_system If LEMON is Installed System-Wide
+[SEC]hello_lemon_system[SEC] If LEMON is Installed System-Wide
 
 If LEMON is installed system-wide (into directory \c /usr/local),
@@ -71 +71 @@
 \endverbatim
 
-\section hello_lemon_user If LEMON is Installed User-Local
+[SEC]hello_lemon_user[SEC] If LEMON is Installed User-Local
 
 Compiling the code is a bit more difficult if you installed LEMON
@@ -115 +115 @@
 <a href="mailto:lemon-user@lemon.cs.elte.hu"><b>contact us</b></a>.
 
+[TRAILER]
 */

install.dox

@@ -18 +18 @@
 
 /**
-\page install Installation Guide
+[PAGE]install[PAGE] Installation Guide
 
 In this section we detail how to start using LEMON, from downloading it
@@ -28 +28 @@
 <a href="mailto:lemon-user@lemon.cs.elte.hu"><b>ask</b></a>.
 
-\section requirements_lemon Hardware and Software Requirements
+[SEC]requirements_lemon[SEC] Hardware and Software Requirements
 
 In LEMON we use C++ templates heavily, thus compilation takes a
@@ -47 +47 @@
 the instructions detailed here to be able to use LEMON with your compiler.
 
-\subsection requirements_lp LP Solver Requirements
+[SEC]requirements_lp[SEC] LP Solver Requirements
 
 The LEMON LP solver interface can use the GLPK (GNU Linear Programming
@@ -54 +54 @@
 See the <b><tt>INSTALL</tt></b> file how to enable these at compile time.
 
-\section install_from_source Install from Source
+[SEC]install_from_source[SEC] Install from Source
 
 You can download LEMON from the web site:
@@ -142 +142 @@
 For more information see the <b><tt>INSTALL</tt></b> file.
 
-\subsection install_hg Install the Latest Development Version
+[SEC]install_hg[SEC] Install the Latest Development Version
 
 You can also use the latest (developer) version of LEMON from our Mercurial
@@ -187 +187 @@
 
 
-\section install_rpm Install from rpm
+[SEC]install_rpm[SEC] Install from rpm
 
 \todo Write this section (\ref install_rpm).
 
-
-\section install_user Install Locally to the User
+[SEC]install_user[SEC] Install Locally to the User
 
 \todo Write this section (\ref install_user).
 
 
-\section compile_codes Compile Codes that Use LEMON
+[SEC]compile_codes[SEC] Compile Codes that Use LEMON
 
 Now let us see how to use the library after installing it.
 
-\subsection compile_system_wide If LEMON is Installed System-Wide
+[SEC]compile_system_wide[SEC] If LEMON is Installed System-Wide
 
 If your installation of LEMON into directory \c /usr/local was
@@ -214 +213 @@
 installed library LEMON.
 
-\subsection compile_user_local If LEMON is Installed User-Local
+[SEC]compile_user_local[SEC] If LEMON is Installed User-Local
 
 You have to give more options to the compiler if LEMON is installed
@@ -226 +225 @@
 \endverbatim
 
-\subsubsection compile_use_pkg_config Use pkg-config
+[SEC]compile_use_pkg_config[SEC] Use pkg-config
 
 \todo Write this sub-subsection (\ref compile_use_pkg_config).
 
+[TRAILER]
 */

intro.dox

@@ -18 +18 @@
 
 /**
-\page intro Introduction
+[PAGE]intro[PAGE] Introduction
 
-\section intro_lemon What is LEMON
+[SEC]intro_lemon[SEC] What is LEMON
 
 <b>LEMON</b> stands for <b>L</b>ibrary of <b>E</b>fficient <b>M</b>odels and
@@ -43 +43 @@
 <a href="http://lemon.cs.elte.hu/"><b>http://lemon.cs.elte.hu/</b></a>.
 
-\section intro_tutorial LEMON Tutorial
+[SEC]intro_tutorial[SEC] LEMON Tutorial
 
 This tutorial introduces the reader to the basic concepts and features of
@@ -53 +53 @@
 as a reference manual).
 
+
+[TRAILER]
+
 */

license.dox

@@ -19 +19 @@
 /**
 
-\page license License Terms
+[PAGE]license[PAGE] License Terms
 
 \verbinclude ./LICENSE
 
+[TRAILER]
 */

mainpage.dox

@@ -23 +23 @@
 \section toc Table of Contents
 
- - \ref intro
- - \ref basic_concepts "Basic Concepts"
-   - \ref hello_lemon
-   - \ref digraph_build "Build and Modify a Digraph"
-   - \ref digraph_iterate "Iterate Over the Elements"
-   - \ref standard_maps "Maps - Assign Data to Graphs"
-   - \ref algorithms "Algorithms"
-     - \ref alg_bfs_dfs "BFS, DFS - Graph Search"
-     - \ref alg_dijkstra "Dijkstra - Shorthest Path"
-     - \ref alg_kruskal "Kruskal - Minimum Spanning Tree"
-   - \ref undir_graphs "Undirected Graphs"
- - \ref tools "Some Important Auxiliary Tools"
-   - \ref lgf "LEMON Graph Format"
-     - \ref glemon "gLemon - A Graph Editor for LEMON"
-   - \ref graph_to_eps "GraphToEps - Postscript Exporting"
-   - \ref time_count "Time Measuring and Counting"
-   - \ref random "Random Numbers"
- - \ref advanced "Advanced Topics"
-   - \ref maps "Maps"
-     - \ref map_concepts "Read/Write/Reference Maps"
-     - \ref custom_maps "Custom Maps"
-     - \ref map_adaptors "Map Adaptors"
-     - \ref special_maps "Other Special Purpose Maps"
-   - \ref graphs "Graphs"
-     - \ref graph_adaptors "Graph Adaptors"
-     - \ref special_graphs "Special Graph Structures"
-   - \ref named_params "Named Parameters"
-     - \ref alg_named_params "Customizing Algorithms"
- - \ref lp "LP and MIP Solvers"
-   - \ref lp_examples "Simple Examples"
-   - \ref lp_maxflow "Maximum Flow as LP Problem"
- - \ref appendix "Appendix"
-   - \ref install
-     - \ref requirements_lemon
-       - \ref requirements_lp
-     - \ref install_from_source
-       - \ref install_hg
-     - \ref install_rpm
-     - \ref install_user
-     - \ref compile_codes
-       - \ref compile_system_wide
-       - \ref compile_user_local
+[TOC]
 
 */