]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
explain how to link documentation
authorkanschat <kanschat@0785d39b-7218-0410-832d-ea1e28bc413d>
Fri, 21 Sep 2012 08:15:35 +0000 (08:15 +0000)
committerkanschat <kanschat@0785d39b-7218-0410-832d-ea1e28bc413d>
Fri, 21 Sep 2012 08:15:35 +0000 (08:15 +0000)
git-svn-id: https://svn.dealii.org/trunk@26582 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/doc/development/doxygen.html [new file with mode: 0644]
deal.II/doc/development/navbar.html
deal.II/doc/development/toc.html
deal.II/doc/doxygen/headers/main.h

diff --git a/deal.II/doc/development/doxygen.html b/deal.II/doc/development/doxygen.html
new file mode 100644 (file)
index 0000000..c1a30cc
--- /dev/null
@@ -0,0 +1,58 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+                 "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+  <link href="../screen.css" rel="StyleSheet">
+  <title>deal.II Doxygen documentation</title>
+  <meta name="author" content="the deal.II authors <authors@dealii.org>">
+  <meta name="copyright" content="Copyright (C) 2012 by the deal.II authors">
+  <meta name="date" content="$Date: 2006-07-24 10:37:21 -0500 (Mon, 24 Jul 2006) $">
+  <meta name="svn_id" content="$Id: writing-documentation.html 13428 2006-07-24 15:37:21Z bangerth $">
+  <meta name="keywords" content="deal dealii finite elements fem triangulation">
+  <meta http-equiv="content-language" content="en">
+</head>
+<body>
+
+  <h1>Referencing the deal.II online documentation from your project</h1>
+  
+  <p>deal.II has an extensive reference documentation generated
+  by <a href="http://www.doxygen.org">Doxygen</a>. One of the many
+  features of Doxygen is, that all class names, function noames and so
+  on are cross-linked in the documentation, and a single click
+  suffices to jump to the documentation of an object.</p>
+
+  <p>When you write online documentation for your own code, it might
+  come pretty handy if you could provide links directly into the
+  deal.II documentation. And indeed, you can. Here is how:
+
+  <ol>
+    <li>Download the tag file for Doxygen. As of now, the link to the
+      tag file can be found on the main documentation page generated by
+      Doxygen, if the online documentation is available,
+      <a href="../doxygen/deal.II/index.html">here</a>. For older revisions,
+       links are provided here by revision number:
+       <a href="http://www.dealii.org/7.2.0/doxygen/deal.tag">7.2.0</a>,
+       <a href="http://www.dealii.org/7.1.0/doxygen/deal.tag">7.1.0</a>,
+       <a href="http://www.dealii.org/7.0.0/doxygen/deal.tag">7.0.0</a>.
+    </li>
+    <li>Once your <code>deal.tag</code> file is in a location where
+    Doxygen can find it, add the following linbe to your Doxygen
+    configuration file:
+      <pre>
+
+TAGFILES = deal.tag=http://www.dealii.org/X.Y.Z/doxygen/deal.II
+
+</pre>
+      where <code>X.Y.Z</code> refers to the release number for which
+      you downloaded the tag file.
+      </li>
+  </ol>
+
+    <hr>
+
+    <address>
+      <a href="../mail.html">The deal.II Group</a></address>
+
+
+</body>
+</html>
index 0bb28b059e93d4b56a89634e9a5327c274ca5b0c..08115b6d5293e9379859938a4418666f164af00b 100644 (file)
@@ -5,7 +5,7 @@
   <title>deal.II Development Navigation Bar</title>
   <link href="../screen.css" rel="StyleSheet">
   <meta name="author" content="the deal.II authors <authors@dealii.org>">
-  <meta name="copyright" content="Copyright (C) 1998, 1999, 2000, 2002, 2003, 2004, 2005, 2006, 2007, 2009, 2010 by the deal.II authors">
+  <meta name="copyright" content="Copyright (C) 1998, 1999, 2000, 2002, 2003, 2004, 2005, 2006, 2007, 2009, 2010, 2012 by the deal.II authors">
   <meta name="date" content="$Date$">
   <meta name="svn_id" content="$Id$">
   <meta http-equiv="content-language" content="en">
@@ -28,6 +28,7 @@
        target="body">Documentation</a><br />
     <a href="../porting.html" target="body">Porting</a><br />
     <a href="../doxygen/deal.II/CodingConventions.html" target="body">Coding conventions</a><br />
+    <a href="doxygen.html" target="body">Linking manuals</a><br />
   </p>
 
   <hr>
index f9d271739bc192e73fbb4f4cc7738e8a4a7edcab..fa26f7e3e2411d9fea9f8c79672365842c137bfc 100644 (file)
          target="_top">bug tracking system</a> and enter a new ticket
          for your issue.
         </p>
-
+      
+    <li> <p><a href="doxygen.html">Linking your online documentation
+         to the deal.II online manual</a>: 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.
+      </p>
+      
     <li> <p><a href="testsuite.html" target="body">Running the testsuite</a>:
          <acronym>deal.II</acronym> has a testsuite that we run to
          make sure that our tests don't break any existing
index 8bed63010daa412c682ba4af47e4f13254f352c4..5e02bab37e569a9369caf2693d5431e41bcaf16c 100644 (file)
@@ -2,7 +2,7 @@
 //    $Id$
 //    Version: $Name$
 //
-//    Copyright (C) 2006, 2007, 2010, 2011 by the deal.II authors
+//    Copyright (C) 2006, 2007, 2010, 2011, 2012 by the deal.II authors
 //
 //    This file is subject to QPL and may not be  distributed
 //    without copyright and license information. Please refer
  * the menu bar at the top of this page, and are also grouped into
  * modules of their own (see the <a href="modules.html">Modules linke</a>
  * at the top of this page).
+ *
+ * We provide the Doxygen tag file for those of you who would like to directly link the
+ * documentation of application programs to the deal.II online documentation. The tag file
+ * is at <a href="../deal.tag"><code>deal.tag</code></a>. For each release of deal.II,
+ * it resides in the directory right above the Doxygen reference documentation. In order
+ * to use the tag file, you have to download it into a place where Doxygen can find it.
+ * After that, find the key <code>TAGFILES</code> in your Doxygen options file and write something like
+ * <pre>
+ * TAGFILES = deal.tag=http://www.dealii.org/X.Y.Z/doxygen/deal.II
+ *</pre>
+ * where <code>X.Y.Z</code> refers to the release you want to link to. Be sure you use
+ * the matching tag file. In theorey, you can also link against the developing revisions
+ * of deal.II, but then you have to fear that your links may become invalid if
+ * the deal.II structure changes.
  */

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.