Skip site navigation (1)Skip section navigation (2)
Date:      Thu, 12 Dec 2013 09:35:44 -0700 (MST)
From:      Warren Block <wblock@wonkity.com>
To:        Taras Korenko <ds@ukrhub.net>
Cc:        freebsd-doc@freebsd.org
Subject:   Re: en/handbook/basics: proposed corrections #2
Message-ID:  <alpine.BSF.2.00.1312120917360.12037@wonkity.com>
In-Reply-To: <20131212160226.GE85778@gamma.ukrhub.net>
References:  <20131212091212.GC85778@gamma.ukrhub.net> <alpine.BSF.2.00.1312120754390.12037@wonkity.com> <20131212160226.GE85778@gamma.ukrhub.net>

next in thread | previous in thread | raw e-mail | index | archive | help
On Thu, 12 Dec 2013, Taras Korenko wrote:

> On Thu, Dec 12, 2013 at 08:31:58AM -0700, Warren Block wrote:
>> On Thu, 12 Dec 2013, Taras Korenko wrote:
>>>  ...
>>>  Could anyone review that?
>>>  ...
>> ...
>> @@ -637,7 +639,7 @@
>>
>>         <para>&os; provides a variety of different commands to manage
>>          user accounts.  The most common commands are summarized in
>> -       Table 4.1, followed by some examples of their usage.  Refer to
>> +       the subsequent table, followed by some examples of their usage.  Refer to
>>          the manual page for each utility for more details and usage
>>          examples.</para>
>>
>> WB: "See" is simpler than "refer to".  An xml:id can be added to that
>> table and linked here.  That is also useful when referring to the page
>> in HTML, because it becomes an anchor. ...
>
>  A xml:id was avoided intentionally: this table is pretty close to the
> text, from which the reference is made.

I've come to think we should embrace IDs on nearly every major element, 
not avoid them.  They're cheap and helpful.  It allows a direct link to 
the exact spot, which has come in handy in the mailing lists and forums. 
When an ID is not present, it's like giving map directions: "go to this 
link, scroll down and look for the table called..."

In this case, the text is close to the table, but that could change at 
any time.

With or without the link, the patch looks good to me.  Thanks!



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?alpine.BSF.2.00.1312120917360.12037>