You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Andy Jefferson (JIRA)" <ji...@codehaus.org> on 2007/04/02 08:07:20 UTC

[jira] Created: (DOXIA-104) Support use of custom properties in XDOC files

Support use of custom properties in XDOC files
----------------------------------------------

                 Key: DOXIA-104
                 URL: http://jira.codehaus.org/browse/DOXIA-104
             Project: doxia
          Issue Type: Task
    Affects Versions: 1.0-alpha-8
            Reporter: Andy Jefferson
            Priority: Critical


In the JPOX Maven1 use of "site" we tagged all (XDOC) docs like this
<document>
    <properties>
        <title>Application Identity</title>
        <jpoxpagetype>Persistence</jpoxpagetype>
        <jpoxversion>1_2</jpoxversion>
    </properties>
    ...
</document>

since XDOCs werent validated against any DTD etc.

Then in site.jsl we could access these properties via
<j:set var="jpoxpage_param">
    <x:expr select="./properties/jpoxpagetype"/>
</j:set>

With Maven2 I don't see how I can do this. I define my own skin for JPOX and in site.vm I have $title, $authors but nothing more. Delving into Doxia I see where they were set up. No allowance for users own properties.

The requirement for JPOX is that we have a large number of documents, and we tag each doc for particular categories ... which will then appear on the web site as horizontal navigation (the default Maven skin only has the navColumn ... vertical navigation). By being able to tag docs into categories/subcategories etc we can then generate a site that the user selects a horizontal nav category, and then a horizontal nav sub-category, and they see vertical navigation within that subcategory. This was possible with Maven1 due to the above ability. Without an equivalent in Maven2 we cannot switch over.

The JPOX docs (from Maven1) are available at http://www.jpox.org/docs/1_2/index.html
so you can understand what is being talked about here. If you need any more info let me know.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DOXIA-104) Support use of custom properties in XDOC files

Posted by "Data Nucleus (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIA-104?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=267219#action_267219 ] 

Data Nucleus commented on DOXIA-104:
------------------------------------

Hi Lukas, i've tried various versions. Most recently 2.1.1 since 2.1 is buggy for validating basic XDOC documents. Yes, it preserves the <meta> in the generated (X)HTML, but I'm not too bothered about preserving them. My question is how do I access them in a velocity file site.vm?
???.head.name or something? Thx

> Support use of custom properties in XDOC files
> ----------------------------------------------
>
>                 Key: DOXIA-104
>                 URL: http://jira.codehaus.org/browse/DOXIA-104
>             Project: Maven Doxia
>          Issue Type: Task
>          Components: Module - Xdoc
>    Affects Versions: 1.0-alpha-8
>            Reporter: Andy Jefferson
>            Assignee: Lukas Theussl
>            Priority: Critical
>
> In the JPOX Maven1 use of "site" we tagged all (XDOC) docs like this
> <document>
>     <properties>
>         <title>Application Identity</title>
>         <jpoxpagetype>Persistence</jpoxpagetype>
>         <jpoxversion>1_2</jpoxversion>
>     </properties>
>     ...
> </document>
> since XDOCs werent validated against any DTD etc.
> Then in site.jsl we could access these properties via
> <j:set var="jpoxpage_param">
>     <x:expr select="./properties/jpoxpagetype"/>
> </j:set>
> With Maven2 I don't see how I can do this. I define my own skin for JPOX and in site.vm I have $title, $authors but nothing more. Delving into Doxia I see where they were set up. No allowance for users own properties.
> The requirement for JPOX is that we have a large number of documents, and we tag each doc for particular categories ... which will then appear on the web site as horizontal navigation (the default Maven skin only has the navColumn ... vertical navigation). By being able to tag docs into categories/subcategories etc we can then generate a site that the user selects a horizontal nav category, and then a horizontal nav sub-category, and they see vertical navigation within that subcategory. This was possible with Maven1 due to the above ability. Without an equivalent in Maven2 we cannot switch over.
> The JPOX docs (from Maven1) are available at http://www.jpox.org/docs/1_2/index.html
> so you can understand what is being talked about here. If you need any more info let me know.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DOXIA-104) Support use of custom properties in XDOC files

