Re: svn commit: r1817032 - in /subversion/site/staging/docs: index.html release-notes/1.8.html

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|

Re: svn commit: r1817032 - in /subversion/site/staging/docs: index.html release-notes/1.8.html

Stefan
On 03/12/2017 13:34, [hidden email] wrote:

> Author: luke1410
> Date: Sun Dec  3 12:34:02 2017
> New Revision: 1817032
>
> URL: http://svn.apache.org/viewvc?rev=1817032&view=rev
> Log:
> Introduce anchors to release sections on the docs index page and use the 1.8
> one on the 1.8 release notes to fix the previously non-working link.
>
> * site/staging/docs/index.html: add anchors/sections to the different
>   releases...
> * site/staging/docs/release-notes/1.8.html: ... update the link here
>   accordingly
>
> Modified:
>     subversion/site/staging/docs/index.html
>     subversion/site/staging/docs/release-notes/1.8.html
>
> Modified: subversion/site/staging/docs/index.html
> URL: http://svn.apache.org/viewvc/subversion/site/staging/docs/index.html?rev=1817032&r1=1817031&r2=1817032&view=diff
> ==============================================================================
> --- subversion/site/staging/docs/index.html (original)
> +++ subversion/site/staging/docs/index.html Sun Dec  3 12:34:02 2017
> @@ -96,34 +96,58 @@
>     libraries are upgraded to 1.6.0 without your having to change or
>     recompile your software at all.</p>
>  
> -<h3>Latest release (currently 1.9)</h3>
> +<div class="h3" id="latest-release">
> +<h3>Latest release (currently 1.9)
> +<a class="sectionlink" href="#latest-release"
> +    title="Link to this section">&para;</a>
> +</h3>
>  
>  <ul>
>    <li><a href="api/latest/">C API</a></li>
>    <li><a href="javahl/latest/">JavaHL</a></li>
>  </ul>
>  
> -<h3>Subversion 1.9</h3>
> +</div> <!-- #latest-release -->
> +
> +<div class="h3" id="release-1.9">
> +<h3>Subversion 1.9
> +<a class="sectionlink" href="#release-1.9"
> +    title="Link to this section">&para;</a>
> +</h3>
>  
>  <ul>
>    <li><a href="api/1.9/">C API</a></li>
>    <li><a href="javahl/1.9/">JavaHL</a></li>
>  </ul>
>  
> -<h3>Subversion 1.8</h3>
> +</div> <!-- #release-1.9 -->
> +
> +<div class="h3" id="release-1.8">
> +<h3>Subversion 1.8
> +<a class="sectionlink" href="#release-1.8"
> +    title="Link to this section">&para;</a>
> +</h3>
>  
>  <ul>
>    <li><a href="api/1.8/">C API</a></li>
>    <li><a href="javahl/1.8/">JavaHL</a></li>
>  </ul>
>  
> -<h3>Subversion 1.7</h3>
> +</div> <!-- #release-1.8 -->
> +
> +<div class="h3" id="release-1.7">
> +<h3>Subversion 1.7
> +<a class="sectionlink" href="#release-1.7"
> +    title="Link to this section">&para;</a>
> +</h3>
>  
>  <ul>
>    <li><a href="api/1.7/">C API</a></li>
>    <li><a href="javahl/1.7/">JavaHL</a></li>
>  </ul>
>  
> +</div> <!-- #release-1.7 -->
> +
>  <h3>Unreleased (1.10-dev)</h3>
>  
>  <ul>
>
> Modified: subversion/site/staging/docs/release-notes/1.8.html
> URL: http://svn.apache.org/viewvc/subversion/site/staging/docs/release-notes/1.8.html?rev=1817032&r1=1817031&r2=1817032&view=diff
> ==============================================================================
> --- subversion/site/staging/docs/release-notes/1.8.html (original)
> +++ subversion/site/staging/docs/release-notes/1.8.html Sun Dec  3 12:34:02 2017
> @@ -2505,7 +2505,7 @@ by issuing one additional request at the
>  <div class="notice" style="background-color: inherit">
>  <p>Technical details:
>  A session is often equivalent to calling one <tt>svn</tt> subcommand (or
> -one <tt>svn_client_*</tt> function, for <a href="/docs/#1.8">API users</a>).
> +one <tt>svn_client_*</tt> function, for <a href="/docs/#release-1.8">API users</a>).
>  However several subcommands currently open multiple sessions.  The extra
>  request cost is incurred for each session.  A single session may make numerous
>  TCP connections (usually 2 and never more than 8) and the extra request will
>
>
This and the following commits adds sections links to API sections for
the different SVN releases which previously were missing.

The main reason for this change was actually to fix a non-working
section link present on the 1.8 release notes page [1].
Adding these links/sections however also changed the layout so the
h3-sections are now indented. Initially I thought to resolve this, but
after checking think it looks better that way. To see the change,
compare these two pages [2/3]. Anybody against keeping this change?

Also note that in order to use HTML 4.01 compliant ids, I did not go
with #1.8 but rather #release-1.8, since in HTML 4.01 ids are not
allowed to start with numbers.

Regards,
Stefan

[1] http://subversion.apache.org/docs/release-notes/1.8.html (see link:
"API users").
[2] http://subversion-staging.apache.org/docs/
[3] http://subversion.apache.org/docs/

Reply | Threaded
Open this post in threaded view
|

Re: svn commit: r1817032 - in /subversion/site/staging/docs: index.html release-notes/1.8.html

Johan Corveleyn-3
On Sun, Dec 3, 2017 at 1:51 PM, Stefan <[hidden email]> wrote:

