README file for Infodoc project archive.
Copyright 2014-2020 by The Software Samurai
on the web:  http://www.SoftwareSam.us/
Software released under GPL3+, and documentation released under FDL1.3+
=======================================================================

Unpack this archive into a clean directory using:
                tar -xjvf infodoc-styles-x.x.xx.tar.bz2

This package provides CSS Style for HTML documents created by the 
Texinfo/makeinfo documentation engine, version 6.1 and above.

      IMPORTANT NOTE:
      For HTML documents created with makeinfo 6.0 and earlier,
      please use Infodoc version 0.0.07.

The HTML output generated from Texinfo souce is certainly readable and can be 
used without modification, but it was never intended to represent stylish 
formatting. Applying the style definitions in infodoc-styles.css will beautify 
the HTML output, AND will give you full control of each of the CSS class 
definitions (referenced, but not meaningfully defined) in the raw HTML 
output.

  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -
This package contains a CSS (Cascading Style Sheet) style definition file, 
HTML post-processing utility, and full documentation for applying these style 
definitions to your HTML documents. The documentation also serves as a 
comprehensive test suite for both the Texinfo texi-to-HTML converter AND for 
the Infodoc Post Processor utility.

The directory tree of files included in this Infodoc release is organized 
as follows:

Infodoc/
   /infodoc-styles.css    // CSS (Cascading Style Sheet) definition file
   /infodoc*.texi         // Project documentation and test suite source
                          // (one source file per chapter)
   /texi_macros.texi      // Useful macro definitions for Texinfo source
   /same_author.texi      // List of other projects by the same author
   /gpl-3.0.texi          // GNU GPL license, sub-document
   /fdl-1.3.texi          // GNU FDL license, sub-document
   /Makefile              // Make file for generating 'info' and HTML output
   /infodoc.info          // Info-format document generated from infodoc*.texi
   /infodoc.html          // HTML-format document generated from infodoc*.texi
   /infodoc_css.html      // infodoc.html after post-processing for style
   /applycss              // Shell script for invoking 'idpp' to apply CSS
                          // style to the HTML document
   /apply_response.txt    // Response file for interactive processing
                          // (responds to 'idpp' queries)

   /idpp/                 // directory containing Infodoc Post Processor
      /gString.hpp        // gString class definition
      /gString.cpp        // gString class methods (text parsing and formatting)
      /idpp.hpp           // Idpp class definition and misc. definitions/data
      /idpp.cpp           // Main application methods
      /idpp_file.hpp      // Definitions for access to source and target files
      /idpp_file.cpp      // Methods for read/write/verify of files
      /Makefile           // Make file for building 'idpp'

   /VERSION_HISTORY       // Project change log
   /README                // Package description, release notes (this file)


To read the full Texinfo documentation for this package, type: 
                   info -f infodoc.info
or even better, open the 'infodoc_css.html' file in your favorite browser.

The procedure and options for applying CSS style to your raw HTML output can 
be found in the chapter, 'Infodoc Post-processor'

  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -
NOTES on the current release of the Infodoc project:

-- The CSS style definitions in 'infodoc-styles.css' are the base of this 
   project. 
   -- These definitions transform the formatting of your HTML documents 
      generated from Texinfo source.
   -- 'infodoc-styles.css' contains robust definitions and re-definitions for 
       all aspects of your Texinfo-generated HTML document.
   -- No outstanding problems have been identified.
   -- See VERSION_HISTORY for updates made for this release.

-- 'idpp', Infodoc Post Processor
   -- The 'idpp' application must be compiled before use.
      Please see the chapter 'Build idpp from source' for instructions on 
      compiling 'idpp' from source.
   -- The Infodoc HTML post-processing application (v:0.0.10 and higher) was 
      substantially rewritten to support major updates made in the 
      makeinfo/texi2any utilities which are distributed with the Texinfo 
      development package.
      -- If you are using a version of makeinfo that is older that v:6.1, please 
         download the legacy version of the Infodoc package v:0.0.07.
   -- Most updates included in the current release address issues related to 
      running 'idpp' on a source file which has already received post-processing.
      While a second pass on a source file is _possible_ under most circumstances, 
      it is recommended that all post-processing be done in a single pass.
      Please see notes in VERSION_HISTORY for further details.
   -- The current release includes a few bug fixes and a documentation update.
   -- 'idpp' has been built and tested only on Wintel hardware; however, our 
      code is intentionally generic, using no third-party libraries, so we would 
      anticipate few problems when building on other platforms that use the GNU 
      compiler. If you are building for ARM or other platforms, please send a 
      note on your experiences.

   -- Known bugs and other issues:
      -- The 'makeinfo' utility documents a large number of build options and 
         seldom-used 'customization variables' which can affect the HTML output. 
         We have not yet tested all of these options with the 'idpp' post processor. 
         Some of these options generate HTML markup that 'idpp' may not be able 
         to parse correctly; however, when using the default values for all of 
         these options, 'idpp' works smoothly.
         For some of these options, the texi-to-HTML converter calls out special 
         class names, none of which are currently defined, meaning that the 
         browser defaults are used for these constructs.
         Please see the chapter 'Texinfo Build Options' in the 'idpp' 
         documentation for details.
      -- The '--css_mods' option is not yet fully implemented.
         Because manual modification of the CSS whole-document definitions is 
         straightforward, we have postponed implementation of this option.

  **-------------------------------------------------------------------------**
    Many thanks to the Texinfo development team for their quick responses to 
    various makeinfo/texi2any bugs and logical inconsistencies uncovered 
    during development of the Infodoc project. 
  **-------------------------------------------------------------------------**

