The deal.II Homepage

From 7c31ea31fe3bbed65185cbd8602b0a50b707cac6 Mon Sep 17 00:00:00 2001 From: wolf Date: Mon, 3 Apr 2000 11:51:17 +0000 Subject: [PATCH] Exclude online doc information from main page and create a page of its own. git-svn-id: https://svn.dealii.org/trunk@2656 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/doc/documentation.html | 142 +++++++++++++++++++++++++++++++++ deal.II/doc/navbar.html | 8 ++ deal.II/doc/toc.html | 100 +++-------------------- 3 files changed, 163 insertions(+), 87 deletions(-) create mode 100644 deal.II/doc/documentation.html diff --git a/deal.II/doc/documentation.html b/deal.II/doc/documentation.html new file mode 100644 index 0000000000..7878153317 --- /dev/null +++ b/deal.II/doc/documentation.html @@ -0,0 +1,142 @@ + + + + + + The deal.II Homepage + + + + + +

Online documentation

+ +

+ deal.II comes with quite extensive online + documentation, which falls into several categories. They are + listed below. +

+ + +

README file

+ The README file of + the library. It gives information on system requirements, + installation, and copyright.

+ +

Tutorials

+ +

+ The tutorial: + for new users of the library. It explains the basic elements of + finite element programs based on the library, and provides small + example programs. +

+ +

+ Another chapter of the tutorial gives an overview of information + classified by subject. This is more for reference than to learn + about the library the first time. +

+ + +

Programming interface

+ +

+ 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 + deal.II library: +

+ /base library: a set of classes not + specifically related to finite elements, but + nonetheless important for the overall library, +
+ /lac library: Linear + algebra classes, +
+ Grid handling in the + /deal.II library, +
+ Degrees of freedom and finite elements in the + /deal.II library, +
+ Numerical tools in the + /deal.II library. +

+ + +

Development information

+ +

+ If you plan to develop your own applications using + deal.II, it might be worth to take a look + at this + page. +

+ + +

Reports

+ +

+ We have a few reports written on deal.II, + the following of which are online: +

+ A + paper describing the background, purpose and methods + of deal.II, by Wolfgang Bangerth and + Guido Kanschat. This paper is also available as preprint + 99-43 from the + + IWR preprint server. +
+ +
+ A brief report about the classes involved in the + iterators + used to access cells in the triangulations and the data + thereon, such as their geometry, the number of the + degrees of freedom, data values, etc. (by Wolfgang Bangerth). +
+ +
+ A report on how + multithreading is implemented and + supported in deal.II (by Wolfgang + Bangerth). +
+

+ + +

Publications

+ +

+ A list of + publications about and based on + deal.II can be found on + this page. +

+ + +

Future

+ +

+ Finally, we have a page where we list our + plans for extensions of deal.II in + the future. +

+ + + + + diff --git a/deal.II/doc/navbar.html b/deal.II/doc/navbar.html index 1d70cf4475..95dd51da0e 100644 --- a/deal.II/doc/navbar.html +++ b/deal.II/doc/navbar.html @@ -30,6 +30,14 @@

+ + Documentation + +

diff --git a/deal.II/doc/toc.html b/deal.II/doc/toc.html index 46e7d72753..891cac82db 100644 --- a/deal.II/doc/toc.html +++ b/deal.II/doc/toc.html @@ -125,100 +125,25 @@

Online documentation

deal.II has quite extensive online - documentation, which falls into several categories: -

The README file of - the library. It gives information on system requirements, - installation, and copyright.
- -
The tutorial: - for new users of the library. It - explains the basic elements of finite element programs based - on the library, and provides small example programs.
- -
If you plan to - develop - your own applications using - deal.II, it might be worth to take a look - at this - page. -
- -
Programming interface documentation: the classes and methods - in the library are extensively documented (presently - approximately 1250 pages if printed). This API documentation - is split into several parts, according - to the sub-libraries and the different directories of the main - deal.II library: -
- - /base library: a set of classes not - specifically related to finite elements, but - nonetheless important for the overall library, -
- - /lac library: Linear - algebra classes, -
- - Grid handling in the - /deal.II library, -
- - Degrees of freedom and finite elements in the - /deal.II library, -
- - Numerical tools in the - /deal.II library. -
-
+ documentation, so we dedicated a + separate + page on documentation to this subject. +
-
We have a few reports written on deal.II, - the following of which are online: -
- - A - paper describing the background, purpose and methods - of deal.II, by Wolfgang Bangerth and - Guido Kanschat. This paper is also available as preprint - 99-43 from the - - IWR preprint server. -
  - -
- - A brief report about the classes involved in the - iterators - used to access cells in the triangulations and the data - thereon, such as their geometry, the number of the - degrees of freedom, data values, etc. (by Wolfgang Bangerth). -
  - -
- - A report on how - multithreading is implemented and - supported in deal.II (by Wolfgang - Bangerth). -
  -
-
-
- A list of - publications about and based on - deal.II can be found on - this page. -
+
+ Those parts of the online documentation that are most often + accessed are the API references. For your convenience, they are + also listed in the navigation panel on the left. +
-
Finally, we have a page where we list our - plans for extensions of deal.II in - the future. -
-

Authors

deal.II was originally designed and written by Wolfgang Bangerth, starting in early 1998; he is still maintaining and @@ -228,9 +153,9 @@ Kanschat helped with advice in the early implementation stages on questions of the design of object-oriented finite element software and later joined into the coding. +

- Other contributors, in alphabetical order, are:

Ralf Hartmann: @@ -248,6 +173,7 @@
Franz-Theo Suttmeier: initial parts of the linear algebra.

License

-- 2.39.5