Re: interface tag

[Eric Baudais <baudais kkpsi org>]

Sasha-

My point is that you do not know if you will want the standard interface 
terms altered by the stylesheets in any way.  Right now they aren't being 
altered, but that could change in the future.  Maybe we wanted to have all 
the interface terms added to links to a glossary by the appropriate 
definition.  This could be done using a XSL stylesheet and would be hard to do
any other way.  If all the standard interface terms were marked up adding 
the link would be trivial with the stylesheet.

However, I do think there is a point where the documenter can mark up too 
many words.  I'm not sure where this line can be drawn though.  Obviously 
marking up GNOME and XML every time with the <acronym> tag is pointless, but 
can the same be said for marking up standard interface terms.  My opinion is 
these need to be marked up.

Eric Baudais

On Tue, Jun 11, 2002 at 02:42:20PM -0400, Alexander Kirillov wrote:
> Of course, we can safely use <interface> for a long time. My point is,
> it is mostly useless. We can write <interface>toolbar</interface> but it
> will produce  in html the same result as just toolbar without any tags.
> As for window and dialog I personally prefer using  
> <guilabel>File List</guilabel> window 
> <guilabel>Print</guilabel> dialog 
> 
> 
> But, of course, it is a minor point....
> 
> Sasha
> 
> On Tue, 2002-06-11 at 14:14, Eric Baudais wrote:
> > Eugene-
> > 
> > There are intances when the GUI* tags do not apply.  I'm thinking of 
> > specifically marking up the text "dialog box", "scroll bar", "text box", 
> > "drop list", and "tool bar."  These are part of the GUI, but do not apply 
> > under any of the GUI* tags.  For some of these items you could use their name 
> > with <guilabel>, but when you use these terms then the <interface> tag 
> > applies.  
> > 
> > The <interface> tag  might be deprecated, but the <interface> has not been 
> > deprecated yet.  Also we will have 2 major versions of the DocBook DTD before 
> > the tag is removed.  That means the earliest the <interface> tag will be 
> > removed is DocBook 6.0.  We're a long time away from that version when you 
> > take into account the DTD's development cycle.
> > 
> > Eric Baudais
> > 
> > On Tue, Jun 11, 2002 at 11:00:53AM +0100, Eugene O'Connor wrote:
> > > Hi Eric,
> > > 
> > > I have a question about the use of the <interface> tag. In the Inline
> > > Elements, GUI elements section of the GDP Handbook it says:
> > > 
> > > * <interface> - for most everything else... a window, a dialog box, the
> > > Panel etc.
> > > 
> > > The latest version of the TDG that I have seen (V2.0.4+) says:
> > > 
> > > "An Interface identifies some part of a graphical user interface. This
> > > element became obsolete in DocBook V3.0 with the introduction of
> > > GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, and GUISubMenu."
> > > 
> > > I had a conversation with Norm Walsh last week - he thinks that the GUI*
> > > elements completely replace <interface>. So it seems to me that
> > > <interface> could be on the way to being deprecated. Are there any
> > > interface items that are not covered by the GUI* elements?
> > > 
> > > I'll ask a question about this on the docbook mailing list and see if
> > > they can shed any further light on this.
> > > 
> > > Eugene
> > > 
> > > 
> > > Eric Baudais wrote:
> > > > 
> > > > Guys-
> > > > 
> > > > The first draft of the newly revised for GNOME 2 edition of the GDP Handbook
> > > > is completed.  It is in CVS at gnome-docu/gdp/gdp-handbook.xml.  Any comments,
> > > > suggestions, and critiques are welcome.
> > > > 
> > > > There are two sections which I need a developer who knows the help API to
> > > > write.  One involves the C code for adding help to applications and the
> > > > other involves the C code for adding help to applets.  Anyone who has had
> > > > experience in implementing the code is welcome to write those two sections.
> > > > Contact me if you are interested so we aren't duplicating work.
> > > > 
> > > > There is no mention of Scrollkeeper and OMF files.  This was an omission by
> > > > me and will be added for the second draft when I review the structure of the
> > > > handbook.  If anyone has any other sections which aren't in the Handbook but
> > > > need to be just email the list.
> > > > 
> > > > Eric Baudais
> > > > _______________________________________________
> > > > gnome-doc-list mailing list
> > > > gnome-doc-list gnome org
> > > > http://mail.gnome.org/mailman/listinfo/gnome-doc-list
> > > _______________________________________________
> > > gnome-doc-list mailing list
> > > gnome-doc-list gnome org
> > > http://mail.gnome.org/mailman/listinfo/gnome-doc-list
> > _______________________________________________
> > gnome-doc-list mailing list
> > gnome-doc-list gnome org
> > http://mail.gnome.org/mailman/listinfo/gnome-doc-list
> 
> 
> _______________________________________________
> gnome-doc-list mailing list
> gnome-doc-list gnome org
> http://mail.gnome.org/mailman/listinfo/gnome-doc-list