From e5890f932369659c62f68c8a616db84660987dc8 Mon Sep 17 00:00:00 2001
From: Christophe Geuzaine <cgeuzaine@ulg.ac.be>
Date: Fri, 11 Apr 2003 23:36:18 +0000
Subject: [PATCH] Make the doc compile...
---
doc/texinfo/gmsh.texi | 115 +++++++++++++++---------------------------
1 file changed, 41 insertions(+), 74 deletions(-)
diff --git a/doc/texinfo/gmsh.texi b/doc/texinfo/gmsh.texi
index f00b7cdfb4..bac27e3119 100644
--- a/doc/texinfo/gmsh.texi
+++ b/doc/texinfo/gmsh.texi
@@ -1,5 +1,5 @@
\input texinfo.tex @c -*-texinfo-*-
-@c $Id: gmsh.texi,v 1.8 2003-04-11 22:17:06 geuzaine Exp $
+@c $Id: gmsh.texi,v 1.9 2003-04-11 23:36:18 geuzaine Exp $
@c
@c Copyright (C) 1997-2003 C. Geuzaine, J.-F. Remacle
@c
@@ -70,7 +70,7 @@
post-processing facilities
@end direntry
@noindent
-This is edition @value{EDITION}/@today{} of the @cite{Gmsh Reference
+This is edition @value{EDITION} (@today{}) of the @cite{Gmsh Reference
Manual}, for Gmsh @value{GMSH-VERSION}.
@noindent
Copyright @value{COPYRIGHT}
@@ -98,7 +98,7 @@ Copyright @value{COPYRIGHT}
@subtitle The documentation for Gmsh, Version @value{GMSH-VERSION}
@subtitle A finite element mesh generator with built-in pre- and post-processing facilities
@subtitle
-@subtitle Edition @value{EDITION}/@today{}
+@subtitle Edition @value{EDITION} (@today{})
@author Christophe Geuzaine
@author Jean-Francois Remacle
@@ -128,14 +128,13 @@ all copies.
@node Top, Copying conditions, (dir), (dir)
@top Gmsh
-@chapheading The documentation for Gmsh, Version @value{GMSH-VERSION}
-@chapheading a finite element mesh generator with built-in pre- and post-processing facilities
+@chapheading Gmsh Reference Manual
Christophe Geuzaine and Jean-Francois Remacle
Gmsh is an automatic 3D finite element mesh generator with build-in pre- and
-post-processing facilities. This is edition @value{EDITION}/@today{} of the
-@cite{Gmsh Reference Manual} for Gmsh @value{GMSH-VERSION}.
+post-processing facilities. This is edition @value{EDITION} (@today{}) of
+the @cite{Gmsh Reference Manual}, for Gmsh @value{GMSH-VERSION}.
@end ifnottex
@c =========================================================================
@@ -168,15 +167,14 @@ Introduction
* What Gmsh is good at...::
* ... and what Gmsh sucks at::
-* How to Read this Manual::
* Syntactic rules::
Overview
-* Geometry: geometrical entity definition::
-* Mesh: finite element mesh generatio::
-* Solver: external solver interface::
-* Post-processing: scalar and vector field visualization::
+* Geometry::
+* Mesh::
+* Solver::
+* Post-processing::
General tools
@@ -285,20 +283,19 @@ volumes. These adapted meshes can be mixed with simple structured
All geometrical, mesh, solver and post-processing instructions are
prescribed in a language analyzed by Lex and Yacc. The code itself is
written in C++, while the graphics are rendered with OpenGL and the user
-interface is based on the FLTK widget set. See XXX for some development
-comments.
-
-@c -------------------------------------------------------------------------
-@c What Gmsh is good at
-@c -------------------------------------------------------------------------
+interface is based on the FLTK widget set. @xref{Programming comments}, for
+some development comments.
@menu
* What Gmsh is good at...::
* ... and what Gmsh sucks at::
-* How to Read this Manual::
* Syntactic rules::
@end menu
+@c -------------------------------------------------------------------------
+@c What Gmsh is good at
+@c -------------------------------------------------------------------------
+
@node What Gmsh is good at..., ... and what Gmsh sucks at, Introduction, Introduction
@section What Gmsh is good at...
@@ -310,7 +307,7 @@ Gmsh should be pretty good at
@c ... and what Gmsh sucks at
@c -------------------------------------------------------------------------
-@node ... and what Gmsh sucks at, How to Read this Manual, What Gmsh is good at..., Introduction
+@node ... and what Gmsh sucks at, Syntactic rules, What Gmsh is good at..., Introduction
@section ... and what Gmsh sucks at
Gmsh is not an primarily a structured mesh generator. You can transfinite,
@@ -333,38 +330,11 @@ speed. Your mileage may vary, of course, depending of what you consider a
``large'' problem...
-@c -------------------------------------------------------------------------
-@c How to Read this Manual
-@c -------------------------------------------------------------------------
-
-@node How to Read this Manual, Syntactic rules, ... and what Gmsh sucks at, Introduction
-@section How to read this manual
-
-@cindex Reading, guidelines
-
-How to Read this Manual...
-
-After reading @ref{Overview}, and @ref{Expressions}, which depict the
-general concepts and the way to construct simple expressions in Gmsh, you
-can safely directly go to @ref{Short examples}. This chapter gives simple
-examples of geometries built with Gmsh. For each example, you should then go
-back to @ref{Geometry} to get a detailed view of the syntax of the commands
-used. Note that indexes for many concepts and for all the syntax elements
-are available at the end of this manual.
-
-Once the examples presented in @ref{Short examples}, you might want to learn
-about Gmsh's meshing and post-processing capabilities in @ref{Mesh} and
-@ref{Post-processing}. If you plan to interface a solver with Gmsh, see
-@ref{Solver}. Some notes on how to run Gmsh on your computer are given in
-@ref{Running Gmsh}.
-
-Tutorial...
-
@c -------------------------------------------------------------------------
@c Syntactic Rules Used in this Document
@c -------------------------------------------------------------------------
-@node Syntactic rules, , How to Read this Manual, Introduction
+@node Syntactic rules, , ... and what Gmsh sucks at, Introduction
@section Syntactic rules used in this document
@cindex Syntax, rules
@@ -374,14 +344,13 @@ Tutorial...
@vindex @dots{}
@vindex <, >
@vindex |
-@vindex :
+@c forbidden @vindex :
@vindex @var{etc}
Here are the rules we tried to follow when writing this user's guide. Note
that metasyntactic variable definitions stay valid throughout all the manual
(and not only in the sections where the definitions
-appear). @xref{Metasyntactic variable index}, for an index of all
-metasyntactic variables.
+appear).
@enumerate
@item
@@ -414,8 +383,6 @@ The @var{etc} symbol replaces nonlisted rules.
@cindex Overview
-Working philosophy:
-
Gmsh is structured around four modules: geometry, mesh, solver and
post-processing. The specification of any input to these modules is done
either interactively, or in text data files (interactive specifications
@@ -432,18 +399,18 @@ from inside Gmsh (e.g. GetDP or other solvers) or to apply complex
user-defined treatments to geometry, mesh or post-processing data. A brief
description of the four modules is given hereafter.
+@menu
+* Geometry::
+* Mesh::
+* Solver::
+* Post-processing::
+@end menu
+
@c -------------------------------------------------------------------------
@c Geometry: geometrical entity definition
@c -------------------------------------------------------------------------
-@menu
-* Geometry: geometrical entity definition::
-* Mesh: finite element mesh generatio::
-* Solver: external solver interface::
-* Post-processing: scalar and vector field visualization::
-@end menu
-
-@node Geometry: geometrical entity definition, Mesh: finite element mesh generatio, Overview, Overview
+@node Geometry, Mesh, Overview, Overview
@section Geometry: geometrical entity definition
Geometries are created in a bottom-up flow by successively defining
@@ -460,7 +427,7 @@ of all geometrical entities.
@c Mesh: finite element mesh generation
@c -------------------------------------------------------------------------
-@node Mesh: finite element mesh generatio, Solver: external solver interface, Geometry: geometrical entity definition, Overview
+@node Mesh, Solver, Geometry, Overview
@section Mesh: finite element mesh generation
A finite element mesh is a tessellation of a given subset of
@@ -513,7 +480,7 @@ circumscribed circle/sphere.
@c Solver: external solver interface
@c -------------------------------------------------------------------------
-@node Solver: external solver interface, Post-processing: scalar and vector field visualization, Mesh: finite element mesh generatio, Overview
+@node Solver, Post-processing, Mesh, Overview
@section Solver: external solver interface
External solvers can be interfaced with Gmsh through a socket
@@ -529,7 +496,7 @@ HREF="/gmsh/doc/FAQ">FAQ</a>).
@c Post-processing: scalar and vector field visualization
@c -------------------------------------------------------------------------
-@node Post-processing: scalar and vector field visualization, , Solver: external solver interface, Overview
+@node Post-processing, , Solver, Overview
@section Post-processing: scalar and vector field visualization
Multiple post-processing scalar or vector maps can be loaded and
@@ -553,10 +520,6 @@ of complex animations).
ASCII files, parser, blabla
-@c -------------------------------------------------------------------------
-@c Comments
-@c -------------------------------------------------------------------------
-
@menu
* Comments::
* Expressions::
@@ -566,6 +529,10 @@ ASCII files, parser, blabla
* Option database::
@end menu
+@c -------------------------------------------------------------------------
+@c Comments
+@c -------------------------------------------------------------------------
+
@node Comments, Expressions, General tools, General tools
@section Comments
@@ -759,7 +726,7 @@ or C++ programming languages.
@tindex !=
@tindex ||
@tindex &&
-@tindex ?:
+@c forbidden @tindex ?:
@noindent
@var{operator-unary}:
@@ -1247,10 +1214,6 @@ XXX
@cindex Short examples
@cindex Examples, short
-@c -------------------------------------------------------------------------
-@c t1.geo
-@c -------------------------------------------------------------------------
-
@menu
* t1.geo::
* t2.geo::
@@ -1263,6 +1226,10 @@ XXX
* t9.geo::
@end menu
+@c -------------------------------------------------------------------------
+@c t1.geo
+@c -------------------------------------------------------------------------
+
@node t1.geo, t2.geo, Tutorial, Tutorial
@section t1.geo
@@ -1539,7 +1506,7 @@ your @code{.emacs} file: @code{(setq auto-mode-alist (append '(("\\.pro$"
. c++-mode)) auto-mode-alist))}.
@item
Define common geometrical objects and options in separate files, reusable in
-all your problem definition structures (@pxref{Includes}).
+all your problem definition structures.
@end itemize
@c =========================================================================
--
GitLab