]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Cross-link.
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Tue, 17 Aug 2010 19:58:34 +0000 (19:58 +0000)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Tue, 17 Aug 2010 19:58:34 +0000 (19:58 +0000)
git-svn-id: https://svn.dealii.org/trunk@21676 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/doc/development/writing-documentation.html

index b64b11c37b4f7a3a0448691a71a224ba56d6f2f7..47a43477ccd67ab913d1eb3be686b098724ffad1 100644 (file)
     <p>
       More important is what goes into the introduction. Typically,
       this would first be a statement of the problem that we want to
-      solve. Take a look, for example, at the step-22 or step-31
-      tutorial programs. Then come a few sections in which we would
-      discuss in mathematical terms the algorithms that we want to
-      use; this could, for example, include the time stepping,
-      discretization, or solver approaches. step-22 and step-31 are
-      again good, if lengthy, examples for this.
+      solve. Take a look, for example, at
+      the <a href="../doxygen/deal.II/step_22.html"
+      target="_top">step-22</a>
+      or <a href="../doxygen/deal.II/step_31.html"
+      target="_top">step-31</a> tutorial programs. Then come a few
+      sections in which we would discuss in mathematical terms the
+      algorithms that we want to use; this could, for example, include
+      the time stepping, discretization, or solver
+      approaches. <a href="../doxygen/deal.II/step_22.html"
+      target="_top">step-22</a>
+      and <a href="../doxygen/deal.II/step_31.html"
+      target="_top">step-31</a> are again good, if lengthy, examples
+      for this.
     </p>
 
     <p>
       On the other hand, if a program is an extension of a previous
       program, these things need not be repeated: you would just
-      reference the previous program. For example, step-16 does not
-      talk about adaptive meshes any more &mdash; it extends step-6
-      and simply refers there for details. Likewise, step-32 simply
-      refers to step-31 for the problem statement and basic algorithm
-      and simply focuses on those parts that are new compared to
-      step-31.
+      reference the previous program. For
+      example, <a href="../doxygen/deal.II/step_16.html"
+      target="_top">step-16</a> does not talk about adaptive meshes
+      any more &mdash; it
+      extends <a href="../doxygen/deal.II/step_6.html"
+      target="_top">step-6</a> and simply refers there for
+      details. Likewise, <a href="../doxygen/deal.II/step_32.html"
+      target="_top">step-32</a> simply refers
+      to <a href="../doxygen/deal.II/step_31.html"
+      target="_top">step-31</a> for the problem statement and basic
+      algorithm and simply focuses on those parts that are new
+      compared to
+      <a href="../doxygen/deal.II/step_31.html" target="_top">step-31</a>.
     </p>
 
     <p>
     <p>
       If it helps the understanding, the introduction can refer to
       particular pieces of code (but doesn't have to). For example,
-      the introduction to step-20 has pretty lengthy code snippets
-      that explain how to implement a general interface of operators
-      that may or may not be matrices. This would be awkward to do
-      within the code since in the code the view is somewhat smaller
-      (you have to have complete parameter lists, follow the syntax of
-      the programming language, etc, all of which obscures the things
-      one wants to discuss when giving a broad overview related to
+      the introduction to <a href="../doxygen/deal.II/step_20.html"
+      target="_top">step-20</a> has pretty lengthy code snippets that
+      explain how to implement a general interface of operators that
+      may or may not be matrices. This would be awkward to do within
+      the code since in the code the view is somewhat smaller (you
+      have to have complete parameter lists, follow the syntax of the
+      programming language, etc, all of which obscures the things one
+      wants to discuss when giving a broad overview related to
       particular C++ constructs). On the other hand, showing code
       snippets in the introduction risks duplicating code in two
       places, which will eventually get out of synch. Consequently,

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.