From: Wolfgang Bangerth <bangerth@colostate.edu>
Date: Sun, 29 Mar 2020 17:15:04 +0000 (-0600)
Subject: Further try and disentangle the tutorial graph a bit.
X-Git-Tag: v9.2.0-rc1~328^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=cda6e74ec336957a7066890570000fee853230da;p=dealii.git

Further try and disentangle the tutorial graph a bit.
---

diff --git a/doc/doxygen/scripts/steps.pl b/doc/doxygen/scripts/steps.pl
index c2266cfa3a..d476b1be8b 100644
--- a/doc/doxygen/scripts/steps.pl
+++ b/doc/doxygen/scripts/steps.pl
@@ -162,38 +162,70 @@ foreach $step (@ARGV)
     my $source;
     foreach $source (split ' ', $buildson) {
         $source =~ s/step-/Step/g;
-        print "  $source -> $destination";
-
-        my $edge_attributes = "";
-
-        # Determine the style of the arrow that connects
-        # the two nodes. If the two nodes are of the same
-        # kind, use the same color as the nodes as this makes
-        # reading the flow of the graph a bit easier. Furthermore,
-        # set the edge weight to 5 (instead of the default of 1)
-        # to try and keep programs of the same kind together. The
-        # exception is the "basic" tutorial programs: these are
-        # going to be connected by edges of weight 100, ensuring
-        # that they are all essentially aligned vertically.
-        if ($kind_map{$source} eq $kind_map{$destination})
+
+        # We want to treat the step-6 -> step-40 edge differently. If
+        # it is printed like any other edge, i.e., with step-40
+        # directly below step-6, then we end up with a tangle of lines
+        # because there are so many sub-graphs that originate from
+        # step-6 (with the next node at the same level as step-40) but
+        # where step-40 then feeds with a long line into one of the
+        # programs further down. It looks better if we place step-40 a
+        # couple of levels further down in the graph so that the
+        # higher up parts of the graph consists of the sequential
+        # programs and the lower-down parts to the parallel ones.
+        #
+        # The way to do this is to insert a few invisible nodes (with
+        # invisible edges) between step-6 and step-40.
+        if ($source eq "Step6" && $destination eq "Step40")
+        {
+            print "  Step40a [style=\"invis\"];";
+            print "  Step40b [style=\"invis\"];";
+            print "  Step40c [style=\"invis\"];";
+
+            print "  Step6 -> Step40a [style=\"invis\"];";
+            print "  Step40a -> Step40b [style=\"invis\"];";
+            print "  Step40b -> Step40c [style=\"invis\"];";
+            print "  Step40c -> Step40 [style=\"invis\"];";
+
+            print "  Step6 -> Step40 [weight=100,color=\"$colors{$kind_map{$source}}\"];";
+        }
+
+        # All other edges in the graph
+        else
         {
-            $edge_attributes = "color=\"$colors{$kind_map{$source}}\",";
-            if ($kind_map{$source} eq "basic")
+            print "  $source -> $destination";
+
+            my $edge_attributes = "";
+
+            # Determine the style of the arrow that connects
+            # the two nodes. If the two nodes are of the same
+            # kind, use the same color as the nodes as this makes
+            # reading the flow of the graph a bit easier. Furthermore,
+            # set the edge weight to 5 (instead of the default of 1)
+            # to try and keep programs of the same kind together. The
+            # exception is the "basic" tutorial programs: these are
+            # going to be connected by edges of weight 100, ensuring
+            # that they are all essentially aligned vertically.
+            if ($kind_map{$source} eq $kind_map{$destination})
             {
-                $edge_attributes .= "weight=100,";
+                $edge_attributes = "color=\"$colors{$kind_map{$source}}\",";
+                if ($kind_map{$source} eq "basic")
+                {
+                    $edge_attributes .= "weight=100,";
+                }
+                else
+                {
+                    $edge_attributes .= "weight=5,";
+                }
             }
-            else
+
+            # If the destination is a code gallery program, used a dashed line
+            if ($destination =~ /code_gallery/)
             {
-                $edge_attributes .= "weight=5,";
+                $edge_attributes .= "style=\"dashed\", arrowhead=\"empty\",";
             }
+            print " [$edge_attributes];\n";
         }
-
-        # If the destination is a code gallery program, used a dashed line
-        if ($destination =~ /code_gallery/)
-        {
-            $edge_attributes .= "style=\"dashed\", arrowhead=\"empty\",";
-        }
-        print " [$edge_attributes]\n";
     }
 }