[PATCH: scrnsaverproto] Fix id attributes, linkend and olinks

Matt Dew marcoz at osource.org
Mon Sep 26 17:38:46 PDT 2011


On 09/25/2011 11:55 AM, Gaetan Nadon wrote:
> On Sat, 2011-09-24 at 20:23 -0600, Matt Dew wrote:
>> ---
>>   specs/saver.xml |   30 +++++++++++++++---------------
>>   1 files changed, 15 insertions(+), 15 deletions(-)
>>
>> diff --git a/specs/saver.xml b/specs/saver.xml
>> index b1e6f95..bcdd3a0 100644
>> --- a/specs/saver.xml
>> +++ b/specs/saver.xml
>> @@ -39,7 +39,7 @@ implied warranty.
>>   </legalnotice>
>>   </bookinfo>
>>
>> -<chapter id="Introduction_">
>> +<chapter id='Introduction'>
>>   <title>Introduction</title>
>>   <para>
>>   The X Window System provides support for changing the image on a display screen
>> @@ -464,7 +464,7 @@ window attributes.
>>   </para>
>>   </sect1>
>>
>> -<sect1 id="Events_">
>> +<sect1 id="Events">
>>   <title>Events</title>
>>   <para>
>>   The Screen Saver extension adds one event:
>> @@ -649,7 +649,7 @@ SETofSCREENSAVEREVENT
>>   </literallayout>
>>   </sect1>
>>
>> -<sect1 id="Events">
>> +<sect1 id="Events_2">
>>   <title>Events</title>
>>
>>   <literallayout class="monospaced">
>> @@ -673,7 +673,7 @@ SETofSCREENSAVEREVENT
>>   </sect1>
>>   </chapter>
>>
>> -<chapter id="Inter_Client_Communications_Conventions_">
>> +<chapter id='Inter_Client_Communications_Conventions'>
>>   <title>Inter-Client Communications Conventions</title>
>>   <para>
>>   Screen saver clients should create at least one resource value whose
>> @@ -705,7 +705,7 @@ The include file for this extension is
>>   </para>
>>
>>
>> -<funcsynopsis id='xscreensaverqueryextension'>
>> +<funcsynopsis id='XScreenSaverQueryExtension'>
>>   <funcprototype>
>>     <funcdef>Bool<function>XScreenSaverQueryExtension</function></funcdef>
>>       <paramdef>Display<parameter>*display</parameter></paramdef>
>> @@ -728,7 +728,7 @@ no additional errors are defined by this extension, the results
>>   of<emphasis remap='I'>error_base</emphasis>  are not defined.
>>   </para>
>>
>> -<funcsynopsis id='xscreensaverqueryversion'>
>> +<funcsynopsis id='XScreenSaverQueryVersion'>
>>   <funcprototype>
>>     <funcdef>Status<function>XScreenSaverQueryVersion</function></funcdef>
>>       <paramdef>Display<parameter>*display</parameter></paramdef>
>> @@ -753,14 +753,14 @@ set and 0 is returned.
>>   <para>
>>   This routine allocates and returns an
>>   <emphasis role="bold">XScreenSaverInfo</emphasis>  structure
>> -for use in calls to<function>XScreenSaverQueryInfo</function>.
>> +for use in calls to<xref linkend='XScreenSaverQueryInfo' xrefstyle='select: title pageabbrev'/>.
> Are you considering adding "xrefstyle" with pageabbrev to all xref links?
> If so, consider this suggestion to put it in the customization layer.

No, there are places where it doesn't make sense.  A lot of links are 
very close to the target so a page # feels unnecessary.  Same page, 
sometimes the very preceeding or next paragraph so it doesn't make sense 
to do it everywhere.


> http://lists.oasis-open.org/archives/docbook-apps/200405/msg00121.html
> This attribute was meant to override the default in a few instances.
>
> Consider that we might want to change the xrefstyle at later point in time.
>

Yep, everything I do is with the thought that style can and will change 
in the future.

>>   All fields in the
>>   structure are initialized to zero.  If insufficient memory is available,
>>   NULL is returned.  The results of this routine can be released
>> -using<emphasis remap='I'>XFree</emphasis>.
>> +using<olink targetdoc='libX11' targetptr='XFree'><function>XFree</function></olink>.
> I assume that libX11 xfree will be changed to XFree.

Yep.


>>   </para>
>>
>> -<funcsynopsis id='xscreensaverqueryinfo'>
>> +<funcsynopsis id='XScreenSaverQueryInfo'>
>>   <funcprototype>
>>     <funcdef>Status<function>XScreenSaverQueryInfo</function></funcdef>
>>       <paramdef>Display<parameter>*display</parameter></paramdef>
>> @@ -795,7 +795,7 @@ description of the fields.  If the extension is not supported,
>>   is returned.
>>   </para>
>>
>> -<funcsynopsis id='xscreensaverselectinput'>
>> +<funcsynopsis id='XScreenSaverSelectInput'>
>>   <funcprototype>
>>     <funcdef>void<function>XScreenSaverSelectInput</function></funcdef>
>>       <paramdef>Display<parameter>*display</parameter></paramdef>
>> @@ -832,7 +832,7 @@ See the definition of the
>>   of the allowed event masks.<!-- xref ? -->
>>   </para>
>>
>> -<funcsynopsis id='xscreensaversetattributes'>
>> +<funcsynopsis id='XScreenSaverSetAttributes'>
>>   <funcprototype>
>>     <funcdef>void<function>XScreenSaverSetAttributes</function></funcdef>
>>       <paramdef>Display<parameter>*dpy</parameter></paramdef>
>> @@ -858,7 +858,7 @@ of the<function>ScreenSaverSetAttributes</function>  request for a
>>   description of each of the arguments.
>>   </para>
>>
>> -<funcsynopsis id='xscreensaverunsetattributes'>
>> +<funcsynopsis id='XScreenSaverUnsetAttributes'>
>>   <funcprototype>
>>     <funcdef>void<function>XScreenSaverUnsetAttributes</function></funcdef>
>>       <paramdef>Display<parameter>*display</parameter></paramdef>
>> @@ -872,7 +872,7 @@ extension, this routine instructs the server to discard
>>   any previous screen saver window attributes set by this client.
>>   </para>
>>
>> -<funcsynopsis id='xscreensaverregister'>
>> +<funcsynopsis id='XScreenSaverRegister'>
>>   <funcprototype>
>>     <funcdef>Status<function>XScreenSaverRegister</function></funcdef>
>>       <paramdef>Display<parameter>*display</parameter></paramdef>
>> @@ -891,7 +891,7 @@ is encountered and the property is not changed, otherwise it returns
>>   non-zero.
>>   </para>
>>
>> -<funcsynopsis id='xscreensaverunregister'>
>> +<funcsynopsis id='XScreenSaverUnregister'>
>>   <funcprototype>
>>     <funcdef>Status<function>XScreenSaverUnregister</function></funcdef>
>>       <paramdef>Display<parameter>*display</parameter></paramdef>
>> @@ -906,7 +906,7 @@ It returns zero if an error is encountered and the property is changed,
>>   otherwise it returns non-zero.
>>   </para>
>>
>> -<funcsynopsis id='xscreensavergetregistered'>
>> +<funcsynopsis id='XScreenSaverGetRegistered'>
>>   <funcprototype>
>>     <funcdef>Status<function>XScreenSaverGetRegistered</function></funcdef>
>>       <paramdef>Display<parameter>*display</parameter></paramdef>
>
>



More information about the xorg-devel mailing list