Apache Forrest development list

Karl Wright (Created) (JIRA | 28 Jan 13:29

[jira] [Created] (FOR-1233) Forrest's PDF plugin configuration documentation seems to be incorrect

Forrest's PDF plugin configuration documentation seems to be incorrect
----------------------------------------------------------------------

                 Key: FOR-1233
                 URL: https://issues.apache.org/jira/browse/FOR-1233
             Project: Forrest
          Issue Type: Bug
          Components: Documentation and website
    Affects Versions: 0.10-dev
            Reporter: Karl Wright

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.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

headers

Karl Wright (Commented) (JIRA | 29 Jan 17:35

[jira] [Commented] (FOR-1233) Forrest's PDF plugin configuration documentation seems to be incorrect


    [
https://issues.apache.org/jira/browse/FOR-1233?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13195784#comment-13195784
] 

Karl Wright commented on FOR-1233:
----------------------------------

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.

                
> Forrest's PDF plugin configuration documentation seems to be incorrect
> ----------------------------------------------------------------------
>
>                 Key: FOR-1233
>                 URL: https://issues.apache.org/jira/browse/FOR-1233
>             Project: Forrest
>          Issue Type: Bug
>          Components: Documentation and website
>    Affects Versions: 0.10-dev
>            Reporter: Karl Wright
>
> 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

(Continue reading)

headers

David Crossley (Commented) (JIRA | 30 Jan 07:25

[jira] [Commented] (FOR-1233) Forrest's PDF plugin configuration documentation seems to be incorrect


    [
https://issues.apache.org/jira/browse/FOR-1233?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13195953#comment-13195953
] 

David Crossley commented on FOR-1233:
-------------------------------------

It seems that your entities file is not configured in the project xml catalog.

See http://forrest.apache.org/faq.html#xml-entities

> Forrest's PDF plugin configuration documentation seems to be incorrect
> ----------------------------------------------------------------------
>
>                 Key: FOR-1233
>                 URL: https://issues.apache.org/jira/browse/FOR-1233
>             Project: Forrest
>          Issue Type: Bug
>          Components: Documentation and website
>    Affects Versions: 0.10-dev
>            Reporter: Karl Wright
>
> 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.

(Continue reading)

headers

Karl Wright (Commented) (JIRA | 31 Jan 08:52

[jira] [Commented] (FOR-1233) Forrest's PDF plugin configuration documentation seems to be incorrect


    [
https://issues.apache.org/jira/browse/FOR-1233?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13196767#comment-13196767
] 

Karl Wright commented on FOR-1233:
----------------------------------

I understand how entities work, but I 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.

                
> Forrest's PDF plugin configuration documentation seems to be incorrect
> ----------------------------------------------------------------------
>

(Continue reading)

headers

Karl Wright (Issue Comment Edited) (JIRA | 31 Jan 08:54

[jira] [Issue Comment Edited] (FOR-1233) Forrest's PDF plugin configuration documentation seems to be incorrect

[
https://issues.apache.org/jira/browse/FOR-1233?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13196767#comment-13196767
]

Karl Wright edited comment on FOR-1233 at 1/31/12 7:52 AM:
-----------------------------------------------------------

Thanks for the reference. But while I understand how entities work, but 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.

was (Author: kwright <at> metacarta.com):
I understand how entities work, but I don't understand what I need to do to the project xml catalog to
configure them.

(Continue reading)

headers

Karl Wright (Issue Comment Edited) (JIRA | 31 Jan 08:56

[jira] [Issue Comment Edited] (FOR-1233) Forrest's PDF plugin configuration documentation seems to be incorrect

[
https://issues.apache.org/jira/browse/FOR-1233?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13196767#comment-13196767
]

Karl Wright edited comment on FOR-1233 at 1/31/12 7:54 AM:
-----------------------------------------------------------

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".

was (Author: kwright <at> metacarta.com):
Thanks for the reference. But while I understand how entities work, but I still don't understand what I need
to do to the project xml catalog to "configure them".

(Continue reading)

headers

David Crossley (Commented) (JIRA | 1 Feb 02:10

[jira] [Commented] (FOR-1233) Forrest's PDF plugin configuration documentation seems to be incorrect


    [
https://issues.apache.org/jira/browse/FOR-1233?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13197470#comment-13197470
] 

David Crossley commented on FOR-1233:
-------------------------------------

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

> Forrest's PDF plugin configuration documentation seems to be incorrect
> ----------------------------------------------------------------------
>
>                 Key: FOR-1233
>                 URL: https://issues.apache.org/jira/browse/FOR-1233
>             Project: Forrest
>          Issue Type: Bug
>          Components: Documentation and website
>    Affects Versions: 0.10-dev
>            Reporter: Karl Wright
>

(Continue reading)

headers

Karl Wright (Commented) (JIRA | 1 Feb 09:30

[jira] [Commented] (FOR-1233) Forrest's PDF plugin configuration documentation seems to be incorrect


    [
https://issues.apache.org/jira/browse/FOR-1233?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13197674#comment-13197674
] 

Karl Wright commented on FOR-1233:
----------------------------------

FWIW, I figured out what is missing to make Forrest use symbols-project-v10.ent, and that's catalog.xcat
in the same directory.

                
> Forrest's PDF plugin configuration documentation seems to be incorrect
> ----------------------------------------------------------------------
>
>                 Key: FOR-1233
>                 URL: https://issues.apache.org/jira/browse/FOR-1233
>             Project: Forrest
>          Issue Type: Bug
>          Components: Documentation and website
>    Affects Versions: 0.10-dev
>            Reporter: Karl Wright
>
> 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.

(Continue reading)

headers

David Crossley (Updated) (JIRA | 2 Feb 01:39

[jira] [Updated] (FOR-1233) PDF plugin configuration not finding xml catalog and entities


     [
https://issues.apache.org/jira/browse/FOR-1233?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

David Crossley updated FOR-1233:
--------------------------------

        Fix Version/s: 0.10-dev
    Affects Version/s: 0.9
              Summary: PDF plugin configuration not finding xml catalog and entities  (was: Forrest's PDF plugin
configuration documentation seems to be incorrect)

> PDF plugin configuration not finding xml catalog and entities
> -------------------------------------------------------------
>
>                 Key: FOR-1233
>                 URL: https://issues.apache.org/jira/browse/FOR-1233
>             Project: Forrest
>          Issue Type: Bug
>          Components: Documentation and website
>    Affects Versions: 0.9, 0.10-dev
>            Reporter: Karl Wright
>             Fix For: 0.10-dev
>
>
> 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

(Continue reading)

headers

David Crossley (Closed) (JIRA | 2 Feb 01:39

[jira] [Closed] (FOR-1233) PDF plugin configuration not finding xml catalog and entities


     [
https://issues.apache.org/jira/browse/FOR-1233?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

David Crossley closed FOR-1233.
-------------------------------

    Resolution: Fixed

That is good news. Thanks for following up. That small doc tweak should help many.

> PDF plugin configuration not finding xml catalog and entities
> -------------------------------------------------------------
>
>                 Key: FOR-1233
>                 URL: https://issues.apache.org/jira/browse/FOR-1233
>             Project: Forrest
>          Issue Type: Bug
>          Components: Documentation and website
>    Affects Versions: 0.9, 0.10-dev
>            Reporter: Karl Wright
>             Fix For: 0.10-dev
>
>
> 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

(Continue reading)