You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Albert Kurucz (JIRA)" <ji...@codehaus.org> on 2009/05/11 18:23:45 UTC

[jira] Created: (DOXIA-319) Improve toc macro for CSS

Improve toc macro for CSS
-------------------------

                 Key: DOXIA-319
                 URL: http://jira.codehaus.org/browse/DOXIA-319
             Project: Maven Doxia
          Issue Type: Improvement
         Environment: any
            Reporter: Albert Kurucz
            Priority: Minor


The toc macro in APT works great!
example: %{toc|section=0}

But.

It would be nice to make it CSS friendly with an divId= and/or divClass= parameter.
example: %{toc|section=0|divID=myTOC}

If divId or div/Class parameter exists, the toc macro should change the enclosing <div class="section"> accordingly.
If there is no enclosing <div class="section">, then create an additional <div> around the generated <ul><li> structure, which has the id/class as specified.

-- 
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-319) Improve toc macro for CSS

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

Lukas Theussl closed DOXIA-319.
-------------------------------

       Resolution: Fixed
    Fix Version/s: 1.1.1

> Improve toc macro for CSS
> -------------------------
>
>                 Key: DOXIA-319
>                 URL: http://jira.codehaus.org/browse/DOXIA-319
>             Project: Maven Doxia
>          Issue Type: Improvement
>          Components: Core
>    Affects Versions: 1.1
>         Environment: any
>            Reporter: Albert Kurucz
>            Assignee: Lukas Theussl
>            Priority: Minor
>             Fix For: 1.1.1
>
>
> The toc macro in APT works great!
> example: %{toc|section=0}
> But.
> It would be nice to make it CSS friendly with an divId= and/or divClass= parameter.
> example: %{toc|section=0|divID=myTOC}
> If divId or div/Class parameter exists, the toc macro should change the enclosing <div class="section"> accordingly.
> If there is no enclosing <div class="section">, then create an additional <div> around the generated <ul><li> structure, which has the id/class as specified.

-- 
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-319) Improve toc macro for CSS

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

Lukas Theussl commented on DOXIA-319:
-------------------------------------

I don't think the TOC macro was meant to provide this functionality. It was designed to work within single pages, not whole sites (DOXIA-40).

What you want should rather be accomplished by some outside plugin, like the site plugin does with site.xml, and I am currently thinking about the same functionality for the pdf plugin.

So as far as Doxia is concerned, I will close this issue as fixed, you may open another feature request for the site renderer or site plugin.

> Improve toc macro for CSS
> -------------------------
>
>                 Key: DOXIA-319
>                 URL: http://jira.codehaus.org/browse/DOXIA-319
>             Project: Maven Doxia
>          Issue Type: Improvement
>          Components: Core
>    Affects Versions: 1.1
>         Environment: any
>            Reporter: Albert Kurucz
>            Assignee: Lukas Theussl
>            Priority: Minor
>
> The toc macro in APT works great!
> example: %{toc|section=0}
> But.
> It would be nice to make it CSS friendly with an divId= and/or divClass= parameter.
> example: %{toc|section=0|divID=myTOC}
> If divId or div/Class parameter exists, the toc macro should change the enclosing <div class="section"> accordingly.
> If there is no enclosing <div class="section">, then create an additional <div> around the generated <ul><li> structure, which has the id/class as specified.

-- 
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] Issue Comment Edited: (DOXIA-319) Improve toc macro for CSS

Posted by "Albert Kurucz (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIA-319?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=175933#action_175933 ] 

Albert Kurucz edited comment on DOXIA-319 at 5/11/09 11:29 AM:
---------------------------------------------------------------

Even better:
It would be nice if the divID parameter exists, then the generated TOC, should show outside of both 
<div id="bodyColumn">
<div id="contentBox">


(with the speficied id).
This would allow the CSS programmer to put the TOC into the navigation column, where it really belongs.

      was (Author: ali65):
    Even better:
It would be nice if the divID parameter exists, then the generated TOC, should show outside of both the <div id="bodyColumn">
      <div id="contentBox">
(with the speficied id).

This would allow the CSS programmer to put the TOC into the navigation column, where it really belongs.
  
> Improve toc macro for CSS
> -------------------------
>
>                 Key: DOXIA-319
>                 URL: http://jira.codehaus.org/browse/DOXIA-319
>             Project: Maven Doxia
>          Issue Type: Improvement
>         Environment: any
>            Reporter: Albert Kurucz
>            Priority: Minor
>
> The toc macro in APT works great!
> example: %{toc|section=0}
> But.
> It would be nice to make it CSS friendly with an divId= and/or divClass= parameter.
> example: %{toc|section=0|divID=myTOC}
> If divId or div/Class parameter exists, the toc macro should change the enclosing <div class="section"> accordingly.
> If there is no enclosing <div class="section">, then create an additional <div> around the generated <ul><li> structure, which has the id/class as specified.

-- 
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: (DOXIA-319) Improve toc macro for CSS

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

Lukas Theussl updated DOXIA-319:
--------------------------------

             Assignee: Lukas Theussl
    Affects Version/s: 1.1
          Component/s: Core

