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

[jira] Created: (DOXIASITETOOLS-50) Add a footer element

Add a footer element
--------------------

                 Key: DOXIASITETOOLS-50
                 URL: http://jira.codehaus.org/browse/DOXIASITETOOLS-50
             Project: Maven Doxia Sitetools
          Issue Type: New Feature
          Components: Decoration model
    Affects Versions: 1.1
            Reporter: Lukas Theussl


A la m1 navigation.xml: http://maven.apache.org/maven-1.x/plugins/xdoc/reference/navfile.html

-- 
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: (DOXIASITETOOLS-50) Add a footer element

Posted by "SebbASF (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIASITETOOLS-50?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=261759#action_261759 ] 

SebbASF commented on DOXIASITETOOLS-50:
---------------------------------------

I did not know that the site.xml should not contain HTML markup.
We are using HTML in Commons and HttpClient site.xml files as part of a <custom> tag, which I assume is OK.

If the footer replaces the Copyright contents entirely, then the Copyright has to be repeated in whatever new text is used. That seems unnecessary (and won't work at present with an inherited site because the date properties are resolved in the parent context). It may be tricky providing the (c) symbol too.

It would be easier if the user could provide additional text to go before and/or after the default Copyright statement. If the text were enclosed in a <div id="footerpre|footerpost"> by the VM template, then styling could be applied separately by CSS.

I agree removing the <div class="xright"> is pointless if HTML markup cannot be provided in site.xml.

> Add a footer element
> --------------------
>
>                 Key: DOXIASITETOOLS-50
>                 URL: http://jira.codehaus.org/browse/DOXIASITETOOLS-50
>             Project: Maven Doxia Sitetools
>          Issue Type: New Feature
>          Components: Decoration model
>    Affects Versions: 1.1
>            Reporter: Lukas Theussl
>            Assignee: Dennis Lundberg
>             Fix For: 1.2
>
>
> A la m1 navigation.xml: http://maven.apache.org/maven-1.x/plugins/xdoc/reference/navfile.html

-- 
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: (DOXIASITETOOLS-50) Add a footer element

Posted by "SebbASF (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIASITETOOLS-50?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=262311#action_262311 ] 

SebbASF commented on DOXIASITETOOLS-50:
---------------------------------------

Another issue is that current copyright banner contains HTML markup which makes the organisation name a link to the website.

This will not be possible using <footer> as HTML markup should not be used in site.xml.

> Add a footer element
> --------------------
>
>                 Key: DOXIASITETOOLS-50
>                 URL: http://jira.codehaus.org/browse/DOXIASITETOOLS-50
>             Project: Maven Doxia Sitetools
>          Issue Type: New Feature
>          Components: Decoration model
>    Affects Versions: 1.1
>            Reporter: Lukas Theussl
>            Assignee: Dennis Lundberg
>             Fix For: 1.2
>
>
> A la m1 navigation.xml: http://maven.apache.org/maven-1.x/plugins/xdoc/reference/navfile.html

-- 
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: (DOXIASITETOOLS-50) Add a footer element

Posted by "SebbASF (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIASITETOOLS-50?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=262301#action_262301 ] 

SebbASF commented on DOXIASITETOOLS-50:
---------------------------------------

The whole point of MSITE-59 was to make it easy to add the trademark attributions. 

With the current solution, the user has to include the Copyright text in the same <footer> element. This is unnecessary extra work. Indeed the same criticism applies to DOXIASITETOOLS-56 - the user has to provide the entire Copyright text, including years etc, just in order to change "All rights reserved" to "Some rights reserved."

That is why I think footer and copyright are distinct, but I agree that it might be confusing if specifying footer did not replace the entire footer, and that is a useful feature in its own right. So maybe the solution is to add another tag which can be used to provide text for the trademark attributions or whatever else is needed alongside the Copyright.

> Add a footer element
> --------------------
>
>                 Key: DOXIASITETOOLS-50
>                 URL: http://jira.codehaus.org/browse/DOXIASITETOOLS-50
>             Project: Maven Doxia Sitetools
>          Issue Type: New Feature
>          Components: Decoration model
>    Affects Versions: 1.1
>            Reporter: Lukas Theussl
>            Assignee: Dennis Lundberg
>             Fix For: 1.2
>
>
> A la m1 navigation.xml: http://maven.apache.org/maven-1.x/plugins/xdoc/reference/navfile.html

-- 
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: (DOXIASITETOOLS-50) Add a footer element

Posted by "SebbASF (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIASITETOOLS-50?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=261723#action_261723 ] 

SebbASF commented on DOXIASITETOOLS-50:
---------------------------------------

AFAICT, this does not fully address the problem, as a footer is not the same as the copyright statement.
They ought to be independently customisable.

The change to the VM means that any footer text merely replaces the copyright text - the <div> is still output.

I think it would be more usable to have one tag for the copyright, and a separate tag for the footer, ideally with a mode flag to determine whether it appears before, instead of, or after the copyright div.

> Add a footer element
> --------------------
>
>                 Key: DOXIASITETOOLS-50
>                 URL: http://jira.codehaus.org/browse/DOXIASITETOOLS-50
>             Project: Maven Doxia Sitetools
>          Issue Type: New Feature
>          Components: Decoration model
>    Affects Versions: 1.1
>            Reporter: Lukas Theussl
>            Assignee: Dennis Lundberg
>             Fix For: 1.2
>
>
> A la m1 navigation.xml: http://maven.apache.org/maven-1.x/plugins/xdoc/reference/navfile.html

-- 
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] Updated: (DOXIASITETOOLS-50) Add a footer element

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