Posted by "Andy Jefferson (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIA-104?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_97637 ] 

Andy Jefferson commented on DOXIA-104:
--------------------------------------

Yes, I'm aware that if things are validated against XSDs then that wont validate but it is a perfectly reasonable requirement to be able to specify a page to be in a particular horizontal and vertical navigation position. If there is some other way of providing this then please tell me what it is. 

If M2/Doxia is never going to support flexible horizontal/vertical navs that we require (in some way), then M2 will never be an option for us since site generation is a key part of any project

> Support use of custom properties in XDOC files
> ----------------------------------------------
>
>                 Key: DOXIA-104
>                 URL: http://jira.codehaus.org/browse/DOXIA-104
>             Project: doxia
>          Issue Type: Task
>    Affects Versions: 1.0-alpha-8
>            Reporter: Andy Jefferson
>            Priority: Critical
>
> In the JPOX Maven1 use of "site" we tagged all (XDOC) docs like this
> <document>
>     <properties>
>         <title>Application Identity</title>
>         <jpoxpagetype>Persistence</jpoxpagetype>
>         <jpoxversion>1_2</jpoxversion>
>     </properties>
>     ...
> </document>
> since XDOCs werent validated against any DTD etc.
> Then in site.jsl we could access these properties via
> <j:set var="jpoxpage_param">
>     <x:expr select="./properties/jpoxpagetype"/>
> </j:set>
> With Maven2 I don't see how I can do this. I define my own skin for JPOX and in site.vm I have $title, $authors but nothing more. Delving into Doxia I see where they were set up. No allowance for users own properties.
> The requirement for JPOX is that we have a large number of documents, and we tag each doc for particular categories ... which will then appear on the web site as horizontal navigation (the default Maven skin only has the navColumn ... vertical navigation). By being able to tag docs into categories/subcategories etc we can then generate a site that the user selects a horizontal nav category, and then a horizontal nav sub-category, and they see vertical navigation within that subcategory. This was possible with Maven1 due to the above ability. Without an equivalent in Maven2 we cannot switch over.
> The JPOX docs (from Maven1) are available at http://www.jpox.org/docs/1_2/index.html
> so you can understand what is being talked about here. If you need any more info let me know.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DOXIA-104) Support use of custom properties in XDOC files

Posted by "Lukas Theussl (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIA-104?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_97504 ] 

Lukas Theussl commented on DOXIA-104:
-------------------------------------

Maven 1.1 (and xdoc-plugin > 1.10) allows to validate xdoc sources according to a published DTD, see http://maven.apache.org/maven-1.x/plugins/xdoc/reference/xdocs.html#Validation. According to this schema, you sources are not valid xdocs.

> Support use of custom properties in XDOC files
> ----------------------------------------------
>
>                 Key: DOXIA-104
>                 URL: http://jira.codehaus.org/browse/DOXIA-104
>             Project: doxia
>          Issue Type: Task
>    Affects Versions: 1.0-alpha-8
>            Reporter: Andy Jefferson
>            Priority: Critical
>
> In the JPOX Maven1 use of "site" we tagged all (XDOC) docs like this
> <document>
>     <properties>
>         <title>Application Identity</title>
>         <jpoxpagetype>Persistence</jpoxpagetype>
>         <jpoxversion>1_2</jpoxversion>
>     </properties>
>     ...
> </document>
> since XDOCs werent validated against any DTD etc.
> Then in site.jsl we could access these properties via
> <j:set var="jpoxpage_param">
>     <x:expr select="./properties/jpoxpagetype"/>
> </j:set>
> With Maven2 I don't see how I can do this. I define my own skin for JPOX and in site.vm I have $title, $authors but nothing more. Delving into Doxia I see where they were set up. No allowance for users own properties.
> The requirement for JPOX is that we have a large number of documents, and we tag each doc for particular categories ... which will then appear on the web site as horizontal navigation (the default Maven skin only has the navColumn ... vertical navigation). By being able to tag docs into categories/subcategories etc we can then generate a site that the user selects a horizontal nav category, and then a horizontal nav sub-category, and they see vertical navigation within that subcategory. This was possible with Maven1 due to the above ability. Without an equivalent in Maven2 we cannot switch over.
> The JPOX docs (from Maven1) are available at http://www.jpox.org/docs/1_2/index.html
> so you can understand what is being talked about here. If you need any more info let me know.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DOXIA-104) Support use of custom properties in XDOC files

