You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@hc.apache.org by "Nicholas Sushkin (JIRA)" <ji...@apache.org> on 2009/08/19 22:55:14 UTC
Add <a name=""> anchors to documentation sections
-------------------------------------------------
Key: HTTPCLIENT-868
URL: https://issues.apache.org/jira/browse/HTTPCLIENT-868
Project: HttpComponents HttpClient
Issue Type: Improvement
Components: Documentation
Affects Versions: 4.0 Final
Reporter: Nicholas Sushkin
In all docs, sections are missing <a name> anchors. I see that the xdocs stylesheet in the repository is supposed to generate them, yet the site is missing them at this moment.
See https://svn.apache.org/repos/asf/jakarta/site/xdocs/stylesheets/site.xsl
template match="section"
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
Posted by "Nicholas Sushkin (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HTTPCLIENT-868?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12745529#action_12745529 ]
Nicholas Sushkin commented on HTTPCLIENT-868:
---------------------------------------------
To Oleg - I am happy to produce a patch, just trying to figure out where the change should be made
To Sebb - thanks for the helpful information.
According to http://maven.apache.org/doxia/references/doxia-apt.html#Anchors_for_section_titles , I only need to wrap all section titles in the apt files
with curly braces to make them into anchors. I will submit a patch for that.
> Add <a name=""> anchors to documentation sections
> -------------------------------------------------
>
> Key: HTTPCLIENT-868
> URL: https://issues.apache.org/jira/browse/HTTPCLIENT-868
> Project: HttpComponents HttpClient
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 4.0 Final
> Reporter: Nicholas Sushkin
> Priority: Trivial
> Fix For: 4.0.1, 4.1.0
>
>
> In all docs, sections are missing <a name> anchors. I see that the xdocs stylesheet in the repository is supposed to generate them, yet the site is missing them at this moment.
> See https://svn.apache.org/repos/asf/jakarta/site/xdocs/stylesheets/site.xsl
> template match="section"
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
Posted by "Oleg Kalnichevski (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HTTPCLIENT-868?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12745490#action_12745490 ]
Oleg Kalnichevski commented on HTTPCLIENT-868:
----------------------------------------------
(1) Pardon my ignorance, but I do not quite understand why this is a problem.
(2) As far as open-source projects are concerned the best way to fix a problem is by fixing it yourself (and submitting a patch)
Oleg
> Add <a name=""> anchors to documentation sections
> -------------------------------------------------
>
> Key: HTTPCLIENT-868
> URL: https://issues.apache.org/jira/browse/HTTPCLIENT-868
> Project: HttpComponents HttpClient
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 4.0 Final
> Reporter: Nicholas Sushkin
> Priority: Trivial
> Fix For: 4.0.1, 4.1.0
>
>
> In all docs, sections are missing <a name> anchors. I see that the xdocs stylesheet in the repository is supposed to generate them, yet the site is missing them at this moment.
> See https://svn.apache.org/repos/asf/jakarta/site/xdocs/stylesheets/site.xsl
> template match="section"
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
Posted by "Nicholas Sushkin (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HTTPCLIENT-868?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12745485#action_12745485 ]
Nicholas Sushkin commented on HTTPCLIENT-868:
---------------------------------------------
I looked at the stylesheet above, it already had the code to generate anchors. What do you mean "we happily accept pathces". Is that the wrong stylesheet? Which stylesheet generates the site?
> Add <a name=""> anchors to documentation sections
> -------------------------------------------------
>
> Key: HTTPCLIENT-868
> URL: https://issues.apache.org/jira/browse/HTTPCLIENT-868
> Project: HttpComponents HttpClient
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 4.0 Final
> Reporter: Nicholas Sushkin
> Priority: Trivial
> Fix For: 4.0.1, 4.1.0
>
>
> In all docs, sections are missing <a name> anchors. I see that the xdocs stylesheet in the repository is supposed to generate them, yet the site is missing them at this moment.
> See https://svn.apache.org/repos/asf/jakarta/site/xdocs/stylesheets/site.xsl
> template match="section"
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
Posted by "Sebb (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HTTPCLIENT-868?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12745496#action_12745496 ]
Sebb commented on HTTPCLIENT-868:
---------------------------------
The site is generated using the Maven Site Plugin.
This does not use the site.xsl file you mention.
The HttpComponents site uses the APT format for documentation source files.
AFAICT anchors need to be defined using the format:
{anchor}
They are not automatically generated from the section headings.
The APT source files are in SVN if you want to look, e.g.
http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/src/site/apt
> Add <a name=""> anchors to documentation sections
> -------------------------------------------------
>
> Key: HTTPCLIENT-868
> URL: https://issues.apache.org/jira/browse/HTTPCLIENT-868
> Project: HttpComponents HttpClient
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 4.0 Final
> Reporter: Nicholas Sushkin
> Priority: Trivial
> Fix For: 4.0.1, 4.1.0
>
>
> In all docs, sections are missing <a name> anchors. I see that the xdocs stylesheet in the repository is supposed to generate them, yet the site is missing them at this moment.
> See https://svn.apache.org/repos/asf/jakarta/site/xdocs/stylesheets/site.xsl
> template match="section"
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
Posted by "Oleg Kalnichevski (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HTTPCLIENT-868?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Oleg Kalnichevski updated HTTPCLIENT-868:
-----------------------------------------
Priority: Trivial (was: Major)
Fix Version/s: 4.1.0
4.0.1
We happily accept patches.
Oleg
> Add <a name=""> anchors to documentation sections
> -------------------------------------------------
>
> Key: HTTPCLIENT-868
> URL: https://issues.apache.org/jira/browse/HTTPCLIENT-868
> Project: HttpComponents HttpClient
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 4.0 Final
> Reporter: Nicholas Sushkin
> Priority: Trivial
> Fix For: 4.0.1, 4.1.0
>
>
> In all docs, sections are missing <a name> anchors. I see that the xdocs stylesheet in the repository is supposed to generate them, yet the site is missing them at this moment.
> See https://svn.apache.org/repos/asf/jakarta/site/xdocs/stylesheets/site.xsl
> template match="section"
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
Posted by "Nicholas Sushkin (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HTTPCLIENT-868?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Nicholas Sushkin updated HTTPCLIENT-868:
----------------------------------------
Attachment: HTTPCLIENT-868.patch.1.diff
For ease of navigation and indexing, made most sections and subsections generate their anchors. Added anchors to certain lists.
> Add <a name=""> anchors to documentation sections
> -------------------------------------------------
>
> Key: HTTPCLIENT-868
> URL: https://issues.apache.org/jira/browse/HTTPCLIENT-868
> Project: HttpComponents HttpClient
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 4.0 Final
> Reporter: Nicholas Sushkin
> Priority: Trivial
> Fix For: 4.0.1, 4.1.0
>
> Attachments: HTTPCLIENT-868.patch.1.diff
>
>
> In all docs, sections are missing <a name> anchors. I see that the xdocs stylesheet in the repository is supposed to generate them, yet the site is missing them at this moment.
> See https://svn.apache.org/repos/asf/jakarta/site/xdocs/stylesheets/site.xsl
> template match="section"
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
Posted by "Oleg Kalnichevski (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/HTTPCLIENT-868?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Oleg Kalnichevski resolved HTTPCLIENT-868.
------------------------------------------
Resolution: Fixed
Patch checked in. Many thanks, Nicholas
Oleg
> Add <a name=""> anchors to documentation sections
> -------------------------------------------------
>
> Key: HTTPCLIENT-868
> URL: https://issues.apache.org/jira/browse/HTTPCLIENT-868
> Project: HttpComponents HttpClient
> Issue Type: Improvement
> Components: Documentation
> Affects Versions: 4.0 Final
> Reporter: Nicholas Sushkin
> Priority: Trivial
> Fix For: 4.0.1, 4.1.0
>
> Attachments: HTTPCLIENT-868.patch.1.diff
>
>
> In all docs, sections are missing <a name> anchors. I see that the xdocs stylesheet in the repository is supposed to generate them, yet the site is missing them at this moment.
> See https://svn.apache.org/repos/asf/jakarta/site/xdocs/stylesheets/site.xsl
> template match="section"
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org