From 9b7f4675856163bec1faf3710110518bb137021e Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Fri, 13 Jan 2006 23:09:53 +0000 Subject: [PATCH] Restructure the documentation page: only one link to the reference manual. git-svn-id: https://svn.dealii.org/trunk@12014 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/doc/documentation.html | 41 +++++++++++++++++----------------- deal.II/doc/navbar.html | 5 +---- 2 files changed, 22 insertions(+), 24 deletions(-) diff --git a/deal.II/doc/documentation.html b/deal.II/doc/documentation.html index 9db9ab4f66..2cd9adf46c 100644 --- a/deal.II/doc/documentation.html +++ b/deal.II/doc/documentation.html @@ -33,10 +33,11 @@

The tutorial: + target="_top">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. + example programs. You can also reach the tutorial link from the menu bar + at the left.

@@ -51,25 +52,25 @@

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: + 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 approximately 3000 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, diff --git a/deal.II/doc/navbar.html b/deal.II/doc/navbar.html index f34915087c..763f1836a1 100644 --- a/deal.II/doc/navbar.html +++ b/deal.II/doc/navbar.html @@ -25,7 +25,6 @@ Download
Mailing list
-
Wiki

@@ -33,9 +32,7 @@

Tutorial
- Reference
- /base API
- /lac API + Manual


-- 2.39.5