use meaningful link text

[Michelle D'Souza]

Thought I'd draw attention to one of the fixes Laurel made yesterday  
to illustrate how to deal with this.

The following sentence was on one of the API doc pages:

"See the supported events <link> below </link> ."

Laurel moved the link to the text that describes where the link is  
pointing to:

"See the <link> supported events </link> below. "

Now if the link is looked at out of context - in a list of links for  
example - it is still useful and understandable.

Hope this is helpful,

Michelle



On 22-Apr-09, at 2:58 PM, Anastasia Cheetham wrote:

>
>> I'm noticing in the documentation that there are links using a  
>> single non-descriptive word for link text  (i.e. "below" and  
>> "documentation").
>
>
> Laurel, thanks for catching that - I'm probably pretty guilty of  
> that in the API pages...
>
> -- 
> Anastasia Cheetham                   a.cheetham at utoronto.ca
> Software Designer, Fluid Project    http://fluidproject.org
> Adaptive Technology Resource Centre / University of Toronto
>
> _______________________________________________________
> fluid-work mailing list - fluid-work at fluidproject.org
> To unsubscribe, change settings or access archives,
> see http://fluidproject.org/mailman/listinfo/fluid-work

------------------------------------------------------
Michelle D'Souza
Software Developer, Fluid Project
Adaptive Technology Resource Centre
University of Toronto