Posted by "Lukas Theussl (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIA-104?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=267218#action_267218 ] 

Lukas Theussl commented on DOXIA-104:
-------------------------------------

It is resolved as 'Won't fix'.

Unknown sink events are events that a parser may emit when it encounters an element for which no sink method exists. Eg the xdoc parser may emit an unknown event for a <script> tag, which the xhtml sink can process, but an arbitrary sink may ignore.

Which version of the site plugin do you refer to here? Using doxia-1.1 (since site-plugin-2.1), the head elements should be preserved.

> Support use of custom properties in XDOC files
> ----------------------------------------------
>
>                 Key: DOXIA-104
>                 URL: http://jira.codehaus.org/browse/DOXIA-104
>             Project: Maven Doxia
>          Issue Type: Task
>          Components: Module - Xdoc
>    Affects Versions: 1.0-alpha-8
>            Reporter: Andy Jefferson
>            Assignee: Lukas Theussl
>            Priority: Critical
>
> In the JPOX Maven1 use of "site" we tagged all (XDOC) docs like this
> <document>
>     <properties>
>         <title>Application Identity</title>
>         <jpoxpagetype>Persistence</jpoxpagetype>
>         <jpoxversion>1_2</jpoxversion>
>     </properties>
>     ...
> </document>
> since XDOCs werent validated against any DTD etc.
> Then in site.jsl we could access these properties via
> <j:set var="jpoxpage_param">
>     <x:expr select="./properties/jpoxpagetype"/>
> </j:set>
> With Maven2 I don't see how I can do this. I define my own skin for JPOX and in site.vm I have $title, $authors but nothing more. Delving into Doxia I see where they were set up. No allowance for users own properties.
> The requirement for JPOX is that we have a large number of documents, and we tag each doc for particular categories ... which will then appear on the web site as horizontal navigation (the default Maven skin only has the navColumn ... vertical navigation). By being able to tag docs into categories/subcategories etc we can then generate a site that the user selects a horizontal nav category, and then a horizontal nav sub-category, and they see vertical navigation within that subcategory. This was possible with Maven1 due to the above ability. Without an equivalent in Maven2 we cannot switch over.
> The JPOX docs (from Maven1) are available at http://www.jpox.org/docs/1_2/index.html
> so you can understand what is being talked about here. If you need any more info let me know.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DOXIA-104) Support use of custom properties in XDOC files

Posted by "Lukas Theussl (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIA-104?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=267221#action_267221 ] 

Lukas Theussl commented on DOXIA-104:
-------------------------------------

The DefaultSiteRenderer emits the head in a variable $headContent, but as a plain String, so I'm afraid you can't access child elements like above.

