[PATCH: libX11] Add ids to functions in documentation to allow linking.

[Matt Dew]

On 05/22/2011 05:26 PM, Gaetan Nadon wrote:
> On Sat, 2011-05-21 at 18:59 -0600, Matt Dew wrote:
>> On 05/21/2011 07:38 AM, Gaetan Nadon wrote:
>> >  On Sat, 2011-05-21 at 01:11 -0600, Matt Dew wrote:
>> >>  Simple changes, but lots of them, so it's a large patch so I've linked
>> >>  to it.
>> >>
>> >  It does not work for me. The generated html is generally different, but
>> >  the functions are not clickable.
>> >  Here is the generated HTML so you can compare with what you have:
>> >
>> >  This is from appendix C, the first function in your patch.
>> >
>> >      Basic Protocol Support Routines
>> >
>> >      </p><p>
>> >      The basic protocol requests for extensions are
>> >      <code class="function">XQueryExtension</code>
>> >      and
>> >      <code class="function">XListExtensions</code>.
>> >      </p><a id="id447154"   class="indexterm"></a><div class="funcsynopsis">   [...]
>> >
>> >
>> >  There seems to be no difference in the generated html around the functions.
>> Hi Gaetan,
>>
>> Right after that you should see the anchor point:
>> <a id="xqueryextension"></a>
> I see it.
>>
>> Try libX11.html#xqueryextension. it should take you right to that
>> function def.
>>
> No change.
>
>     </p><a id="id411815"  class="indexterm"></a><div class="funcsynopsis"><a id="libX11.html#xqueryextension">
>
>
> What is supposed to happen? I should be able to click on the word
> XQueryExtensions? There is a hover text "Appendix C. Etensions" that
> pops up when the mouse pointer is over that word. I searched for
> "xqueryextension" lower case and there is only one hit. Shouldn't there
> be another hit to identify the destination link?

It allows other docs to olink against this doc.

I've submitted a patch against bigreqproto that will create olinks in 
that doc to some of these anchor points created by the libX11 patch.



>
>> My next patch is for bigreqsproto that will add olinks to these
>> functions in libX11.
>>
>> Let me know if that anchor point isn't there.
>>
>>
>> >
>> >
>> >>
>> >>  http://people.freedesktop.org/~marcoz/patches/0001-Add-id-s-to-functions-to-make-clickable-links.patch
>> >>  _______________________________________________
>> >>  xorg-devel at lists.x.org  <mailto:xorg-devel at lists.x.org>   <mailto:xorg-devel at lists.x.org>: X.Org development
>> >>  Archives:http://lists.x.org/archives/xorg-devel
>> >>  Info:http://lists.x.org/mailman/listinfo/xorg-devel
>>