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

[libreoffice-documentation] some style and formatting issues for discussion


Hi All,

It would be helpful to discuss and agree on some style and formatting issues that are not fully covered in the Contributor Guide. These are all small issues but it would be good to have more consistency. If time, perhaps these issues could be discussed tomorrow. We can then update the Contributor Guide to reflect this agreement. Here goes:

Menu, title, and status are bars. All others are toolbars. Correct?

Should names of bars/toolbars be capitalized? That is, menu bar or Menu bar; formatting toolbar or Formatting toolbar?

The names of GUI elements should match what is on the screen. However, capitalization of those elements is inconsistent. Sometimes only the first word of the name is capitalized, sometimes other words are also capitalized. What should the policy be for documentation? Perhaps the UX folks have a policy that we can follow.

How should GUI elements be formatted? Clearly MenuPath should be used for instructions such as *View > Toolbars > Drawing.* But what is considered a menu path? And when should emphasis be used?

What should be used:

*

Select Stack series to show cumulative Y values above each other.

*

Select *Stack series* to show cumulative Y values above each other.

*

Select /Stack series/ to show cumulative Y values above each other.

*

Something else?

What should be used:

*

Also adjusted is the 3D angle of the disc in the /Perspective/ page
in the same set of tabs.

*

Also adjusted is the 3D angle of the disc in the *Perspective*page
in the same set of tabs.

*

Also adjusted is the 3D angle of the disc in the Perspectivepage in
the same set of tabs.

What should be used?

*

When “Data series as columns” and “First row as labels” are selected
on the Data Range page

*

When *Data series as columns*and *First row as labels*are selected
on the Data Range page

*

When /Data series as columns/and /First row as labels/are selected
on the Data Range page

Should it be: Step 1 or step 1? Should it be page 1 or Page 1?

I look forward to hearing what people think and imagine that other people have similar nit-picking issues that they could add.


--
To unsubscribe e-mail to: documentation+unsubscribe@global.libreoffice.org
Problems? https://www.libreoffice.org/get-help/mailing-lists/how-to-unsubscribe/
Posting guidelines + more: https://wiki.documentfoundation.org/Netiquette
List archive: https://listarchives.libreoffice.org/global/documentation/
Privacy Policy: https://www.documentfoundation.org/privacy

Privacy Policy | Impressum (Legal Info) | Copyright information: Unless otherwise specified, all text and images on this website are licensed under the Creative Commons Attribution-Share Alike 3.0 License. This does not include the source code of LibreOffice, which is licensed under the Mozilla Public License (MPLv2). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.