Lukas Theussl updated DOXIASITETOOLS-50:
----------------------------------------

    Fix Version/s: 1.2

> Add a footer element
> --------------------
>
>                 Key: DOXIASITETOOLS-50
>                 URL: http://jira.codehaus.org/browse/DOXIASITETOOLS-50
>             Project: Maven Doxia Sitetools
>          Issue Type: New Feature
>          Components: Decoration model
>    Affects Versions: 1.1
>            Reporter: Lukas Theussl
>             Fix For: 1.2
>
>
> A la m1 navigation.xml: http://maven.apache.org/maven-1.x/plugins/xdoc/reference/navfile.html

-- 
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: (DOXIASITETOOLS-50) Add a footer element

Posted by "Dennis Lundberg (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/DOXIASITETOOLS-50?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Dennis Lundberg closed DOXIASITETOOLS-50.
-----------------------------------------

    Resolution: Fixed
      Assignee: Dennis Lundberg

Fixed in [r1086336|http://svn.apache.org/viewvc?view=revision&revision=1086336].

> Add a footer element
> --------------------
>
>                 Key: DOXIASITETOOLS-50
>                 URL: http://jira.codehaus.org/browse/DOXIASITETOOLS-50
>             Project: Maven Doxia Sitetools
>          Issue Type: New Feature
>          Components: Decoration model
>    Affects Versions: 1.1
>            Reporter: Lukas Theussl
>            Assignee: Dennis Lundberg
>             Fix For: 1.2
>
>
> A la m1 navigation.xml: http://maven.apache.org/maven-1.x/plugins/xdoc/reference/navfile.html

-- 
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] Updated: (DOXIASITETOOLS-50) Add a footer element

Posted by "Dennis Lundberg (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/DOXIASITETOOLS-50?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Dennis Lundberg updated DOXIASITETOOLS-50:
------------------------------------------

    Fix Version/s:     (was: 1.2)
                   1.1.5

> Add a footer element
> --------------------
>
>                 Key: DOXIASITETOOLS-50
>                 URL: http://jira.codehaus.org/browse/DOXIASITETOOLS-50
>             Project: Maven Doxia Sitetools
>          Issue Type: New Feature
>          Components: Decoration model
>    Affects Versions: 1.1
>            Reporter: Lukas Theussl
>             Fix For: 1.2
>
>
> A la m1 navigation.xml: http://maven.apache.org/maven-1.x/plugins/xdoc/reference/navfile.html

-- 
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: (DOXIASITETOOLS-50) Add a footer element

Posted by "Dennis Lundberg (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIASITETOOLS-50?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=261726#action_261726 ] 

Dennis Lundberg commented on DOXIASITETOOLS-50:
-----------------------------------------------

Perhaps I don't fully understand your requirements.

I agree that the footer and the copyright are two different things, but the only thing that is in the footer of the default template is the copyright notice. If you want to add more stuff to the footer than just the copyright notice you can do so with this solution.

I don't see the benefit of having two tags for this, especially since you cannot put any html code into them anyway, because they are part of the site.xml file which is used for other output formats than html. If you need to add your own html code, then you have to use your own template.

What would be gained by removing the div that is inside the footer div?

> Add a footer element
> --------------------
>
>                 Key: DOXIASITETOOLS-50
>                 URL: http://jira.codehaus.org/browse/DOXIASITETOOLS-50
>             Project: Maven Doxia Sitetools
>          Issue Type: New Feature
>          Components: Decoration model
>    Affects Versions: 1.1
>            Reporter: Lukas Theussl
>            Assignee: Dennis Lundberg
>             Fix For: 1.2
>
>
> A la m1 navigation.xml: http://maven.apache.org/maven-1.x/plugins/xdoc/reference/navfile.html

-- 
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: (DOXIASITETOOLS-50) Add a footer element

Posted by "Dennis Lundberg (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIASITETOOLS-50?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=261850#action_261850 ] 

Dennis Lundberg commented on DOXIASITETOOLS-50:
-----------------------------------------------

Technically you probably can put HTML code inside a site.xml file, but it is not recommended you do so. The site.xml file might be used for other output formats besides (X)HTML, like PDF. Using HTML code in the site.xml would not look pretty in the PDF.

There is another request to modify the copyright text in a simple way, see DOXIASITETOOLS-56.

I feel that having ways to specify both a copyright *and* a footer will be confusing to users, as one currently contains the other.

> Add a footer element
> --------------------
>
>                 Key: DOXIASITETOOLS-50
>                 URL: http://jira.codehaus.org/browse/DOXIASITETOOLS-50
>             Project: Maven Doxia Sitetools
>          Issue Type: New Feature
>          Components: Decoration model
>    Affects Versions: 1.1
>            Reporter: Lukas Theussl
>            Assignee: Dennis Lundberg
>             Fix For: 1.2
>
>
> A la m1 navigation.xml: http://maven.apache.org/maven-1.x/plugins/xdoc/reference/navfile.html

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