diff options
Diffstat (limited to 'doc/api/qtcreator-ui-text.qdoc')
| -rw-r--r-- | doc/api/qtcreator-ui-text.qdoc | 267 |
1 files changed, 132 insertions, 135 deletions
diff --git a/doc/api/qtcreator-ui-text.qdoc b/doc/api/qtcreator-ui-text.qdoc index 4ca8091517..55425b7bdd 100644 --- a/doc/api/qtcreator-ui-text.qdoc +++ b/doc/api/qtcreator-ui-text.qdoc @@ -31,15 +31,15 @@ \list - \o Consistent with existing Qt Creator UI terms + \li Consistent with existing Qt Creator UI terms - \o Short and concise + \li Short and concise - \o Neutral, descriptive, and factually correct + \li Neutral, descriptive, and factually correct - \o Unambigious + \li Unambigious - \o Translatable into different languages + \li Translatable into different languages \endlist @@ -75,21 +75,21 @@ \list - \o Use full stops in messages. + \li Use full stops in messages. - \o Never user full stops (.) at the end of menu item names. + \li Never user full stops (.) at the end of menu item names. - \o Place three full stops (...) at the end of menu item names that - open a dialog requiring user action. + \li Place three full stops (...) at the end of menu item names that + open a dialog requiring user action. - \o Use exclamation marks (!) only in text that demands extra attention - from the user or carries special weight. + \li Use exclamation marks (!) only in text that demands extra attention + from the user or carries special weight. - \o Use quotation marks ("") around variable values. For example, - \gui {Close Project "qtcreator"}. + \li Use quotation marks ("") around variable values. For example, + \gui {Close Project "qtcreator"}. - \o Do not use leading, trailing, or multiple spaces to align text in - messages, as translation tools might not handle them correctly. + \li Do not use leading, trailing, or multiple spaces to align text in + messages, as translation tools might not handle them correctly. \endlist @@ -139,15 +139,15 @@ \list - \o Cannot send log as selected message type. Text is too long. + \li Cannot send log as selected message type. Text is too long. - \o Cannot receive image. + \li Cannot receive image. - \o Cannot insert picture. Maximum text length is 120 characters. + \li Cannot insert picture. Maximum text length is 120 characters. - \o Image name already in use. + \li Image name already in use. - \o Folder name already in use. + \li Folder name already in use. \endlist @@ -157,9 +157,9 @@ \list - \o Example of Book Title Capitalization + \li Example of Book Title Capitalization - \o Example of sentence style capitalization + \li Example of sentence style capitalization \endlist @@ -175,13 +175,11 @@ \list - \o Titles (window, dialog, group box, tab, list view columns, and so - on) + \li Titles (window, dialog, group box, tab, list view columns, and so on) - \o Functions (menu items, buttons) + \li Functions (menu items, buttons) - \o Selectable items (combobox items, listbox items, tree list items, - and so on) + \li Selectable items (combobox items, listbox items, tree list items, and so on) \endlist @@ -193,11 +191,11 @@ \list 1 - \o Open to-title-case.html in a browser. + \li Open to-title-case.html in a browser. - \o Enter the UI text in the field. + \li Enter the UI text in the field. - \o Click \gui Convert. + \li Click \gui Convert. \endlist @@ -219,13 +217,13 @@ \list - \o Labels + \li Labels - \o Tool tips + \li Tool tips - \o Descriptive text + \li Descriptive text - \o Other non-heading or title text + \li Other non-heading or title text \endlist @@ -262,50 +260,50 @@ \table \header - \o Features of Languages or Writing Systems - \o Impact on Implementation + \li Features of Languages or Writing Systems + \li Impact on Implementation \row - \o Word order - \o Different languages have different word order rules. + \li Word order + \li Different languages have different word order rules. - Do not use run-time concatenation. Use complete phrases - and "%1" formatting instead. For example, use: + Do not use run-time concatenation. Use complete phrases + and "%1" formatting instead. For example, use: - \c{tr("Foo failed: %1").arg(message)} + \c{tr("Foo failed: %1").arg(message)} - instead of + instead of - \c {tr("Foo failed: ") + message} + \c {tr("Foo failed: ") + message} \row - \o Singular vs. plural vs. dual forms - \o Some languages do not have plural form (for example, Chinese - and Japanese), whereas some have a different form for dual. + \li Singular vs. plural vs. dual forms + \li Some languages do not have plural form (for example, Chinese + and Japanese), whereas some have a different form for dual. - Allow room for text expansion in the layout design. Some - languages need more space to indicate plurality or duality to - convey the needed information. + Allow room for text expansion in the layout design. Some + languages need more space to indicate plurality or duality to + convey the needed information. - For example, use + For example, use - \c {tr("%n files found", 0, number)} + \c {tr("%n files found", 0, number)} - instead of + instead of - \c {tr("%1 files found").arg(number)} + \c {tr("%1 files found").arg(number)} \row - \o Gender - \o Some languages have gender (feminine, masculine, neutral), - whereas some do not (for example, Finnish) or do not use it - extensively (for example, English). + \li Gender + \li Some languages have gender (feminine, masculine, neutral), + whereas some do not (for example, Finnish) or do not use it + extensively (for example, English). - Do not reuse text strings. The same term may not work in - another context due to the gender of the base word. + Do not reuse text strings. The same term may not work in + another context due to the gender of the base word. - Articles have a grammatical gender in some languages and - sentences cannot be as easily constructed as in English. Avoid - following types of constructs: + Articles have a grammatical gender in some languages and + sentences cannot be as easily constructed as in English. Avoid + following types of constructs: - \c {tr("%1 failed").arg(someCondition ? "the operation" : "opening a file")} + \c {tr("%1 failed").arg(someCondition ? "the operation" : "opening a file")} \endtable \section1 Common Qt Creator Terms @@ -323,88 +321,87 @@ \table \header - \o UI Text - \o Usage - \o Conventions + \li UI Text + \li Usage + \li Conventions \row - \o Context menu - \o Opens when users right-click on the screen. Contents depend on - the context. - \image qtcreator-context-menu.png "Context menu" - \o You can add menu items that are relevant in a particular - context. Follow the conventions for naming menu items. + \li Context menu + \li Opens when users right-click on the screen. Contents depend on + the context. + \image qtcreator-context-menu.png "Context menu" + \li You can add menu items that are relevant in a particular + context. Follow the conventions for naming menu items. \row - \o Dialog - \o User interface element that usually contains a number of - choices or allows the user to give input to the application. - Opens when users select a menu item or button. - \image qtcreator-dialog.png "Dialog" - \o Use the menu item or button name as the dialog name. You can - also combine the menu item or button name and the name of the - object that is managed in the dialog. For example, the \gui Add - button in the \gui Documentation options opens the - \gui {Add Documentation} dialog. + \li Dialog + \li User interface element that usually contains a number of + choices or allows the user to give input to the application. + Opens when users select a menu item or button. + \image qtcreator-dialog.png "Dialog" + \li Use the menu item or button name as the dialog name. You can + also combine the menu item or button name and the name of the + object that is managed in the dialog. For example, the \gui Add + button in the \gui Documentation options opens the + \gui {Add Documentation} dialog. \row - \o Locator - \o Allows you to browse not only files, but any items defined by - locator filters. - \image qtcreator-locator.png "Locator" - \o You can add locator filters. Check that the filter is not - already in use and give the filter a descriptive name. + \li Locator + \li Allows you to browse not only files, but any items defined by + locator filters. + \image qtcreator-locator.png "Locator" + \li You can add locator filters. Check that the filter is not + already in use and give the filter a descriptive name. \row - \o Menu - \o Contains menu items that represent commands or options and that - are logically grouped and displayed. A menu can also contain - submenus. - \image qtcreator-menu.png "Menu" - \o You can create new menus. Use short, but descriptive names that - are consistent with existing menu names. Use unambigious names. + \li Menu + \li Contains menu items that represent commands or options and that + are logically grouped and displayed. A menu can also contain + submenus. + \image qtcreator-menu.png "Menu" + \li You can create new menus. Use short, but descriptive names that + are consistent with existing menu names. Use unambigious names. \row - \o Menu item - \o Represents a command or an option for users to choose. - \image qtcreator-menu-item.png "Menu item" - \o You can add new items to menus. Use short, but descriptive - names that are consistent with existing menu names. Use - unambigious names. + \li Menu item + \li Represents a command or an option for users to choose. + \image qtcreator-menu-item.png "Menu item" + \li You can add new items to menus. Use short, but descriptive + names that are consistent with existing menu names. Use + unambigious names. \row - \o Message box - \o Dialog that provides feedback to users, in the form of status - information, a warning, or an error message. - \image qtcreator-error-message.png "Message box" - Output from Qt Creator should be displayed in output panes, - instead. - \o Use the event as the title and provide a solution in the - message box. + \li Message box + \li Dialog that provides feedback to users, in the form of status + information, a warning, or an error message. + \image qtcreator-error-message.png "Message box" + Output from Qt Creator should be displayed in output panes, + instead. + \li Use the event as the title and provide a solution in the + message box. \row - \o Mode - \o Modes correspond to complete screens of controls, specialized - for a task. - \image qtcreator-mode-selector.png "Mode selector" - \o You can add a mode for a new type of editor, for example. - Use descriptive, but short mode names. They have to fit in the - \gui {Mode selector}. + \li Mode + \li Modes correspond to complete screens of controls, specialized + for a task. + \image qtcreator-mode-selector.png "Mode selector" + \li You can add a mode for a new type of editor, for example. + Use descriptive, but short mode names. They have to fit in the + \gui {Mode selector}. \row - \o Output pane - \o A pane displayed in the task pane that displays output from Qt - Creator. - \image qtcreator-output-pane.png "Output pane" - \o Use descriptive names for output panes. + \li Output pane + \li A pane displayed in the task pane that displays output from Qt Creator. + \image qtcreator-output-pane.png "Output pane" + \li Use descriptive names for output panes. \row - \o Sidebar - \o A view available in the \gui Edit and \gui Debug modes that - you can use to browse projects, files, and bookmarks, and to - view the class hierarchy. - \image qtcreator-sidebar-menu.png "Sidebar" - \o You can add views to the sidebar menu. Use descriptive names - for them. + \li Sidebar + \li A view available in the \gui Edit and \gui Debug modes that + you can use to browse projects, files, and bookmarks, and to + view the class hierarchy. + \image qtcreator-sidebar-menu.png "Sidebar" + \li You can add views to the sidebar menu. Use descriptive names + for them. \row - \o View - \o An area of the screen that displays information for users and - provides them with functions for managing the information. - Available in \gui Debug mode, for interaction with the program - that is running under the control of the debugger. - \image qtcreator-debugger-views.png "Views" - \o Use descriptive names for views. + \li View + \li An area of the screen that displays information for users and + provides them with functions for managing the information. + Available in \gui Debug mode, for interaction with the program + that is running under the control of the debugger. + \image qtcreator-debugger-views.png "Views" + \li Use descriptive names for views. \endtable */ |