From 04b7870470e0c1a7665987a7e88f1d3c1f092068 Mon Sep 17 00:00:00 2001 From: kanschat Date: Sun, 20 Jun 2010 17:12:12 +0000 Subject: [PATCH] add tooltips git-svn-id: https://svn.dealii.org/trunk@21232 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/doc/doxygen/tutorial/make_toc.pl | 20 ++++++++++++++++++++ deal.II/doc/doxygen/tutorial/toc.html.in | 3 +-- deal.II/examples/step-1/doc/tooltip | 1 + deal.II/examples/step-12/doc/tooltip | 1 + deal.II/examples/step-2/doc/tooltip | 1 + deal.II/examples/step-3/doc/tooltip | 1 + deal.II/examples/step-39/doc/tooltip | 1 + deal.II/examples/step-4/doc/tooltip | 1 + deal.II/examples/step-5/doc/tooltip | 1 + deal.II/examples/step-6/doc/tooltip | 1 + 10 files changed, 29 insertions(+), 2 deletions(-) create mode 100644 deal.II/examples/step-1/doc/tooltip create mode 100644 deal.II/examples/step-12/doc/tooltip create mode 100644 deal.II/examples/step-2/doc/tooltip create mode 100644 deal.II/examples/step-3/doc/tooltip create mode 100644 deal.II/examples/step-39/doc/tooltip create mode 100644 deal.II/examples/step-4/doc/tooltip create mode 100644 deal.II/examples/step-5/doc/tooltip create mode 100644 deal.II/examples/step-6/doc/tooltip diff --git a/deal.II/doc/doxygen/tutorial/make_toc.pl b/deal.II/doc/doxygen/tutorial/make_toc.pl index 299da29717..8a8a68381a 100644 --- a/deal.II/doc/doxygen/tutorial/make_toc.pl +++ b/deal.II/doc/doxygen/tutorial/make_toc.pl @@ -4,14 +4,34 @@ $/ = undef; +# Read source for web page open TOC, "; close TOC; +# Read generated map file open MAP, "; close MAP; +# Insert contents of map file for @@MAP@@ $toc =~ s/\@\@MAP\@\@/$map/; +# Find tooltip files +$list = `ls ../../../examples/step-*/doc/tooltip`; +@list = split "\n", $list; + +foreach (@list) +{ + # Only the first line of the tooltip file is used + open TF, "<$_"; + $tooltip = ; + close TF; + chop $tooltip; + + m/step-(\d+)/; + $n = $1; + $toc =~ s/\@step$n\@/$tooltip/; +} + print $toc; diff --git a/deal.II/doc/doxygen/tutorial/toc.html.in b/deal.II/doc/doxygen/tutorial/toc.html.in index f9f9a651a8..ed8327161a 100644 --- a/deal.II/doc/doxygen/tutorial/toc.html.in +++ b/deal.II/doc/doxygen/tutorial/toc.html.in @@ -152,8 +152,7 @@ the geodynamics Step-12 - General framework for - discontinuous Galerkin methods. Use of Timer class. + Discontinuous Galerkin methods for linear advection problems. diff --git a/deal.II/examples/step-1/doc/tooltip b/deal.II/examples/step-1/doc/tooltip new file mode 100644 index 0000000000..e95a3ac5e1 --- /dev/null +++ b/deal.II/examples/step-1/doc/tooltip @@ -0,0 +1 @@ +Create a grid. Refine it. Write it to a file diff --git a/deal.II/examples/step-12/doc/tooltip b/deal.II/examples/step-12/doc/tooltip new file mode 100644 index 0000000000..273cc08f95 --- /dev/null +++ b/deal.II/examples/step-12/doc/tooltip @@ -0,0 +1 @@ +Discontinuous Galerkin for linear advection. diff --git a/deal.II/examples/step-2/doc/tooltip b/deal.II/examples/step-2/doc/tooltip new file mode 100644 index 0000000000..0a64bd8113 --- /dev/null +++ b/deal.II/examples/step-2/doc/tooltip @@ -0,0 +1 @@ +Assign degrees of freedom to a grid. diff --git a/deal.II/examples/step-3/doc/tooltip b/deal.II/examples/step-3/doc/tooltip new file mode 100644 index 0000000000..608c905a72 --- /dev/null +++ b/deal.II/examples/step-3/doc/tooltip @@ -0,0 +1 @@ +Solve Poisson's equation diff --git a/deal.II/examples/step-39/doc/tooltip b/deal.II/examples/step-39/doc/tooltip new file mode 100644 index 0000000000..3287d43901 --- /dev/null +++ b/deal.II/examples/step-39/doc/tooltip @@ -0,0 +1 @@ +Interior Penalty for Laplacian. Adaptive refinement. Multigrid. diff --git a/deal.II/examples/step-4/doc/tooltip b/deal.II/examples/step-4/doc/tooltip new file mode 100644 index 0000000000..1f94394802 --- /dev/null +++ b/deal.II/examples/step-4/doc/tooltip @@ -0,0 +1 @@ +Dimension independent programming. Boundary conditions. diff --git a/deal.II/examples/step-5/doc/tooltip b/deal.II/examples/step-5/doc/tooltip new file mode 100644 index 0000000000..4f09ebdbd7 --- /dev/null +++ b/deal.II/examples/step-5/doc/tooltip @@ -0,0 +1 @@ +Reading a grid from disk. Computations on successively refined grids. diff --git a/deal.II/examples/step-6/doc/tooltip b/deal.II/examples/step-6/doc/tooltip new file mode 100644 index 0000000000..00262bfbfb --- /dev/null +++ b/deal.II/examples/step-6/doc/tooltip @@ -0,0 +1 @@ +Adaptive local refinement. Higher order elements. \ No newline at end of file -- 2.39.5