Forrest
  1. Forrest
  2. FOR-1233

PDF plugin configuration not finding xml catalog and entities

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 0.9, 0.10-dev
    • Fix Version/s: 0.10-dev
    • Labels:
      None

      Description

      When I follow the instructions at http://forrest.apache.org/pluginDocs/plugins_0_90/org.apache.forrest.plugin.output.pdf, they say to place a configuration file called config.xml at the location $PROJECT_HOME/src/documentation/resources/schema/symbols-project-v10.ent. However, when I create this file and point it to a config.xml, as stated in the documentation, the config.xml is never parsed. (I can determine this by making the xml badly formed, which I would hope would cause an error of some kind). I have not gone into using strace to see where Forrest is actually looking but will try this soon.

      I am using the trunk version of Forrest at the moment.

        Issue Links

          Activity

          Hide
          David Crossley added a comment -
          That is good news. Thanks for following up. That small doc tweak should help many.
          Show
          David Crossley added a comment - That is good news. Thanks for following up. That small doc tweak should help many.
          Hide
          Karl Wright added a comment -
          FWIW, I figured out what is missing to make Forrest use symbols-project-v10.ent, and that's catalog.xcat in the same directory.
          Show
          Karl Wright added a comment - FWIW, I figured out what is missing to make Forrest use symbols-project-v10.ent, and that's catalog.xcat in the same directory.
          Hide
          David Crossley added a comment -
          Regarding upgrading, follow from here
          http://forrest.apache.org/docs/
          to here
          http://forrest.apache.org/docs/upgrading_09.html
          and see "General upgrade tips". That was improved a little today to emphasise comparing configuration to a fresh seed site.

          The doc that i mentioned above is upgraded to link to stuff about configuring the Catalog Entity Resolver.

          See r1238894
          Show
          David Crossley added a comment - Regarding upgrading, follow from here http://forrest.apache.org/docs/ to here http://forrest.apache.org/docs/upgrading_09.html and see "General upgrade tips". That was improved a little today to emphasise comparing configuration to a fresh seed site. The doc that i mentioned above is upgraded to link to stuff about configuring the Catalog Entity Resolver. See r1238894
          Hide
          Karl Wright added a comment - - edited
          Thanks for the reference. But while I understand how entities work, I still don't understand what I need to do to the project xml catalog to "configure them".

          As the linked document points out, "You can supply lists of symbols for your own project too. Create a fresh site with 'forrest seed' and see the set at the src/documentation/resources/schema/symbols-project-v10.ent file. Copy that file to your own projects at the same location. Also add the entry to your project xml catalog as shown in the seed site at src/documentation/resources/schema/catalog.xcat file." We had a file at this location which did not seem to be read. (I've now removed it and we patch Forrest directly.) That is what I'm talking about. According to your doc, this file is supposedly created when you run "forrest seed". Now, our site was created several Forrest versions back, but simply copying or creating a symbols-project-v10.ent file in the above location had no effect. It is possible that some supporting collateral elsewhere in the site should also be modified, but I have absolutely no idea what that collateral would be, and I can find no doc that tells me what I'd need to do.

          Perhaps the solution is, "if your site was created using "forrest seed" using a forrest version less than 0.90, you must recreate your site to get it to work". If so, the doc should state that clearly.
          Show
          Karl Wright added a comment - - edited Thanks for the reference. But while I understand how entities work, I still don't understand what I need to do to the project xml catalog to "configure them". As the linked document points out, "You can supply lists of symbols for your own project too. Create a fresh site with 'forrest seed' and see the set at the src/documentation/resources/schema/symbols-project-v10.ent file. Copy that file to your own projects at the same location. Also add the entry to your project xml catalog as shown in the seed site at src/documentation/resources/schema/catalog.xcat file." We had a file at this location which did not seem to be read. (I've now removed it and we patch Forrest directly.) That is what I'm talking about. According to your doc, this file is supposedly created when you run "forrest seed". Now, our site was created several Forrest versions back, but simply copying or creating a symbols-project-v10.ent file in the above location had no effect. It is possible that some supporting collateral elsewhere in the site should also be modified, but I have absolutely no idea what that collateral would be, and I can find no doc that tells me what I'd need to do. Perhaps the solution is, "if your site was created using "forrest seed" using a forrest version less than 0.90, you must recreate your site to get it to work". If so, the doc should state that clearly.
          Hide
          David Crossley added a comment -
          It seems that your entities file is not configured in the project xml catalog.

          See http://forrest.apache.org/faq.html#xml-entities
          Show
          David Crossley added a comment - It seems that your entities file is not configured in the project xml catalog. See http://forrest.apache.org/faq.html#xml-entities
          Hide
          Karl Wright added a comment -
          I've discovered that it is the symbols-project-v10.ent file that is simply never read. Replacing the PDF plugin's output.xmap with one the directly references the config.xml file seems to work, but the entity replacement does not take place (obviously) because there is no processed entity declaration.
          Show
          Karl Wright added a comment - I've discovered that it is the symbols-project-v10.ent file that is simply never read. Replacing the PDF plugin's output.xmap with one the directly references the config.xml file seems to work, but the entity replacement does not take place (obviously) because there is no processed entity declaration.

            People

            • Assignee:
              Unassigned
              Reporter:
              Karl Wright
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development