Details

    • Type: Sub-task Sub-task
    • Status: Open
    • Priority: Major Major
    • Resolution: Unresolved
    • Affects Version/s: 0.9
    • Fix Version/s: 0.10-dev
    • Labels:
      None

      Description

      There are various documents that explain parts of the sitemaps. Some of these mention pathnames, some have actual fragments of code copied from sitemaps. All of this needs to be updated to reflect the current sitemaps.

      The sitemaps were recently updated to use locationmap, some sitemaps were simplified, filenames were changed, e.g. document2html.xsl to document-to-html.xsl

      These changes need to be reflected in the current docs.

        Activity

        Brian M Dube made changes -
        Fix Version/s 0.10 [ 12310092 ]
        Fix Version/s 0.9-dev [ 12310041 ]
        Hide
        Brian M Dube added a comment -
        I have less time for this than I thought. Pushing off.
        Show
        Brian M Dube added a comment - I have less time for this than I thought. Pushing off.
        Brian M Dube made changes -
        Assignee Brian M Dube [ brian ]
        Brian M Dube made changes -
        Parent FOR-874 [ 12332709 ]
        Issue Type Task [ 3 ] Sub-task [ 7 ]
        Brian M Dube made changes -
        Assignee Brian M Dube [ brian ]
        Hide
        Brian M Dube added a comment -
        Getting closer in r992179.
        Show
        Brian M Dube added a comment - Getting closer in r992179.
        Hide
        Tim Williams added a comment -
        sitemap-ref.xml is definitely not consistent with our current processing it seems to me (e.g. compare pdf output[1] to reality[2]. We could punt, of course, as Gav suggested, but this issue seems not resolved to me...
        --tim

        [1] - http://forrest.apache.org/docs_0_90/sitemap-ref.html#pdf
        [2] - http://svn.apache.org/viewvc/forrest/trunk/plugins/org.apache.forrest.plugin.output.pdf/output.xmap?revision=694215&view=co
        Show
        Tim Williams added a comment - sitemap-ref.xml is definitely not consistent with our current processing it seems to me (e.g. compare pdf output[1] to reality[2]. We could punt, of course, as Gav suggested, but this issue seems not resolved to me... --tim [1] - http://forrest.apache.org/docs_0_90/sitemap-ref.html#pdf [2] - http://svn.apache.org/viewvc/forrest/trunk/plugins/org.apache.forrest.plugin.output.pdf/output.xmap?revision=694215&view=co
        Hide
        Brian M Dube added a comment -
        The fragments in sitemap-ref.xml and howto-custom-html-source.xml look current to me now.

        forrest.xmap.html and sitemap.xmap.html (from a previous comment) are from Forrest 0.7, so I don't think these need anything.
        Show
        Brian M Dube added a comment - The fragments in sitemap-ref.xml and howto-custom-html-source.xml look current to me now. forrest.xmap.html and sitemap.xmap.html (from a previous comment) are from Forrest 0.7, so I don't think these need anything.
        Hide
        Gavin added a comment -
        I think we are going to have to keep your Warnings workaround in place and push to out to 0.10. I had a look but I don't think I could contribute to this effectively.
        Show
        Gavin added a comment - I think we are going to have to keep your Warnings workaround in place and push to out to 0.10. I had a look but I don't think I could contribute to this effectively.
        David Crossley made changes -
        Affects Version/s 0.9-dev [ 12310041 ]
        Affects Version/s 0.8 [ 12310040 ]
        Hide
        David Crossley added a comment -
        Fantastic, thanks. What sort of help do you need to get started?

        Are you comfortable with running forrest, and know that our docs are in $FORREST_HOME/site-author directory? Use head of our SVN trunk (i.e. 0.9-dev) and we concentrate on the top-level docs (site-author/content/xdocs) and the current dev version docs (site-author/content/xdocs/docs_0_90/) only.

        I suggest that you provide a smallish patch to one of them, so we can ensure your patch technique before doing anything major.

        Ask any general questions on the dev mail list. Thanks again.
        Show
        David Crossley added a comment - Fantastic, thanks. What sort of help do you need to get started? Are you comfortable with running forrest, and know that our docs are in $FORREST_HOME/site-author directory? Use head of our SVN trunk (i.e. 0.9-dev) and we concentrate on the top-level docs (site-author/content/xdocs) and the current dev version docs (site-author/content/xdocs/docs_0_90/) only. I suggest that you provide a smallish patch to one of them, so we can ensure your patch technique before doing anything major. Ask any general questions on the dev mail list. Thanks again.
        Hide
        Chris Maloney added a comment -
        If this is still considered open, I will try to do it. I've been studying Forrest and Cocoon a lot lately, and would like to lend a hand. I'd need somebody to help me get started, though.
        Show
        Chris Maloney added a comment - If this is still considered open, I will try to do it. I've been studying Forrest and Cocoon a lot lately, and would like to lend a hand. I'd need somebody to help me get started, though.
        David Crossley made changes -
        Field Original Value New Value
        Fix Version/s 0.8 [ 12310040 ]
        Fix Version/s 0.9-dev [ 12310041 ]
        Hide
        David Crossley added a comment -
        We don't seem to be able to encourage someone to update these documents, so added a workaround to enable the 0.8 release ... a warning that they are out-of-date.

        I used 'find and grep' to locate patterns "<map:" and investigated the docs. Some documents have generic snippets and so okay. Some are more explicit, so now have a warning. It is a pity because these are our main documents on the topic ...

        sitemap-ref.xml
        howto/howto-custom-html-source.xml
        howto/forrest.xmap.html
        howto/sitemap.xmap.html
        Show
        David Crossley added a comment - We don't seem to be able to encourage someone to update these documents, so added a workaround to enable the 0.8 release ... a warning that they are out-of-date. I used 'find and grep' to locate patterns "<map:" and investigated the docs. Some documents have generic snippets and so okay. Some are more explicit, so now have a warning. It is a pity because these are our main documents on the topic ... sitemap-ref.xml howto/howto-custom-html-source.xml howto/forrest.xmap.html howto/sitemap.xmap.html
        Hide
        David Crossley added a comment -
        See also notes in FOR-546 - the sitemap-ref.html (and perhaps others) needs to also be updated regarding the use of plugins rather than everything in core sitemaps as it was when this doc was written.
        Show
        David Crossley added a comment - See also notes in FOR-546 - the sitemap-ref.html (and perhaps others) needs to also be updated regarding the use of plugins rather than everything in core sitemaps as it was when this doc was written.
        Hide
        David Crossley added a comment -
        I used 'find and grep' to locate patterns "2.*\.xsl" and fixed them to the "*-to-*" convention (r436661).

        Now remains the updating of xdocs that have sitemap snippets.
        Show
        David Crossley added a comment - I used 'find and grep' to locate patterns "2.*\.xsl" and fixed them to the "*-to-*" convention (r436661). Now remains the updating of xdocs that have sitemap snippets.
        David Crossley created issue -

          People

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

            Dates

            • Created:
              Updated:

              Development