From d37946dd32f0c01b162fb0faada42529810bbc86 Mon Sep 17 00:00:00 2001 From: maier Date: Wed, 25 Sep 2013 22:33:26 +0000 Subject: [PATCH] The big documentation overhaul git-svn-id: https://svn.dealii.org/trunk@30929 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/doc/authors.html | 26 +- .../Toolchain.sample | 0 .../cmake-internals.html | 12 +- .../indentation.html | 13 + .../{development => developers}/index.html | 0 .../{development => developers}/navbar.html | 15 +- .../{development => developers}/porting.html | 11 +- .../doc/{development => developers}/svn.html | 13 + .../testsuite.html | 19 +- .../{development => developers}/title.html | 2 +- .../doc/{development => developers}/toc.html | 78 ++---- .../writing-documentation.html | 20 +- deal.II/doc/documentation.html | 241 ++++-------------- deal.II/doc/license.html | 35 ++- deal.II/doc/mail.html | 22 +- deal.II/doc/navbar.html | 14 +- deal.II/doc/publications/index.html | 14 +- deal.II/doc/readme.html | 25 +- deal.II/doc/reports/index.html | 120 +++++++++ deal.II/doc/screen.css | 17 ++ .../CMakeLists.txt.sample | 0 .../CMakeLists.txt.sample2 | 0 .../CMakeLists.txt.sample3 | 0 .../doc/{development => users}/Config.sample | 0 deal.II/doc/{development => users}/cmake.html | 13 +- .../{development => users}/cmakelists.html | 14 +- .../doc/{development => users}/doxygen.html | 14 +- deal.II/doc/users/index.html | 34 +++ deal.II/doc/users/navbar.html | 62 +++++ deal.II/doc/users/title.html | 31 +++ deal.II/doc/users/toc.html | 125 +++++++++ 31 files changed, 625 insertions(+), 365 deletions(-) rename deal.II/doc/{development => developers}/Toolchain.sample (100%) rename deal.II/doc/{development => developers}/cmake-internals.html (97%) rename deal.II/doc/{development => developers}/indentation.html (73%) rename deal.II/doc/{development => developers}/index.html (100%) rename deal.II/doc/{development => developers}/navbar.html (71%) rename deal.II/doc/{development => developers}/porting.html (92%) rename deal.II/doc/{development => developers}/svn.html (86%) rename deal.II/doc/{development => developers}/testsuite.html (97%) rename deal.II/doc/{development => developers}/title.html (94%) rename deal.II/doc/{development => developers}/toc.html (60%) rename deal.II/doc/{development => developers}/writing-documentation.html (97%) create mode 100644 deal.II/doc/reports/index.html rename deal.II/doc/{development => users}/CMakeLists.txt.sample (100%) rename deal.II/doc/{development => users}/CMakeLists.txt.sample2 (100%) rename deal.II/doc/{development => users}/CMakeLists.txt.sample3 (100%) rename deal.II/doc/{development => users}/Config.sample (100%) rename deal.II/doc/{development => users}/cmake.html (98%) rename deal.II/doc/{development => users}/cmakelists.html (98%) rename deal.II/doc/{development => users}/doxygen.html (80%) create mode 100644 deal.II/doc/users/index.html create mode 100644 deal.II/doc/users/navbar.html create mode 100644 deal.II/doc/users/title.html create mode 100644 deal.II/doc/users/toc.html diff --git a/deal.II/doc/authors.html b/deal.II/doc/authors.html index 03aae2a2e1..36750b7b3b 100644 --- a/deal.II/doc/authors.html +++ b/deal.II/doc/authors.html @@ -12,7 +12,7 @@ -

deal.II Credits

deal.II Authors

The deal.II project was initially started by @@ -42,10 +42,6 @@ -

In order to get in contact with them, send email to authors - at dealii.org. -

Many people have contributed to deal.II over the years, some of them very substantial parts of the library. Their work is greatly appreciated: no open source project can survice without a @@ -330,18 +326,16 @@ Siegen, Germany.

- +

+ The deal.II Authors + $Date$ +