> Improve toc macro for CSS
> -------------------------
>
>                 Key: DOXIA-319
>                 URL: http://jira.codehaus.org/browse/DOXIA-319
>             Project: Maven Doxia
>          Issue Type: Improvement
>          Components: Core
>    Affects Versions: 1.1
>         Environment: any
>            Reporter: Albert Kurucz
>            Assignee: Lukas Theussl
>            Priority: Minor
>
> The toc macro in APT works great!
> example: %{toc|section=0}
> But.
> It would be nice to make it CSS friendly with an divId= and/or divClass= parameter.
> example: %{toc|section=0|divID=myTOC}
> If divId or div/Class parameter exists, the toc macro should change the enclosing <div class="section"> accordingly.
> If there is no enclosing <div class="section">, then create an additional <div> around the generated <ul><li> structure, which has the id/class as specified.

-- 
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-319) Improve toc macro for CSS

Posted by "Albert Kurucz (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIA-319?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=176154#action_176154 ] 

Albert Kurucz commented on DOXIA-319:
-------------------------------------

It would be so nice if the Site renderer could create a vertical menu from the TOC, like this site has (mine):
http://www.jtstand.com/

I think the <div> of TOC should be outside of the bodyColumn and the contentBox to be able to do this.
Correct me if I am wrong!


> Improve toc macro for CSS
> -------------------------
>
>                 Key: DOXIA-319
>                 URL: http://jira.codehaus.org/browse/DOXIA-319
>             Project: Maven Doxia
>          Issue Type: Improvement
>          Components: Core
>    Affects Versions: 1.1
>         Environment: any
>            Reporter: Albert Kurucz
>            Assignee: Lukas Theussl
>            Priority: Minor
>
> The toc macro in APT works great!
> example: %{toc|section=0}
> But.
> It would be nice to make it CSS friendly with an divId= and/or divClass= parameter.
> example: %{toc|section=0|divID=myTOC}
> If divId or div/Class parameter exists, the toc macro should change the enclosing <div class="section"> accordingly.
> If there is no enclosing <div class="section">, then create an additional <div> around the generated <ul><li> structure, which has the id/class as specified.

-- 
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-319) Improve toc macro for CSS

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

Lukas Theussl commented on DOXIA-319:
-------------------------------------

I have committed a basic implementation, see [r773896|http://svn.apache.org/viewvc?view=rev&revision=773896]. I have also deployed a doxia snapshot (v. 1.1.1-SNAPSHOT) to test.

You can now add any html base attribute as a toc macro parameter, eg

{noformat}
%{toc|section=2|fromDepth=1|toDepth=1|id=myId|class=myClass}
{noformat}

this will add the parameters to the list tag:

{code:xml}
<ul id="myId" class="myClass">...
{code}

It is possible to wrap the <ul> in a <div id=""...> if this is desired.

Whether the toc appears inside a <div class="section"> depends on whether the toc declaration appears within a section in the source document. Just move it outside if you don't want it there.

I do not see a way to move the toc outside the bodyColumn or the contentBox as these are put in place by the siterenderer, ie outside doxia, after the sourc docs have been parsed.

> Improve toc macro for CSS
> -------------------------
>
>                 Key: DOXIA-319
>                 URL: http://jira.codehaus.org/browse/DOXIA-319
>             Project: Maven Doxia
>          Issue Type: Improvement
>         Environment: any
>            Reporter: Albert Kurucz
>            Priority: Minor
>
> The toc macro in APT works great!
> example: %{toc|section=0}
> But.
> It would be nice to make it CSS friendly with an divId= and/or divClass= parameter.
> example: %{toc|section=0|divID=myTOC}
> If divId or div/Class parameter exists, the toc macro should change the enclosing <div class="section"> accordingly.
> If there is no enclosing <div class="section">, then create an additional <div> around the generated <ul><li> structure, which has the id/class as specified.

-- 
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-319) Improve toc macro for CSS

Posted by "Albert Kurucz (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIA-319?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=175933#action_175933 ] 

Albert Kurucz commented on DOXIA-319:
-------------------------------------

Even better:
It would be nice if the divID parameter exists, then the generated TOC, should show outside of both the <div id="bodyColumn">
      <div id="contentBox">
(with the speficied id).

This would allow the CSS programmer to put the TOC into the navigation column, where it really belongs.

> Improve toc macro for CSS
> -------------------------
>
>                 Key: DOXIA-319
>                 URL: http://jira.codehaus.org/browse/DOXIA-319
>             Project: Maven Doxia
>          Issue Type: Improvement
>         Environment: any
>            Reporter: Albert Kurucz
>            Priority: Minor
>
> The toc macro in APT works great!
> example: %{toc|section=0}
> But.
> It would be nice to make it CSS friendly with an divId= and/or divClass= parameter.
> example: %{toc|section=0|divID=myTOC}
> If divId or div/Class parameter exists, the toc macro should change the enclosing <div class="section"> accordingly.
> If there is no enclosing <div class="section">, then create an additional <div> around the generated <ul><li> structure, which has the id/class as specified.

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