Re: Rendering of xref tag



Agreed - "the section called ..." is clumsy and too long.
 Still,  from reading books, I am more used to    

"... in Appendix A, Free Doc. License" 

then 

"... in Free Doc. License"

So maybe we can use the same for sections:
...section 4.1, Setting Preferences

On the other hand, on-line help is not book, so maybe it is time to
forget old habits?

(Note: the above was about HTML output - printed output is quite
different matter)

And of course, whatever we decide to do, it is not too hard to implement
it using the stylesheets. I can do it. 

Sasha

On Thu, 2002-02-07 at 11:06, Eugene O'Connor wrote:
> When I convert an XML file to HTML, the text 'the section called ""' is
> added to every cross-reference (<xref> tags) in the document. So, for
> example, my cross-references appear like this:
> 
>    For more information see the section called "To Modify a Panel With
> the Panel Properties Dialog".
> 
> I think that the "the section called " text is redundant and should be
> removed. What do others think of this?
> 
> This is more of a problem when I create a bulleted list of links, which
> appear like this: 
> 
>        * the section called "Mouse Skills"
>        * the section called "Using Shortcut Keys"
>        * the section called "Using Windows and Dialogs"
> 
> I considered using the link tag instead, but I want the cross-reference
> text to be automatically generated, rather than manually entered. This
> makes more sense as it reduces the work when updating docs, and cuts the
> risk of error.
> 
> I also think that the quotation marks around the cross-reference text
> are unnecessary - the text will be underlined, and a different color to
> the surrounding text - I think that's enough to make the hyperlink stand
> out. 
> 
> In summary, I think it would be better if the cross-reference text was
> like this: 
> 
>    For more information see To Modify a Panel With the Panel Properties
> Dialog'
> 
> The title of the referred-to text would be formatted as a normal
> hyperlink.
> 
> What do other people think?
> 
> Eugene
> _______________________________________________
> gnome-doc-list mailing list
> gnome-doc-list gnome org
> http://mail.gnome.org/mailman/listinfo/gnome-doc-list





[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]