> Support use of custom properties in XDOC files
> ----------------------------------------------
>
>                 Key: DOXIA-104
>                 URL: http://jira.codehaus.org/browse/DOXIA-104
>             Project: Maven Doxia
>          Issue Type: Task
>          Components: Module - Xdoc
>    Affects Versions: 1.0-alpha-8
>            Reporter: Andy Jefferson
>            Assignee: Lukas Theussl
>            Priority: Critical
>
> In the JPOX Maven1 use of "site" we tagged all (XDOC) docs like this
> <document>
>     <properties>
>         <title>Application Identity</title>
>         <jpoxpagetype>Persistence</jpoxpagetype>
>         <jpoxversion>1_2</jpoxversion>
>     </properties>
>     ...
> </document>
> since XDOCs werent validated against any DTD etc.
> Then in site.jsl we could access these properties via
> <j:set var="jpoxpage_param">
>     <x:expr select="./properties/jpoxpagetype"/>
> </j:set>
> With Maven2 I don't see how I can do this. I define my own skin for JPOX and in site.vm I have $title, $authors but nothing more. Delving into Doxia I see where they were set up. No allowance for users own properties.
> The requirement for JPOX is that we have a large number of documents, and we tag each doc for particular categories ... which will then appear on the web site as horizontal navigation (the default Maven skin only has the navColumn ... vertical navigation). By being able to tag docs into categories/subcategories etc we can then generate a site that the user selects a horizontal nav category, and then a horizontal nav sub-category, and they see vertical navigation within that subcategory. This was possible with Maven1 due to the above ability. Without an equivalent in Maven2 we cannot switch over.
> The JPOX docs (from Maven1) are available at http://www.jpox.org/docs/1_2/index.html
> so you can understand what is being talked about here. If you need any more info let me know.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DOXIA-104) Support use of custom properties in XDOC files

Posted by "Data Nucleus (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIA-104?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=267155#action_267155 ] 

Data Nucleus commented on DOXIA-104:
------------------------------------

All seem to be thrown away using the version of Maven site referred to here (as "unknown" sink events whatever that is). Consequently they aren't in the generated site at all. If I can't access these "custom properties" from within the "meta elements inside head" (using a custom Velocity file) then this JIRA is not resolved

> Support use of custom properties in XDOC files
> ----------------------------------------------
>
>                 Key: DOXIA-104
>                 URL: http://jira.codehaus.org/browse/DOXIA-104
>             Project: Maven Doxia
>          Issue Type: Task
>          Components: Module - Xdoc
>    Affects Versions: 1.0-alpha-8
>            Reporter: Andy Jefferson
>            Assignee: Lukas Theussl
>            Priority: Critical
>
> In the JPOX Maven1 use of "site" we tagged all (XDOC) docs like this
> <document>
>     <properties>
>         <title>Application Identity</title>
>         <jpoxpagetype>Persistence</jpoxpagetype>
>         <jpoxversion>1_2</jpoxversion>
>     </properties>
>     ...
> </document>
> since XDOCs werent validated against any DTD etc.
> Then in site.jsl we could access these properties via
> <j:set var="jpoxpage_param">
>     <x:expr select="./properties/jpoxpagetype"/>
> </j:set>
> With Maven2 I don't see how I can do this. I define my own skin for JPOX and in site.vm I have $title, $authors but nothing more. Delving into Doxia I see where they were set up. No allowance for users own properties.
> The requirement for JPOX is that we have a large number of documents, and we tag each doc for particular categories ... which will then appear on the web site as horizontal navigation (the default Maven skin only has the navColumn ... vertical navigation). By being able to tag docs into categories/subcategories etc we can then generate a site that the user selects a horizontal nav category, and then a horizontal nav sub-category, and they see vertical navigation within that subcategory. This was possible with Maven1 due to the above ability. Without an equivalent in Maven2 we cannot switch over.
> The JPOX docs (from Maven1) are available at http://www.jpox.org/docs/1_2/index.html
> so you can understand what is being talked about here. If you need any more info let me know.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Closed: (DOXIA-104) Support use of custom properties in XDOC files

Posted by "Lukas Theussl (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/DOXIA-104?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Lukas Theussl closed DOXIA-104.
-------------------------------

         Assignee: Lukas Theussl
       Resolution: Won't Fix
    Fix Version/s:     (was: 1.0-beta-1)

