Re: interface tag (Was: GNOME Handbook of Writing Software Documentation rough draft)



I agree. In all the cases I have seen, <interface> can be replaced by a
proper gui* tag. In most cases, it would be guilabel, as in 
"... this opens <guilabel>Save As</guilabel> dialog..."

In fact, I think it is about time to revise the "DocBook Basics" section
of the Handbook (it was mostly written by me when I was just beginning
to learn DocBook, and sometimes it shows :). Can people take a look at
it and make other comments? Eric or I can then make the appropriate
changes. 

Sasha

On Tue, 2002-06-11 at 06:00, 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





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