- + +

+ +

diff --git a/deal.II/doc/development/Toolchain.sample b/deal.II/doc/developers/Toolchain.sample similarity index 100% rename from deal.II/doc/development/Toolchain.sample rename to deal.II/doc/developers/Toolchain.sample diff --git a/deal.II/doc/development/cmake-internals.html b/deal.II/doc/developers/cmake-internals.html similarity index 97% rename from deal.II/doc/development/cmake-internals.html rename to deal.II/doc/developers/cmake-internals.html index fbfdbab628..b568a0527f 100644 --- a/deal.II/doc/development/cmake-internals.html +++ b/deal.II/doc/developers/cmake-internals.html @@ -679,11 +679,17 @@ be found, set a cache value: resides under ./cmake/config/template_arguments.in.

- +

- The deal.II Group + The deal.II Authors $Date$

+ +

+ diff --git a/deal.II/doc/development/indentation.html b/deal.II/doc/developers/indentation.html similarity index 73% rename from deal.II/doc/development/indentation.html rename to deal.II/doc/developers/indentation.html index 136881c130..1341960ff3 100644 --- a/deal.II/doc/development/indentation.html +++ b/deal.II/doc/developers/indentation.html @@ -38,5 +38,18 @@ !! file style mismatch detected please re-indent the file. SVN may reject those files soon!

+ +

+ The deal.II Authors + $Date$ +

+ +

+ diff --git a/deal.II/doc/development/index.html b/deal.II/doc/developers/index.html similarity index 100% rename from deal.II/doc/development/index.html rename to deal.II/doc/developers/index.html diff --git a/deal.II/doc/development/navbar.html b/deal.II/doc/developers/navbar.html similarity index 71% rename from deal.II/doc/development/navbar.html rename to deal.II/doc/developers/navbar.html index fcfa429f45..a91f7468fe 100644 --- a/deal.II/doc/development/navbar.html +++ b/deal.II/doc/developers/navbar.html @@ -21,22 +21,22 @@

- Development
+ README
+ User's Corner
+ Developer's Corner

- Writing code + Development

SVN Archive
- CMake documentation
- CMake in user projects
CMake internals
Writing documentation
Porting
- Linking manuals
Coding conventions
+ Testsuite

@@ -44,12 +44,9 @@ Resources

Recent changes
- Mailing lists
- Test suite
Regression tests
Build tests
- Wiki
- Bug tracker
+ Performance tests

diff --git a/deal.II/doc/development/porting.html b/deal.II/doc/developers/porting.html similarity index 92% rename from deal.II/doc/development/porting.html rename to deal.II/doc/developers/porting.html index 07281a2316..89efdc8665 100644 --- a/deal.II/doc/development/porting.html +++ b/deal.II/doc/developers/porting.html @@ -156,10 +156,17 @@ href="cmake.html">the documentation.

- The deal.II Group + The deal.II Authors + $Date$

+ +

diff --git a/deal.II/doc/development/svn.html b/deal.II/doc/developers/svn.html similarity index 86% rename from deal.II/doc/development/svn.html rename to deal.II/doc/developers/svn.html index 307e0eb798..40f50d86b8 100644 --- a/deal.II/doc/development/svn.html +++ b/deal.II/doc/developers/svn.html @@ -84,5 +84,18 @@ resolved, you can simply commit the result.

+ +

+ The deal.II Authors + $Date$ +

+ +

+ diff --git a/deal.II/doc/development/testsuite.html b/deal.II/doc/developers/testsuite.html similarity index 97% rename from deal.II/doc/development/testsuite.html rename to deal.II/doc/developers/testsuite.html index f99a72dbe7..ab0fa99464 100644 --- a/deal.II/doc/development/testsuite.html +++ b/deal.II/doc/developers/testsuite.html @@ -594,16 +594,17 @@ testname/cmp/generic contribute!

- +

- The deal.II Group

- -

+ The deal.II Authors + $Date$ + +

+ +