> On 03/12/2017 13:34, [hidden email] wrote:
>> Author: luke1410
>> Date: Sun Dec  3 12:34:02 2017
>> New Revision: 1817032
>>
>> URL: http://svn.apache.org/viewvc?rev=1817032&view=rev
>> Log:
>> Introduce anchors to release sections on the docs index page and use the 1.8
>> one on the 1.8 release notes to fix the previously non-working link.
>>
>> * site/staging/docs/index.html: add anchors/sections to the different
>>   releases...
>> * site/staging/docs/release-notes/1.8.html: ... update the link here
>>   accordingly
>>
>> Modified:
>>     subversion/site/staging/docs/index.html
>>     subversion/site/staging/docs/release-notes/1.8.html
>>
>> Modified: subversion/site/staging/docs/index.html
>> URL: http://svn.apache.org/viewvc/subversion/site/staging/docs/index.html?rev=1817032&r1=1817031&r2=1817032&view=diff
>> ==============================================================================
>> --- subversion/site/staging/docs/index.html (original)
>> +++ subversion/site/staging/docs/index.html Sun Dec  3 12:34:02 2017
>> @@ -96,34 +96,58 @@
>>     libraries are upgraded to 1.6.0 without your having to change or
>>     recompile your software at all.</p>
>>
>> -<h3>Latest release (currently 1.9)</h3>
>> +<div class="h3" id="latest-release">
>> +<h3>Latest release (currently 1.9)
>> +<a class="sectionlink" href="#latest-release"
>> +    title="Link to this section">&para;</a>
>> +</h3>
>>
>>  <ul>
>>    <li><a href="api/latest/">C API</a></li>
>>    <li><a href="javahl/latest/">JavaHL</a></li>
>>  </ul>
>>
>> -<h3>Subversion 1.9</h3>
>> +</div> <!-- #latest-release -->
>> +
>> +<div class="h3" id="release-1.9">
>> +<h3>Subversion 1.9
>> +<a class="sectionlink" href="#release-1.9"
>> +    title="Link to this section">&para;</a>
>> +</h3>
>>
>>  <ul>
>>    <li><a href="api/1.9/">C API</a></li>
>>    <li><a href="javahl/1.9/">JavaHL</a></li>
>>  </ul>
>>
>> -<h3>Subversion 1.8</h3>
>> +</div> <!-- #release-1.9 -->
>> +
>> +<div class="h3" id="release-1.8">
>> +<h3>Subversion 1.8
>> +<a class="sectionlink" href="#release-1.8"
>> +    title="Link to this section">&para;</a>
>> +</h3>
>>
>>  <ul>
>>    <li><a href="api/1.8/">C API</a></li>
>>    <li><a href="javahl/1.8/">JavaHL</a></li>
>>  </ul>
>>
>> -<h3>Subversion 1.7</h3>
>> +</div> <!-- #release-1.8 -->
>> +
>> +<div class="h3" id="release-1.7">
>> +<h3>Subversion 1.7
>> +<a class="sectionlink" href="#release-1.7"
>> +    title="Link to this section">&para;</a>
>> +</h3>
>>
>>  <ul>
>>    <li><a href="api/1.7/">C API</a></li>
>>    <li><a href="javahl/1.7/">JavaHL</a></li>
>>  </ul>
>>
>> +</div> <!-- #release-1.7 -->
>> +
>>  <h3>Unreleased (1.10-dev)</h3>
>>
>>  <ul>
>>
>> Modified: subversion/site/staging/docs/release-notes/1.8.html
>> URL: http://svn.apache.org/viewvc/subversion/site/staging/docs/release-notes/1.8.html?rev=1817032&r1=1817031&r2=1817032&view=diff
>> ==============================================================================
>> --- subversion/site/staging/docs/release-notes/1.8.html (original)
>> +++ subversion/site/staging/docs/release-notes/1.8.html Sun Dec  3 12:34:02 2017
>> @@ -2505,7 +2505,7 @@ by issuing one additional request at the
>>  <div class="notice" style="background-color: inherit">
>>  <p>Technical details:
>>  A session is often equivalent to calling one <tt>svn</tt> subcommand (or
>> -one <tt>svn_client_*</tt> function, for <a href="/docs/#1.8">API users</a>).
>> +one <tt>svn_client_*</tt> function, for <a href="/docs/#release-1.8">API users</a>).
>>  However several subcommands currently open multiple sessions.  The extra
>>  request cost is incurred for each session.  A single session may make numerous
>>  TCP connections (usually 2 and never more than 8) and the extra request will
>>
>>
> This and the following commits adds sections links to API sections for
> the different SVN releases which previously were missing.
>
> The main reason for this change was actually to fix a non-working
> section link present on the 1.8 release notes page [1].
> Adding these links/sections however also changed the layout so the
> h3-sections are now indented. Initially I thought to resolve this, but
> after checking think it looks better that way. To see the change,
> compare these two pages [2/3]. Anybody against keeping this change?
>
> Also note that in order to use HTML 4.01 compliant ids, I did not go
> with #1.8 but rather #release-1.8, since in HTML 4.01 ids are not
> allowed to start with numbers.
>
> Regards,
> Stefan
>
> [1] http://subversion.apache.org/docs/release-notes/1.8.html (see link:
> "API users").
> [2] http://subversion-staging.apache.org/docs/
> [3] http://subversion.apache.org/docs/
>

Looks good to me (both the link and the indentation of the h3 sections
on /docs).

Thanks for tending after our website a bit :-).

--
Johan