This should be done with meta elements inside head, see DOXIA-129.

> Support use of custom properties in XDOC files
> ----------------------------------------------
>
>                 Key: DOXIA-104
>                 URL: http://jira.codehaus.org/browse/DOXIA-104
>             Project: Maven Doxia
>          Issue Type: Task
>          Components: Module - Xdoc
>    Affects Versions: 1.0-alpha-8
>            Reporter: Andy Jefferson
>            Assignee: Lukas Theussl
>            Priority: Critical
>
> In the JPOX Maven1 use of "site" we tagged all (XDOC) docs like this
> <document>
>     <properties>
>         <title>Application Identity</title>
>         <jpoxpagetype>Persistence</jpoxpagetype>
>         <jpoxversion>1_2</jpoxversion>
>     </properties>
>     ...
> </document>
> since XDOCs werent validated against any DTD etc.
> Then in site.jsl we could access these properties via
> <j:set var="jpoxpage_param">
>     <x:expr select="./properties/jpoxpagetype"/>
> </j:set>
> With Maven2 I don't see how I can do this. I define my own skin for JPOX and in site.vm I have $title, $authors but nothing more. Delving into Doxia I see where they were set up. No allowance for users own properties.
> The requirement for JPOX is that we have a large number of documents, and we tag each doc for particular categories ... which will then appear on the web site as horizontal navigation (the default Maven skin only has the navColumn ... vertical navigation). By being able to tag docs into categories/subcategories etc we can then generate a site that the user selects a horizontal nav category, and then a horizontal nav sub-category, and they see vertical navigation within that subcategory. This was possible with Maven1 due to the above ability. Without an equivalent in Maven2 we cannot switch over.
> The JPOX docs (from Maven1) are available at http://www.jpox.org/docs/1_2/index.html
> so you can understand what is being talked about here. If you need any more info let me know.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DOXIA-104) Support use of custom properties in XDOC files

Posted by "Data Nucleus (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIA-104?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=266364#action_266364 ] 

Data Nucleus commented on DOXIA-104:
------------------------------------

Thx Lukas, but how do I access such meta elements from a Velocity file? got an example?

> Support use of custom properties in XDOC files
> ----------------------------------------------
>
>                 Key: DOXIA-104
>                 URL: http://jira.codehaus.org/browse/DOXIA-104
>             Project: Maven Doxia
>          Issue Type: Task
>          Components: Module - Xdoc
>    Affects Versions: 1.0-alpha-8
>            Reporter: Andy Jefferson
>            Assignee: Lukas Theussl
>            Priority: Critical
>
> In the JPOX Maven1 use of "site" we tagged all (XDOC) docs like this
> <document>
>     <properties>
>         <title>Application Identity</title>
>         <jpoxpagetype>Persistence</jpoxpagetype>
>         <jpoxversion>1_2</jpoxversion>
>     </properties>
>     ...
> </document>
> since XDOCs werent validated against any DTD etc.
> Then in site.jsl we could access these properties via
> <j:set var="jpoxpage_param">
>     <x:expr select="./properties/jpoxpagetype"/>
> </j:set>
> With Maven2 I don't see how I can do this. I define my own skin for JPOX and in site.vm I have $title, $authors but nothing more. Delving into Doxia I see where they were set up. No allowance for users own properties.
> The requirement for JPOX is that we have a large number of documents, and we tag each doc for particular categories ... which will then appear on the web site as horizontal navigation (the default Maven skin only has the navColumn ... vertical navigation). By being able to tag docs into categories/subcategories etc we can then generate a site that the user selects a horizontal nav category, and then a horizontal nav sub-category, and they see vertical navigation within that subcategory. This was possible with Maven1 due to the above ability. Without an equivalent in Maven2 we cannot switch over.
> The JPOX docs (from Maven1) are available at http://www.jpox.org/docs/1_2/index.html
> so you can understand what is being talked about here. If you need any more info let me know.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira