Dialog or dialog box?

Hi Jean, Barbara,

Seriously, shouldn't you get the glossary from Sophie and start with
that? It will probably contain most of the terms that the team needs,
without lengthy debate.
Jean

I agree. What I was thinking about is a compilation not just of the
terms, but also of what paragraph style (fairly obvious as a rule) and
especially what character style (sometimes not so obvious) to use for
each of the kinds of things we talk about in the guides. That probably
exists someplace, too, right? I definitely saw some things that were
inconsistent and/or clearly wrong, like OOoMenuPath being used instead
of OOoStrongEmphasis, or dialog names using different character styles
in different places. But that kind of correction is very time-consuming,
and probably beyond the scope of this effort right now. It would help
for later reference, though.

So we were using an online tool called SunGloss to maintain this glossaries for several languages. It was a great tool, but Oracle has decided to shut it down and use OpenCTI instead wich is a translation tool, so it's not the same usage unfortunately. I'm still thinking of a tool to maintain our glossaries, but their is currently more important tasks for me.

Here you'll find the last export I've made from SunGloss for the French language:
http://fr.openoffice.org/files/documents/67/4226/export_20080417_en-US_fr-FR.zip

This file contains all the words used in the UI with the French translation and comments about this translation and also the state of the word (approved or pending). So there is too much information but at least you get the list of word. Also it's from 2008, so some new words are missing, I can provide you with a list of them later (I maintain another glossary now).
To open the file, you should change the extension to .csv and open it as a tab separated value file with Calc, then you'll be able to filter the file easily.

Thanks, Sophie. Definitely a huge number of items (15,887) there! It doesn't look as if it will resolve the "which to use" issue, though. Apparently it includes anything that has been used, so both "dialog" and "dialog box" are there, as are "menu bar" and "main menu" (for example). "Context menu" isn't there, though "contextual menu" is -- so that seems to have been a global change. And there are a slew of "pop-up" related terms! So absence of a term is meaningful, but presence really isn't.

Hope this help to begin, but I think the more useful really would be to have an online tool accessible to each author to add words and comments, even for style, where there is the ability to make some export for offline work.

Right.

Yes, it doesn't help you yet, you need to update it as time being and really adapt it to your needs.
But I can help here by searching (greping) for the occurrences of the words in the help files quiet quickly.
Would you be able to send me a list of terms you need to check for consistency? I'll search for them and will send them back to you. If you don't have a list, but just terms from time to time, no problem, I'll be able to check for the any way.

- So for menu bar/main menu: Main menu is appearing only once in the help "Note for Mac OS X users: The Help mentions the menu path Tools - Options at numerous places. Replace this path with %PRODUCTNAME - Preferences on your Mac OS X main menu"
This is menu bar that is used instead.

- For contextual menu/context menu: Contextual menu doesn't exist in the help file. Context menu is the one that is used.

This grep is done on OOoDEV_m84 help files.

Kind regards
Sophie

Hi Jean, Barbara,

Seriously, shouldn't you get the glossary from Sophie and start with
that? It will probably contain most of the terms that the team needs,
without lengthy debate.
Jean

I agree. What I was thinking about is a compilation not just of the
terms, but also of what paragraph style (fairly obvious as a rule) and
especially what character style (sometimes not so obvious) to use for
each of the kinds of things we talk about in the guides. That probably
exists someplace, too, right? I definitely saw some things that were
inconsistent and/or clearly wrong, like OOoMenuPath being used instead
of OOoStrongEmphasis, or dialog names using different character styles
in different places. But that kind of correction is very time-consuming,
and probably beyond the scope of this effort right now. It would help
for later reference, though.

So we were using an online tool called SunGloss to maintain this
glossaries for several languages. It was a great tool, but Oracle has
decided to shut it down and use OpenCTI instead wich is a translation
tool, so it's not the same usage unfortunately. I'm still thinking of
a tool to maintain our glossaries, but their is currently more
important tasks for me.

Here you'll find the last export I've made from SunGloss for the
French language:
http://fr.openoffice.org/files/documents/67/4226/export_20080417_en-US_fr-FR.zip

This file contains all the words used in the UI with the French
translation and comments about this translation and also the state of
the word (approved or pending). So there is too much information but
at least you get the list of word. Also it's from 2008, so some new
words are missing, I can provide you with a list of them later (I
maintain another glossary now).
To open the file, you should change the extension to .csv and open it
as a tab separated value file with Calc, then you'll be able to filter
the file easily.

Thanks, Sophie. Definitely a huge number of items (15,887) there! It
doesn't look as if it will resolve the "which to use" issue, though.
Apparently it includes anything that has been used, so both "dialog" and
"dialog box" are there, as are "menu bar" and "main menu" (for example).
"Context menu" isn't there, though "contextual menu" is -- so that seems
to have been a global change. And there are a slew of "pop-up" related
terms! So absence of a term is meaningful, but presence really isn't.

Yes, it doesn't help you yet, you need to update it as time being and really adapt it to your needs.
But I can help here by searching (greping) for the occurrences of the words in the help files quiet quickly.
Would you be able to send me a list of terms you need to check for consistency? I'll search for them and will send them back to you. If you don't have a list, but just terms from time to time, no problem, I'll be able to check for the any way.

Right now, there's no list. Thanks for the offer to grep the terms, that should be a real help.

- So for menu bar/main menu: Main menu is appearing only once in the help "Note for Mac OS X users: The Help mentions the menu path Tools - Options at numerous places. Replace this path with %PRODUCTNAME - Preferences on your Mac OS X main menu"
This is menu bar that is used instead.

OK, thanks. Sounds as if we should change that as we go. And we also seem agreed on "dialog" rather than "dialog box" -- right?

- For contextual menu/context menu: Contextual menu doesn't exist in the help file. Context menu is the one that is used.

Interesting -- the translation material seems to go the other way. How about "context menu" vs "pop-up menu" or "pop-up window menu" or "pop-up window" or the other variants on that, with and without the hyphen?

Hi Barbara,
[...]

OK, thanks. Sounds as if we should change that as we go. And we also
seem agreed on "dialog" rather than "dialog box" -- right?

That is what is used in the help files.

- For contextual menu/context menu: Contextual menu doesn't exist in
the help file. Context menu is the one that is used.

Interesting -- the translation material seems to go the other way.

If you speak about French translation in the glossary, I usually work with Gnome, Mozilla, Debian and KDE groups, so there is sometime an harmonization between their usage and mine. Gnome/KDE and OOo have put a shared glossary on line grouping all the words we use for the French products.
  How

about "context menu" vs "pop-up menu" or "pop-up window menu" or "pop-up
window" or the other variants on that, with and without the hyphen?

pop-up menu: used twice
helpcontent2-fr/smath/01.po:"choices from this pop-up menu to access the <link "
helpcontent2-fr/shared/04.po:msgid "Opens the list of the control field currently selected in a dialog. These shortcut keys apply not only to combo boxes but also to icon buttons with pop-up menus. Close an opened list by pressing the Escape key."

pop-up window menu: not used
pop-up window: not used
the variant of the three without the hyphen is not used.

Kind regards
Sophie

I probably should claim the main responsibility/blame or whatever for employing "dialog box" over "dialog" over at OOoAuthors since 2006. My basic rationale was that dialog box was more widely used by most of the major software/firmware/hardware developers over the past two decades, including Microsoft, Sun Microsystems--the previous sponsor of OOo, Motorola, Red Hat, IBM, among numerous others.

When working as a technical editor of user guides for (embedded-microcontroller) compilers, assemblers, IDEs, etc. over at the newly branded spinoff of Motorola--Freescale Semiconductor--during 2005, I was directed to follow its corporate style guide, which strictly mandated its use over dialog (no exceptions were allowed, as with many other corporate style guides, such as guides for those firms listed above).

Also, the Wilkipedia has dialog box in lieu of dialog (http://en.wikipedia.org/wiki/Dialog_box). The Wiki tends to employ the more accurate nomenclature for most GUI components. If one follows the Wiki forms, then agreement can be more universal. [Hint: If one does not like whatever form the Wiki employs--change (edit) it...] Some editors prefer dialog for one reason or another; others consider the use of dialog to be flawed, lazy, or sloppy usage. Oracle tends to employ both forms...

Another area of disagreement is in the use of "tabbed page" or "tabbed window" versus a "tab." A tab is the part of the GUI component on a tabbed window/page that a user selects for accessing the desired page/window, much like a small tab on an index card in an older paper-based filing system. The page/window itself contains the bulk of that document's information, but not the small projection (tab).

There are others.

Gary

Hi Barbara,
[...]

OK, thanks. Sounds as if we should change that as we go. And we also
seem agreed on "dialog" rather than "dialog box" -- right?

That is what is used in the help files.

- For contextual menu/context menu: Contextual menu doesn't exist in
the help file. Context menu is the one that is used.

Interesting -- the translation material seems to go the other way.

If you speak about French translation in the glossary, I usually work with Gnome, Mozilla, Debian and KDE groups, so there is sometime an harmonization between their usage and mine. Gnome/KDE and OOo have put a shared glossary on line grouping all the words we use for the French products.

I was talking about the file you pointed to, and what I saw in the Calc version. The term "context menu" is not there, but "contextual menu" is. (Only looked at the English column.)

How

about "context menu" vs "pop-up menu" or "pop-up window menu" or "pop-up
window" or the other variants on that, with and without the hyphen?

pop-up menu: used twice
helpcontent2-fr/smath/01.po:"choices from this pop-up menu to access the <link "
helpcontent2-fr/shared/04.po:msgid "Opens the list of the control field currently selected in a dialog. These shortcut keys apply not only to combo boxes but also to icon buttons with pop-up menus. Close an opened list by pressing the Escape key."

pop-up window menu: not used
pop-up window: not used
the variant of the three without the hyphen is not used.

Kind regards
Sophie

OK, it seems that "context menu" is the preferred choice. Thanks!

Sometime around twenty years ago, Microsoft and Apple employed differing forms--context versus contextual--in their documentation. I forgot which one used which. Other developers typically chose the form of the two forms based upon the O/S their apps used. IOW, back then it was a PC/Mac sort of thing.

Doing some pro bono (they gave me expensive embedded-microcontroller firmware-development apps to use for free) technical-editing work for Motorola in the very late 1990s/early 2000s, I used each form, depending upon which O/S the particular IDE apps used.

So, another consideration is to employ the term based upon the particular O/S hosting the office suite.

Gary

I think the intent is for the documentation (embedded help, online, PDFs, published) to be as platform-neutral as possible, and as consistent with each other as possible in the terminology used. Sophie is kindly doing greps on the embedded help so we can try to do that. Always interesting to get the backstory, though! I don't even remember now what terms were used in the IBM product I was working on embedded help for (back in 1996, in one of my last actual paid activities).

Hi, :slight_smile:

It would be interesting to see how Sophie's offered content could be
incorporated into the Alfresco site, to make it a reference resource
available to docs workers. Would you have time for and feel like
investigating that, by any chance, Barbara?

David Nelson

I'd definitely be glad to capture it somewhere. It seems like an extension of the "to-do" list that's on the wiki -- is that on Alfresco, too? (I haven't gotten into Alfresco at all yet, sorry -- I've been working from the wiki.)

Hi, :slight_smile:

I'd definitely be glad to capture it somewhere. It seems like an extension
of the "to-do" list that's on the wiki -- is that on Alfresco, too? (I
haven't gotten into Alfresco at all yet, sorry -- I've been working from the
wiki.)

It's becoming well worth getting into it... we're about 60% of the way
to a workflow, and the rest should be implemented quickly... it will
be much more organized and simple to manage on Alfresco... :wink:

Would you feel like giving it another trial...?

David Nelson

"Another"? Hadn't even started yet -- but OK, sure.