diff --git a/deal.II/doc/development/title.html b/deal.II/doc/developers/title.html similarity index 94% rename from deal.II/doc/development/title.html rename to deal.II/doc/developers/title.html index c935915100..efe22e6e10 100644 --- a/deal.II/doc/development/title.html +++ b/deal.II/doc/developers/title.html @@ -16,7 +16,7 @@

- Development with deal.II + Developer's Corner

diff --git a/deal.II/doc/development/toc.html b/deal.II/doc/developers/toc.html similarity index 60% rename from deal.II/doc/development/toc.html rename to deal.II/doc/developers/toc.html index 72d76a8232..1f45fbe1f1 100644 --- a/deal.II/doc/development/toc.html +++ b/deal.II/doc/developers/toc.html @@ -14,41 +14,18 @@ -

Information on development with deal.II

- Apart from the online API references (the "manual") and the tutorial, - which are covered elsewhere, this page gathers some information on - developing programs based on - deal.II, as well as on how to contribute - to the development of deal.II itself. In the - latter case, we encourage you to use the current development version - instead of a pre-packaged version of deal.II, as - described on our download page. +
+ This page provides documentation for deal.II developers. At present, we + have the following resources available:

- At present, we have the following resources available: -

Documentation

Documentation of the SVN Archive and information on recent changes to the library. -
- deal.II CMake documentation: - This page provides extensive information about configuration and - installation with the CMake build system. - -
Using CMake and - deal.II in a user project: - This page covers how to use CMake in your own project. - An overview of how to retrieve necessary information - from a deal.II installation as well as how to - write a CMakeLists.txt for a client project is given. -
-
Build system internals: This page provides implementation and development details about @@ -77,33 +54,22 @@ resource gives some hints for porting to unknown platforms.
-
Bugs: - Though well tested, deal.II certainly has - bugs. If you want to report a bug (or enhancement request), - go to the bug tracking system and enter a new ticket - for your issue. -
- -
Linking your online documentation - to the deal.II online manual: After spending a lot of time - writing good documentation for your code and putting it online, - here we explain how to put links to the deal.II online manual into - your documentation, so that readers can click through. -
+
Coding conventions: We try to adhere to a + set of coding conventions to ensure that the use of different + parts of the library is as uniform as possible. Please read + through them if you think about contributing code.
Running the testsuite: deal.II has a testsuite that we run to make sure that our tests don't break any existing functionality. This page explains its use.
+

Coding conventions: We try to adhere to a - set of coding conventions to ensure that the use of different - parts of the library is as uniform as possible. Please read - through them if you think about contributing code. +

Resources

Results of regression tests: Every night, @@ -123,17 +89,17 @@

- +

- The deal.II Group

- -

+ The deal.II Authors + $Date$ + +

+ +

diff --git a/deal.II/doc/development/writing-documentation.html b/deal.II/doc/developers/writing-documentation.html similarity index 97% rename from deal.II/doc/development/writing-documentation.html rename to deal.II/doc/developers/writing-documentation.html index e9b037dffd..ab4913a3c3 100644 --- a/deal.II/doc/development/writing-documentation.html +++ b/deal.II/doc/developers/writing-documentation.html @@ -455,17 +455,17 @@

- +

- The deal.II Group

- -

+ The deal.II Authors + $Date$ + +

+ +

diff --git a/deal.II/doc/documentation.html b/deal.II/doc/documentation.html index 10620b4c56..bfb9733741 100644 --- a/deal.II/doc/documentation.html +++ b/deal.II/doc/documentation.html @@ -13,21 +13,8 @@ -

Online documentation

- -

ReadMe
Tutorials
Programming interface
Development information
Reports
Publications
Copyright and licence

+
deal.II comes with quite extensive online documentation, which falls into several categories. They are listed below. @@ -36,208 +23,76 @@

ReadMe

- First, there is the README file of + First, there is the README of the library. It gives information on system requirements, installation, and copyright.

Tutorials

- The tutorial 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. You can also reach the tutorial link from the menu bar - at the left. -

User's Corner

- Note that along with the rest of the documentation, the local HTML pages - of the tutorials need to be generated first. Please follow the - instructions in the - ReadMe file on how to do - this. + The User's Corner provides information about + configuration and usage of the library.

