You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by "Trent Rosenbaum (JIRA)" <ji...@codehaus.org> on 2005/11/21 15:32:06 UTC

[jira] Created: (MNG-1642) Incorrect APT markup applied to the Title of the guide-releasing.apt

Incorrect APT markup applied to the Title of the guide-releasing.apt 
---------------------------------------------------------------------

         Key: MNG-1642
         URL: http://jira.codehaus.org/browse/MNG-1642
     Project: Maven 2
        Type: Bug
  Components: documentation - guides  
    Versions: 2.0.1    
    Reporter: Trent Rosenbaum


The incorrect APT markup has been used on the title of the following mini guide resource:

http://svn.apache.org/viewcvs.cgi/maven/site/trunk/src/site/apt/guides/mini/guide-releasing.apt 

The document uses the "----" instead of  " ----", (the second example includes a space).  This is instructing the maven-site plugin to render a box around the content.  This issue is major because it does not present the information to the user in a clear manner.

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


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


[jira] Updated: (MNG-1642) Incorrect APT markup applied to the Title of the guide-releasing.apt

Posted by "Trent Rosenbaum (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/MNG-1642?page=all ]

Trent Rosenbaum updated MNG-1642:
---------------------------------

    Attachment: screenshot-2 - Showing the rendering after patch has been applied.jpg

> Incorrect APT markup applied to the Title of the guide-releasing.apt 
> ---------------------------------------------------------------------
>
>          Key: MNG-1642
>          URL: http://jira.codehaus.org/browse/MNG-1642
>      Project: Maven 2
>         Type: Bug
>   Components: documentation - guides
>     Versions: 2.0.1
>     Reporter: Trent Rosenbaum
>  Attachments: MNG-1642-maven-site.patch, screenshot-1 - Showing the rendered error.jpg, screenshot-2 - Showing the rendering after patch has been applied.jpg
>
>
> The incorrect APT markup has been used on the title of the following mini guide resource:
> http://svn.apache.org/viewcvs.cgi/maven/site/trunk/src/site/apt/guides/mini/guide-releasing.apt 
> The document uses the "----" instead of  " ----", (the second example includes a space).  This is instructing the maven-site plugin to render a box around the content.  This issue is major because it does not present the information to the user in a clear manner.

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


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


[jira] Updated: (MNG-1642) Incorrect APT markup applied to the Title of the guide-releasing.apt

Posted by "Trent Rosenbaum (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/MNG-1642?page=all ]

Trent Rosenbaum updated MNG-1642:
---------------------------------

    Attachment: MNG-1642-maven-site.patch

The above patch corrects the APT format used to describe the title for the document.  All this patch does is place a space before the first dashed line, (that preceeds the author names).  This stops the maven-site plugin from including the content inside a box, (normally used to show examples and code).  This will allow the guide to be correctly rendered for other to read.

Test - 
I have checked out all of the maven-site content, (from the trunk) and run the plugin over the project.  This recreated the issue in live.  I then added the space and rerun the plugin and the mini guide for the use of the maven-release plugin was correctly rendered.

> Incorrect APT markup applied to the Title of the guide-releasing.apt 
> ---------------------------------------------------------------------
>
>          Key: MNG-1642
>          URL: http://jira.codehaus.org/browse/MNG-1642
>      Project: Maven 2
>         Type: Bug
>   Components: documentation - guides
>     Versions: 2.0.1
>     Reporter: Trent Rosenbaum
>  Attachments: MNG-1642-maven-site.patch
>
>
> The incorrect APT markup has been used on the title of the following mini guide resource:
> http://svn.apache.org/viewcvs.cgi/maven/site/trunk/src/site/apt/guides/mini/guide-releasing.apt 
> The document uses the "----" instead of  " ----", (the second example includes a space).  This is instructing the maven-site plugin to render a box around the content.  This issue is major because it does not present the information to the user in a clear manner.

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


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


[jira] Closed: (MNG-1642) Incorrect APT markup applied to the Title of the guide-releasing.apt

Posted by "Emmanuel Venisse (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/MNG-1642?page=all ]
     
Emmanuel Venisse closed MNG-1642:
---------------------------------

      Assign To: Emmanuel Venisse
     Resolution: Fixed
    Fix Version: 2.0.1

Fixed.

> Incorrect APT markup applied to the Title of the guide-releasing.apt 
> ---------------------------------------------------------------------
>
>          Key: MNG-1642
>          URL: http://jira.codehaus.org/browse/MNG-1642
>      Project: Maven 2
>         Type: Bug
>   Components: documentation - guides
>     Versions: 2.0.1
>     Reporter: Trent Rosenbaum
>     Assignee: Emmanuel Venisse
>      Fix For: 2.0.1
>  Attachments: MNG-1642-maven-site.patch, screenshot-1 - Showing the rendered error.jpg, screenshot-2 - Showing the rendering after patch has been applied.jpg
>
>
> The incorrect APT markup has been used on the title of the following mini guide resource:
> http://svn.apache.org/viewcvs.cgi/maven/site/trunk/src/site/apt/guides/mini/guide-releasing.apt 
> The document uses the "----" instead of  " ----", (the second example includes a space).  This is instructing the maven-site plugin to render a box around the content.  This issue is major because it does not present the information to the user in a clear manner.

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


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


[jira] Updated: (MNG-1642) Incorrect APT markup applied to the Title of the guide-releasing.apt

Posted by "Trent Rosenbaum (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/MNG-1642?page=all ]

Trent Rosenbaum updated MNG-1642:
---------------------------------

    Attachment: screenshot-1 - Showing the rendered error.jpg

> Incorrect APT markup applied to the Title of the guide-releasing.apt 
> ---------------------------------------------------------------------
>
>          Key: MNG-1642
>          URL: http://jira.codehaus.org/browse/MNG-1642
>      Project: Maven 2
>         Type: Bug
>   Components: documentation - guides
>     Versions: 2.0.1
>     Reporter: Trent Rosenbaum
>  Attachments: MNG-1642-maven-site.patch, screenshot-1 - Showing the rendered error.jpg, screenshot-2 - Showing the rendering after patch has been applied.jpg
>
>
> The incorrect APT markup has been used on the title of the following mini guide resource:
> http://svn.apache.org/viewcvs.cgi/maven/site/trunk/src/site/apt/guides/mini/guide-releasing.apt 
> The document uses the "----" instead of  " ----", (the second example includes a space).  This is instructing the maven-site plugin to render a box around the content.  This issue is major because it does not present the information to the user in a clear manner.

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


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org