You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Tony Chemit (JIRA)" <ji...@codehaus.org> on 2009/11/11 15:32:55 UTC

[jira] Created: (MSITE-434) Use a symetric directory layout (default locale is not on root directory)

Use a symetric directory layout (default locale is not on root directory)
-------------------------------------------------------------------------

                 Key: MSITE-434
                 URL: http://jira.codehaus.org/browse/MSITE-434
             Project: Maven 2.x Site Plugin
          Issue Type: New Feature
    Affects Versions: 2.0.1
         Environment: any ?
            Reporter: Tony Chemit


Abstract
--------

Make possible to break to default locale directory layout (adding a parameter symetricLayout)

Actually, when using two locales (en,fr) to generate site, the source directory layout is like this (symetricLayout=false) : 

src/site/
|-- apt
|   `-- index.apt
|-- fr
|   `-- apt
|       `-- index.apt
|-- site_en.xml
`-- site_fr.xml

And it generates like this :

target/site/
|-- index.html
`-- fr
    `-- index.html

With the parameter symetricLayout=true, the source directory layout is like this :

src/site/
|-- en
|   `-- apt
|       `-- index.apt
|-- fr
|   `-- rst
|       `-- index.apt
|-- site_en.xml
`-- site_fr.xml

And it generates this : 

target/site/
|-- en
|   `-- index.html
`-- fr
    `-- index.html

By default the parameter symetricLayout is to false (so nothing is changing :)).

Note
----

when using a single locale, the symetricLayout should always be to false.

Why doing this ?
----------------

We are developping a tool to edit (as a wiki) the generated site and store the changed directly in the svn of the project (Each night the site should be regenerated).

The purpose of this tools is to make possible external users (mainly our clients with credential on svn of course) to improve the documentation of their application without our help.

Using a symetric layout without distinguish a default locale is a lot easier for us.

Hope the patch will be accepted :)

Tony.

-- 
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] (MSITE-434) Use a symetric directory layout (default locale is not on root directory)

Posted by "Robert Scholte (JIRA)" <ji...@codehaus.org>.
     [ https://jira.codehaus.org/browse/MSITE-434?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Robert Scholte updated MSITE-434:
---------------------------------

      Patch Submitted: Yes
    Testcase included: yes
    
> Use a symetric directory layout (default locale is not on root directory)
> -------------------------------------------------------------------------
>
>                 Key: MSITE-434
>                 URL: https://jira.codehaus.org/browse/MSITE-434
>             Project: Maven 2.x and 3.x Site Plugin
>          Issue Type: New Feature
>    Affects Versions: 2.0.1
>         Environment: any ?
>            Reporter: Tony Chemit
>         Attachments: MSITE-434-maven-site-plugin.patch
>
>
> Abstract
> --------
> Make possible to break to default locale directory layout (adding a parameter symetricLayout)
> Actually, when using two locales (en,fr) to generate site, the source directory layout is like this (symetricLayout=false) : 
> src/site/
> |-- apt
> |   `-- index.apt
> |-- fr
> |   `-- apt
> |       `-- index.apt
> |-- site_en.xml
> `-- site_fr.xml
> And it generates like this :
> target/site/
> |-- index.html
> `-- fr
>     `-- index.html
> With the parameter symetricLayout=true, the source directory layout is like this :
> src/site/
> |-- en
> |   `-- apt
> |       `-- index.apt
> |-- fr
> |   `-- rst
> |       `-- index.apt
> |-- site_en.xml
> `-- site_fr.xml
> And it generates this : 
> target/site/
> |-- en
> |   `-- index.html
> `-- fr
>     `-- index.html
> By default the parameter symetricLayout is to false (so nothing is changing :)).
> Note
> ----
> when using a single locale, the symetricLayout should always be to false.
> Why doing this ?
> ----------------
> We are developping a tool to edit (as a wiki) the generated site and store the changed directly in the svn of the project (Each night the site should be regenerated).
> The purpose of this tools is to make possible external users (mainly our clients with credential on svn of course) to improve the documentation of their application without our help.
> Using a symetric layout without distinguish a default locale is a lot easier for us.
> Hope the patch will be accepted :)
> Tony.

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

        

[jira] Updated: (MSITE-434) Use a symetric directory layout (default locale is not on root directory)

Posted by "Tony Chemit (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/MSITE-434?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tony Chemit updated MSITE-434:
------------------------------

    Attachment: MSITE-434-maven-site-plugin.patch

This is the patch for the trunk version (I already use it on a patched 2.0.1 version)

It integrates the two modified classes 

src/main/java/org/apache/maven/plugins/site/SiteMojo.java
src/main/java/org/apache/maven/plugins/site/AbstractSiteRenderingMojo.java

and a it-test

src/it/MSITE-434

Could someone update the issue meta-data (I could not figure out how to do it...) :

there is a patch and test of the patch.

Thanks.


> Use a symetric directory layout (default locale is not on root directory)
> -------------------------------------------------------------------------
>
>                 Key: MSITE-434
>                 URL: http://jira.codehaus.org/browse/MSITE-434
>             Project: Maven 2.x Site Plugin
>          Issue Type: New Feature
>    Affects Versions: 2.0.1
>         Environment: any ?
>            Reporter: Tony Chemit
>         Attachments: MSITE-434-maven-site-plugin.patch
>
>
> Abstract
> --------
> Make possible to break to default locale directory layout (adding a parameter symetricLayout)
> Actually, when using two locales (en,fr) to generate site, the source directory layout is like this (symetricLayout=false) : 
> src/site/
> |-- apt
> |   `-- index.apt
> |-- fr
> |   `-- apt
> |       `-- index.apt
> |-- site_en.xml
> `-- site_fr.xml
> And it generates like this :
> target/site/
> |-- index.html
> `-- fr
>     `-- index.html
> With the parameter symetricLayout=true, the source directory layout is like this :
> src/site/
> |-- en
> |   `-- apt
> |       `-- index.apt
> |-- fr
> |   `-- rst
> |       `-- index.apt
> |-- site_en.xml
> `-- site_fr.xml
> And it generates this : 
> target/site/
> |-- en
> |   `-- index.html
> `-- fr
>     `-- index.html
> By default the parameter symetricLayout is to false (so nothing is changing :)).
> Note
> ----
> when using a single locale, the symetricLayout should always be to false.
> Why doing this ?
> ----------------
> We are developping a tool to edit (as a wiki) the generated site and store the changed directly in the svn of the project (Each night the site should be regenerated).
> The purpose of this tools is to make possible external users (mainly our clients with credential on svn of course) to improve the documentation of their application without our help.
> Using a symetric layout without distinguish a default locale is a lot easier for us.
> Hope the patch will be accepted :)
> Tony.

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