Programming interface

- The programming - interface/manual 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 more than 5000 pages if - printed), and generated by Doxygen. There is also a quick link to these pages from - the menu bar at the left. -

Developer's Corner

- The documentation uses many of the features of Doxygen. In particular, - the link takes you straight to a page that lists modules, 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. + The Developer's Corner covers + topics for advanced users and developers.

- Just as for the tutorials, the API docs need to be generated first, - if you download deal.II. Please follow the - instructions in the - ReadMe file on how to do - this. -

- - -

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

There are a number of papers that describe the overall design or individual aspects of deal.II. Please refer to the papers listed at the top of the publications page for full references. In addition, - there are the following reports: -

-
- A publication on the - basics of dimension independent - programming in deal.II (by Wolfgang - Bangerth). This explains some of the fundamentals of the - library's design, though rather briefly due to the page - limit imposed for the publication. -
- -
- This publication appeared in - the proceedings of the 16th IMACS World Congress, - Lausanne, Switzerland, 2000. See the - publications - page for the full reference as well as a way to obtain a - reprint of the original paper as a postscript or PDF file. -
-
- A brief report about the classes involved in the - iterators and accessors - 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. You may want to - read this object or parts of it if you want to know what - information is available from iterators (by Wolfgang - Bangerth). -
- A brief report on mapping functions of higher polynomial - degrees (by Ralf Hartmann). These allow the realisation - of higher order boundary approximations. This report - gives the theoretical background of the - MappingQ class. -
- A report on - assembling matrices (by Wolfgang - Bangerth). This report looks in particular at how - matrices are assembled for vector-valued problems, and - how things change if vector-valued finite elements are - used for which the shape functions have more than one - non-zero vector component, such as Nedelec or - Raviart-Thomas elements. There are printable - versions of the report - in postscript and - PDF format. -
- A very detailed report on - Nedelec elements (by Anna - Schneebeli, University of Basel, Switzerland). It - explains the construction and application of Nedelec - edge elements for H-curl spaces, as used, for example, - in the numerical solution of the Maxwell equations. It - also gives numerical results obtained with deal.II. - There is also a postscript version of the report. -
- A report on the - codimension one capabilities of the library - (by Antonio DeSimone, Luca Heltai and Cataldo Manigrasso, - SISSA, Trieste, Italy). It explains in detail how to use the - library for the solution of problems defined on codimension - one manifolds, such as, for example, Boundary Element - Methods. -

- - -

Publications

- -

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

- - -

Copyright and License

- -

- deal.II is copyright of the - deal.II authors. It is - a joint effort of the current maintainers, Wolfgang Bangerth, - Timo Heister, Guido Kanschat, and quite a number of - contributors. deal.II is distributed under - an - OpenSource - license. The full text of the license can be found in - license.html. -

- -

Contact

- -

We have a discussion group for discussion - of issues of general interest to users and developers of - deal.II.

- -

More specific questions may be sent to the authors - immediately at the address firstName.lastname at - dealii.org.

- -

+ +

Publications

+ +

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

+ +

+ The deal.II Authors + $Date$ +

+ +

+ diff --git a/deal.II/doc/license.html b/deal.II/doc/license.html index 0073a3b452..dac21d73d7 100644 --- a/deal.II/doc/license.html +++ b/deal.II/doc/license.html @@ -44,13 +44,13 @@ In this document, as well as in the program files, the terms authors of deal.II and deal.II authors generally refer to all - people mentioned at the deal.II Credits + people mentioned at the deal.II Authors page. These are the maintainers Wolfgang Bangerth, Timo Heister, and Guido Kanschat and a long list of contributors.

Contributions

As a contributor to this project, you agree that any of your @@ -66,7 +66,7 @@

-
Referencing the library
+
Referencing the library

In addition to the terms imposed by the LGPL v2.1 or later, we ask @@ -89,9 +89,8 @@
- -
Parts of the deal.II distribution under a separate license
- + +
Parts of the deal.II distribution under a separate license

deal.II comes bundled with copies of @@ -123,15 +122,12 @@
-
Contact
+
Contact

For further questions regarding licensing and commercial use please contact the deal.II maintainers directly via one of the following mail addresses:
-
- TODO -

Wolfgang Bangerth < bangerth@gmail.com >
@@ -146,7 +142,7 @@ -
Full license text
+
Full license text

@@ -654,18 +650,17 @@ That's all there is to it!
-
- +

- The deal.II authors + The deal.II Authors + $Date$
-
-
- -
+ + + +
+ diff --git a/deal.II/doc/mail.html b/deal.II/doc/mail.html index 7e69fbb4bb..6c05773ff5 100644 --- a/deal.II/doc/mail.html +++ b/deal.II/doc/mail.html @@ -67,12 +67,10 @@
Authors
+
Everything you consider a personal matter between you and the authors (like - flaming them on missing items) should be sent to one of + flaming them on missing items) should be sent to one of the maintainers
-
- TODO -

Wolfgang Bangerth < bangerth@gmail.com >
@@ -85,18 +83,20 @@
Everything, that is not directly related to the library is to be considered personal in this respect!
+
-
+

- The deal.II Group + The deal.II Authors + $Date$

-
- -
+ + + +
+ diff --git a/deal.II/doc/navbar.html b/deal.II/doc/navbar.html index 698b4cc17d..6f1206eeb0 100644 --- a/deal.II/doc/navbar.html +++ b/deal.II/doc/navbar.html @@ -20,10 +20,13 @@
README
- + User's Corner
+ Developer's Corner

+
+ Doxygen
Tutorial
Manual
@@ -33,6 +36,7 @@
+ Resources
FAQ
News
@@ -44,14 +48,14 @@
+ Documentation
- Development
+ Reports
Publications
Authors
- License + License
+ Contact
- - diff --git a/deal.II/doc/publications/index.html b/deal.II/doc/publications/index.html index 6630cc3ca3..a6f8f87f8c 100644 --- a/deal.II/doc/publications/index.html +++ b/deal.II/doc/publications/index.html @@ -5013,10 +5013,16 @@ A Goal Oriented Software Library for Solving PDEs and Optimization Problems with -
- -
- The deal.II Group
+
+
+ The deal.II Authors +
+
+ + + + +
diff --git a/deal.II/doc/readme.html b/deal.II/doc/readme.html index 6bec165b65..5c7ec6dc50 100644 --- a/deal.II/doc/readme.html +++ b/deal.II/doc/readme.html @@ -878,18 +878,17 @@
-
- -
- The deal.II Group - $Date$ -
-
- - - -
+
+
+ The deal.II Authors + $Date$ +
+
+ + + + +
+ diff --git a/deal.II/doc/reports/index.html b/deal.II/doc/reports/index.html new file mode 100644 index 0000000000..e08c31a79c --- /dev/null +++ b/deal.II/doc/reports/index.html @@ -0,0 +1,120 @@ + + + + The deal.II Online Documentation + + + + + + + + + + +
Reports
+ +
+ There are a number of papers that describe the overall design or + individual aspects of deal.II. Please refer to the + papers listed at the top of the publications page for full references. In addition, + there are the following reports: +
+
+
+ A publication on the + basics of dimension independent + programming in deal.II (by Wolfgang + Bangerth). This explains some of the fundamentals of the + library's design, though rather briefly due to the page + limit imposed for the publication. +
+ +
+ This publication appeared in + the proceedings of the 16th IMACS World Congress, + Lausanne, Switzerland, 2000. See the + publications + page for the full reference as well as a way to obtain a + reprint of the original paper as a postscript or PDF file. +
+
+ +
+ A brief report about the classes involved in the + iterators and accessors + 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. You may want to + read this object or parts of it if you want to know what + information is available from iterators (by Wolfgang + Bangerth). +
+ +
+ A brief report on mapping functions of higher polynomial + degrees (by Ralf Hartmann). These allow the realisation + of higher order boundary approximations. This report + gives the theoretical background of the + MappingQ class. +
+ +
+ A report on + assembling matrices (by Wolfgang + Bangerth). This report looks in particular at how + matrices are assembled for vector-valued problems, and + how things change if vector-valued finite elements are + used for which the shape functions have more than one + non-zero vector component, such as Nedelec or + Raviart-Thomas elements. There are printable + versions of the report + in postscript and + PDF format. +
+ +
+ A very detailed report on + Nedelec elements (by Anna + Schneebeli, University of Basel, Switzerland). It + explains the construction and application of Nedelec + edge elements for H-curl spaces, as used, for example, + in the numerical solution of the Maxwell equations. It + also gives numerical results obtained with deal.II. + There is also a postscript version of the report. +
+ +
+ A report on the + codimension one capabilities of the library + (by Antonio DeSimone, Luca Heltai and Cataldo Manigrasso, + SISSA, Trieste, Italy). It explains in detail how to use the + library for the solution of problems defined on codimension + one manifolds, such as, for example, Boundary Element + Methods. +
+
+ +
+
+ The deal.II Authors +
+
+ + + + +
+ + diff --git a/deal.II/doc/screen.css b/deal.II/doc/screen.css index f41edfa72e..51bfd69bac 100644 --- a/deal.II/doc/screen.css +++ b/deal.II/doc/screen.css @@ -46,6 +46,23 @@ div.toc:before { font-weight: bold; } +div.quick { + width: 30%; + color: black; + border: 1px solid #aaa; + background-color: #f9f9f9; + padding: 5px; + font-size: 88%; +} + +div.quick:before { + display: block; + content: "Quick links"; + text-align: center; + font-size: 88%; + font-weight: bold; +} + frameset { background-color: white; border-color: black; diff --git a/deal.II/doc/development/CMakeLists.txt.sample b/deal.II/doc/users/CMakeLists.txt.sample similarity index 100% rename from deal.II/doc/development/CMakeLists.txt.sample rename to deal.II/doc/users/CMakeLists.txt.sample diff --git a/deal.II/doc/development/CMakeLists.txt.sample2 b/deal.II/doc/users/CMakeLists.txt.sample2 similarity index 100% rename from deal.II/doc/development/CMakeLists.txt.sample2 rename to deal.II/doc/users/CMakeLists.txt.sample2 diff --git a/deal.II/doc/development/CMakeLists.txt.sample3 b/deal.II/doc/users/CMakeLists.txt.sample3 similarity index 100% rename from deal.II/doc/development/CMakeLists.txt.sample3 rename to deal.II/doc/users/CMakeLists.txt.sample3 diff --git a/deal.II/doc/development/Config.sample b/deal.II/doc/users/Config.sample similarity index 100% rename from deal.II/doc/development/Config.sample rename to deal.II/doc/users/Config.sample diff --git a/deal.II/doc/development/cmake.html b/deal.II/doc/users/cmake.html similarity index 98% rename from deal.II/doc/development/cmake.html rename to deal.II/doc/users/cmake.html index 208e2617b7..5524e0eda8 100644 --- a/deal.II/doc/development/cmake.html +++ b/deal.II/doc/users/cmake.html @@ -819,12 +819,17 @@ will be installed, see this section.
- -
- +

- The deal.II Group + The deal.II Authors $Date$
+
+ + + + +
+ diff --git a/deal.II/doc/development/cmakelists.html b/deal.II/doc/users/cmakelists.html similarity index 98% rename from deal.II/doc/development/cmakelists.html rename to deal.II/doc/users/cmakelists.html index 815852c8dd..60e5b260f4 100644 --- a/deal.II/doc/development/cmakelists.html +++ b/deal.II/doc/users/cmakelists.html @@ -847,13 +847,17 @@ DEAL_II_WITH_ZLIB deal.II was installed to).
- - -
- +

