[platform-doc-dev] Style issues

["John Arthorne" <John_Arthorne@xxxxxxxxxx>]

I think we should agree on a standard way of referencing actions and preferences in the doc.  About half of the doc uses bold text when referencing menu actions, and half doesn't.  Most of the doc uses the ">" character to separate cascading submenus (for example, File > New > Project...).  I've seen a couple of places that use "/", and some that use "->". My personal preference is bold text using ">" signs (<b>File &gt; New &gt; Project...</b>).

For preferences, there are again a variety of styles.  Some places will give the full path to get to the preference (Window > Preferences > Workbench > File Associations), while some will just give the path within the preference dialog (Workbench > File Associations).  Again, there are a variety of separator styles; some are bold, and some aren't. Of all these, I like the style used in the platform tips and tricks document.  This style assumes the user knows how to find the preference dialog, and just gives a parenthetical bold reference to where in the dialog the preference is found.  For example: "There is a preference (<b>Workbench / File Associations</b>) for choosing which editor to open for a given file type".

Any thoughts?