Uploaded image for project: 'Forrest'
  1. Forrest
  2. FOR-417

Allowing XIncludes in site.xml and tabs.xml

    Details

    • Type: New Feature
    • Status: Closed
    • Priority: Minor
    • Resolution: Invalid
    • Affects Version/s: 0.7
    • Fix Version/s: 0.7
    • Component/s: Core operations
    • Labels:
      None

      Description

      If two projects share some documentation, the shared documentation can easily be included in the documentation tree if XIncludes can be utilised in tabs.xml and site.xml to include tab and menu fragments for the shared documentation.

      The attached patch will process xincludes in these files before the other processing.

      The patch is based on the following suggestion:

      http://mail-archives.apache.org/eyebrowse/ReadMsg?listName=user@forrest.apache.org&msgNo=1576

      We could not find any bugs or problems, but please note that the testing was rather brief.

        Activity

        Hide
        moshagen Sjur N. Moshagen added a comment -
        Attached diff for patching the change.
        Show
        moshagen Sjur N. Moshagen added a comment - Attached diff for patching the change.
        Hide
        rgardler Ross Gardler added a comment -
        I was about to commit this but then something struck me, the shared documents must still appear in the same xdocs directory. Which means there can only be one site.xml and tabs.xml file. I must be missing something.

        Perhaps you can provide a breif example for the docs that illustrate how you are using this.

        Show
        rgardler Ross Gardler added a comment - I was about to commit this but then something struck me, the shared documents must still appear in the same xdocs directory. Which means there can only be one site.xml and tabs.xml file. I must be missing something. Perhaps you can provide a breif example for the docs that illustrate how you are using this.
        Hide
        rgardler Ross Gardler added a comment -
        Patch committed, need to document this feature, see http://mail-archives.apache.org/eyebrowse/ReadMsg?listId=248&msgNo=1586
        Show
        rgardler Ross Gardler added a comment - Patch committed, need to document this feature, see http://mail-archives.apache.org/eyebrowse/ReadMsg?listId=248&msgNo=1586

          People

          • Assignee:
            rgardler Ross Gardler
            Reporter:
            moshagen Sjur N. Moshagen
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development