]> git.donarmstrong.com Git - lilypond.git/commitdiff
Add comments to lilypond-texi2html.init
authorCarl Peterson <carlopeterson@gmail.com>
Thu, 12 Dec 2013 06:08:57 +0000 (01:08 -0500)
committerDavid Kastrup <dak@gnu.org>
Sat, 21 Dec 2013 06:16:18 +0000 (07:16 +0100)
Adding inline comments to lilypond-texi2html.init to explain the added lines of code in the file to enable the manual-specific CSS styling.

Also cleaned up the code indentation levels.

Documentation/lilypond-texi2html.init

index fbd7f1425b78f4dfcd8ded34037506795d39c5ef..b8b1f511f8491bdbaaa80ac9b808a2d36e5ca45b 100644 (file)
@@ -1095,11 +1095,23 @@ sub lilypond_css_lines ($$)
     }
   }
 
-my ($docu_dir, $docu_name) = split_texi_filename ($Texi2HTML::THISDOC{'input_file_name'});
-
-$documentstatus = 'devStatus';
-
-$Texi2HTML::Config::BODYTEXT = 'lang="' . $Texi2HTML::THISDOC{current_lang} . '" class="' . $docu_name . ' ' . $documentstatus . '"';
+  ## This section makes the manual name visible to CSS through the body tag
+  ## so that styles can be applied per manual. It will add the manual
+  ## directory name (e.g., 'notation' or 'learning') as a CSS class, as well
+  ## as a development status.
+
+  # Parse the input file name to determine the manual we're dealing with.
+  my ($docu_dir, $docu_name) = split_texi_filename ($Texi2HTML::THISDOC{'input_file_name'});
+
+  # Hard-coded value to indicate if this is a development version
+  # ('devStatus') or stable version ('stableStatus')
+  # TODO: Figure out how to automatically set this value based on the even/odd minor revision number or some other mechanism.
+  $documentstatus = 'devStatus';
+
+  # Create the extra information for the <body> tag.
+  # For example, the development Notation reference in English
+  # will output in HTML as <body lang='en' class='notation devStatus'>
+  $Texi2HTML::Config::BODYTEXT = 'lang="' . $Texi2HTML::THISDOC{current_lang} . '" class="' . $docu_name . ' ' . $documentstatus . '"';
 
 }