Forrest
  1. Forrest
  2. FOR-240

inital document2pod (Perl Plain Old Documentation) needs enhancement

    Details

    • Type: Bug Bug
    • Status: Resolved
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 0.6
    • Fix Version/s: 0.6
    • Component/s: Core operations
    • Labels:
      None

      Description

      Enhance the initial document2pod.xsl and sitemap. It currently handles lists, rudimentary tables, verbatim text. It is rough, but seems to work okay. It doesn't handle definition lists, notes and warnings (or nested tables, lists in tables, etc).

        Activity

        Hide
        Rick Tessner added a comment -
        src/core/context/skins/crust/xslt/html/document2html.xsl
        src/core/context/skins/tigris/xslt/html/document2html.xsl
                                                                                        
          Added <div> element markers for the podlink and txtlink. The txtlink is not yet implemented. However, it doesn't hurt having the marker and is simply included for future functionality.
                                                                                        
        src/core/context/skins/common/xslt/html/site2xhtml.xsl
                                                                                        
          Added handling of the disable-pod-link in a similar manner to the disable-pdf-link, etc by replacing the <div id='skinconf-podlik'> element placed by the document2html.xsl.
                                                                                        
          Preliminary handling of the disable-txt-link, but will not place any links in the transformed document since the proper XSLs for straight text handling are not there yet. Again, this is included for future functionality.
                                                                                        
        src/core/context/skins/common/xslt/text/document2pod.xsl
                                                                                        
          o Handle quoted paragraphs that are defined by <p class='quote'> elements.
          o Handle <note>, <warning> and <fixme> elements.
          o Handle <dl>, <dd> and <dt> (definition list elements)
          o Handle <code> and <code class='filename'> by transforming to C<> and
            F<> POD code respectively.
          o Better handling of <link>, <jump> and <fork> to POD format links
          o Handle <figure>, <img> and <icon> by including the @alt or @src if
            no @alt attribute defined.
          o Improved <table> handlling. No longer generates out.of.memory errors
            on nested tables.
          o Nested tables handled by a simple <xsl:value-of ...> for the cell in
            which the nested table appears.
                                                                                        
        src/core/context/resources/schema/dtd/skinconfig-v06-3.dtd
                                                                                        
          Added two elements: disable-txt-link and disable-pod-link.
                                                                                        
          Decided that since v0.6.3 is not yet part of a Forrest release, it was okay to simply add to this DTD rather than creating a 0.6.4 DTD.
                                                                                        
          NOTE: the disable-txt-link is included simply for future functionality and is not yet functional. Just including it so that once the functionality is there, we don't need to create another DTD to handle it.
                                                                                        
        src/core/fresh-site/src/documentation/skinconf.xml
                                                                                        
          Including the two new elements: disable-pod-link and disable-txt-link.
                                                                                        
          Again note that the disable-txt-link is not yet functional and is included to facilitate the future implementation of it.
                                                                                        
        src/core/fresh-site/src/documentation/content/xdocs/samples/sample.xml
        src/core/fresh-site/src/documentation/content/xdocs/samples/document-v13.xml
                                                                                        
          Included new section on "Sample Presentations". This section gives links to the document in HTML, PDF, XML, Text (not yet implemented) and POD.
                                                                                        
        Show
        Rick Tessner added a comment - src/core/context/skins/crust/xslt/html/document2html.xsl src/core/context/skins/tigris/xslt/html/document2html.xsl                                                                                    Added <div> element markers for the podlink and txtlink. The txtlink is not yet implemented. However, it doesn't hurt having the marker and is simply included for future functionality.                                                                                  src/core/context/skins/common/xslt/html/site2xhtml.xsl                                                                                    Added handling of the disable-pod-link in a similar manner to the disable-pdf-link, etc by replacing the <div id='skinconf-podlik'> element placed by the document2html.xsl.                                                                                    Preliminary handling of the disable-txt-link, but will not place any links in the transformed document since the proper XSLs for straight text handling are not there yet. Again, this is included for future functionality.                                                                                  src/core/context/skins/common/xslt/text/document2pod.xsl                                                                                    o Handle quoted paragraphs that are defined by <p class='quote'> elements.   o Handle <note>, <warning> and <fixme> elements.   o Handle <dl>, <dd> and <dt> (definition list elements)   o Handle <code> and <code class='filename'> by transforming to C<> and     F<> POD code respectively.   o Better handling of <link>, <jump> and <fork> to POD format links   o Handle <figure>, <img> and <icon> by including the @alt or @src if     no @alt attribute defined.   o Improved <table> handlling. No longer generates out.of.memory errors     on nested tables.   o Nested tables handled by a simple <xsl:value-of ...> for the cell in     which the nested table appears.                                                                                  src/core/context/resources/schema/dtd/skinconfig-v06-3.dtd                                                                                    Added two elements: disable-txt-link and disable-pod-link.                                                                                    Decided that since v0.6.3 is not yet part of a Forrest release, it was okay to simply add to this DTD rather than creating a 0.6.4 DTD.                                                                                    NOTE: the disable-txt-link is included simply for future functionality and is not yet functional. Just including it so that once the functionality is there, we don't need to create another DTD to handle it.                                                                                  src/core/fresh-site/src/documentation/skinconf.xml                                                                                    Including the two new elements: disable-pod-link and disable-txt-link.                                                                                    Again note that the disable-txt-link is not yet functional and is included to facilitate the future implementation of it.                                                                                  src/core/fresh-site/src/documentation/content/xdocs/samples/sample.xml src/core/fresh-site/src/documentation/content/xdocs/samples/document-v13.xml                                                                                    Included new section on "Sample Presentations". This section gives links to the document in HTML, PDF, XML, Text (not yet implemented) and POD.                                                                                 
        Hide
        Rick Tessner added a comment -
        src/core/context/skins/common/images/poddoc.svg.xslt
                                                                                        
          New file: Small graphic for the POD link.
        Show
        Rick Tessner added a comment - src/core/context/skins/common/images/poddoc.svg.xslt                                                                                    New file: Small graphic for the POD link.
        Hide
        David Crossley added a comment -
        Thanks. Added the j240-36481 patches. Left this issue open in case there are more changes. If not then we can close it.
        Show
        David Crossley added a comment - Thanks. Added the j240-36481 patches. Left this issue open in case there are more changes. If not then we can close it.

          People

          • Assignee:
            Unassigned
            Reporter:
            David Crossley
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development