<p>
The <a href="tutorial/chapter-2.step-by-step/index.html"
- target="_top">tutorial</a>:
+ target="_top">tutorial</a> is
for new users of the library. It explains the basic elements of
finite element programs based on the library, and provides small
- example programs.
+ example programs. You can also reach the tutorial link from the menu bar
+ at the left.
</p>
<p>
<h3>Programming interface</h3>
<p>
- These are the pages you will need most often as a reference of
- all classes, functions and variables in the library. They are
- extensively documented (presently approximately 1250 pages if
- printed), and are split into several parts, according to the
- sub-libraries and the different directories of the main
- <acronym>deal.II</acronym> library:
+ The <a href="doxygen/deal.II/modules.html" target="_top">programming
+ interface/manual</a> pages are what you will need most often as a
+ reference of all classes, functions and variables in the library. They
+ are extensively documented (presently approximately 3000 pages if
+ printed), and generated by <a href="http://www.doxygen.org/"
+ target="_top">Doxygen</a>. There is also a quick link to these pages from
+ the menu bar at the left.
+ </p>
+
+ <p>
+ The documentation uses many of the features of Doxygen. In particular,
+ the link takes you straight to a page that lists <it>modules</it>, a way
+ to group classes with similar purposes. This may be what you are probably
+ interested in when you are not yet familiar with the library. If you
+ already know your way around and want to look up the signature of a
+ particular member function, for example, you may go to the class view or
+ choose any of the other ways in which Doxygen allows you to navigate
+ through the documentation.
</p>
- <ul>
- <li> <a href="doxygen/deal.II/classes.html" target="body">
- Reference handbook</a> of the
- <code>/deal.II</code> library,
- <li> <a href="doxygen/base/classes.html" target="body">
- <code>/base</code> library</a>: a set of classes not
- specifically related to finite elements, but
- nonetheless important for the overall library,
- <li> <a href="doxygen/lac/modules.html" target="body">
- <code>/lac</code> library</a>: <B>L</B>inear
- <B>A</B>lgebra <B>C</B>lasses,
- </ul>
<p>
Just as for the tutorials, the API docs need to be generated first,
<a href="http://www.dealii.org/download/" target="body">Download</a><br />
<a href="http://ganymed.iwr.uni-heidelberg.de/mailman/listinfo/dealii"
target="body">Mailing list</a><br />
- <br />
<a href="http://www-dimat.unipv.it/heltai/wikideal/index.php/Main_Page" target="_top">Wiki</a>
</p>
<p>
<a href="tutorial/chapter-2.step-by-step/index.html" target="_top">Tutorial</a><br />
- <a href="doxygen/deal.II/classes.html" target="_top">Reference</a><br />
- <a href="doxygen/base/classes.html" target="_top">/base API</a><br />
- <a href="doxygen/lac/modules.html" target="_top">/lac API</a>
+ <a href="doxygen/deal.II/modules.html" target="_top">Manual</a><br />
</p>
<hr>