- The deal.II Group + The deal.II Authors $Date$
+
+ + + + +
+ diff --git a/deal.II/doc/development/doxygen.html b/deal.II/doc/users/doxygen.html similarity index 80% rename from deal.II/doc/development/doxygen.html rename to deal.II/doc/users/doxygen.html index ff8d4f55d1..b9c70b428f 100644 --- a/deal.II/doc/development/doxygen.html +++ b/deal.II/doc/users/doxygen.html @@ -49,11 +49,17 @@ TAGFILES = deal.tag=http://www.dealii.org/X.Y.Z/doxygen/deal.II

-
- +

- The deal.II Group
- + The deal.II Authors + $Date$ + +
+ + + + +
diff --git a/deal.II/doc/users/index.html b/deal.II/doc/users/index.html new file mode 100644 index 0000000000..de8bad7977 --- /dev/null +++ b/deal.II/doc/users/index.html @@ -0,0 +1,34 @@ + + + + + deal.II Development Information + + + + + + + + + + + + + + + + + + + + + + + diff --git a/deal.II/doc/users/navbar.html b/deal.II/doc/users/navbar.html new file mode 100644 index 0000000000..dfc3c1febd --- /dev/null +++ b/deal.II/doc/users/navbar.html @@ -0,0 +1,62 @@ + + + + + deal.II Development Navigation Bar + + + + + + + + + +
+ http://www.dealii.org
+ Home
+
+ +
+ +
+ README
+ User's Corner
+ Developer's Corner
+
+ +
+ + Documentation + +
+ CMake documentation
+ CMake in user projects
+ Linking manuals
+
+ +
+ + Doxygen +
+ Tutorial
+ Manual
+ Video lectures
+
+ +
+ + Resources +
+ FAQ
+ News
+ Download
+ Mailing list
+ Wiki
+ Bug tracker
+
+ + + diff --git a/deal.II/doc/users/title.html b/deal.II/doc/users/title.html new file mode 100644 index 0000000000..8249f23359 --- /dev/null +++ b/deal.II/doc/users/title.html @@ -0,0 +1,31 @@ + + + + + deal.II Tutorial + + + + + + + + + + +
+
+ User's Corner +
+
+ + + + + + + + + + diff --git a/deal.II/doc/users/toc.html b/deal.II/doc/users/toc.html new file mode 100644 index 0000000000..98549a0090 --- /dev/null +++ b/deal.II/doc/users/toc.html @@ -0,0 +1,125 @@ + + + + + The deal.II Development Page + + + + + + + + + + +
+
+ This page gathers some information on developing programs based on + deal.II, as well as on how to configure and use + deal.II. At present, we have the following resources + available: +
+ + +
Documentation
+ +
+ +

+ deal.II CMake documentation: + This page provides extensive information about configuration and + installation with the CMake build system. + +

Using CMake and + deal.II in a user project: + This page covers how to use CMake in your own project. + An overview of how to retrieve necessary information + from a deal.II installation as well as how to + write a CMakeLists.txt for a client project is given. +
+ +

Linking your online documentation + to the deal.II online manual: After spending a lot of time + writing good documentation for your code and putting it online, + here we explain how to put links to the deal.II online manual into + your documentation, so that readers can click through. +
+ +

Bugs: + Though well tested, deal.II certainly has + bugs. If you want to report a bug (or enhancement request), + go to the bug tracking system and enter a new ticket + for your issue. +
+ +
+ + +
Tutorials
+ +
+ The tutorial 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. You can also reach the tutorial link from the menu bar + at the left. +
+ +
+ Note that along with the rest of the documentation, the local HTML pages + of the tutorials need to be generated first. Please follow the + instructions in the + ReadMe on how to do + this. +
+ + +
Programming interface
+ +
+ The programming + interface/manual 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 more than 5000 pages if + printed), and generated by Doxygen. There is also a quick link to these pages from + the menu bar at the left. +
+ +
+ The documentation uses many of the features of Doxygen. In particular, + the link takes you straight to a page that lists modules, 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. +
+ +
+ Just as for the tutorials, the API docs need to be generated first, + if you download deal.II. Please follow the + instructions in the + ReadMe on how to do + this. +
+ +
+
+ The deal.II Authors + $Date$ +
+
+ + + + +
+ + + -- 2.39.5