To help user understand and identify the features that you describe, make capitalization consistent in all the texts that you create.
Use initial capitalization for adjectives in running text that can be preceded by the word the.
Note: Do not capitalize the noun that follows. For example: the Single Value mode For example: the Clipboard tool For example: the Process category
Do not capitalize adjectives preceded with a or an.
For example: a clipboard page that For example: a decision table that
For historical reasons, names of some rule types for connectors and services use initial capitalization.
For example: a Connect SQL rule For example: a SOAP Service rule For example: an Access of Role to Object rule
When spelling out abbreviations and acronyms, verify the capitalization of the individual words.Not all abbreviations and acronyms are capitalized when spelled out. See Microsoft Style for guidelines and Abbreviations and acronyms dictionary for the spelled-out form of many abbreviations and acronyms (be sure to look at the entry for the term for correct capitalization, not just the alphabetical list).
For example: SOAP (Simple Object Access Protocol) For example: SSO (single sign-on)
Capitalize the names of rule forms when the sentence is referring to the actual rule form.
For example: the Property form For example: the Activity form For example: Select a control on the General tab of the Property form.
For names of specific individual rules, use an exact case, as found on the form header or in the rule XML.
For example: the CopyCustomerInfo data transform For example: the pyLabel property
When referencing the runtime appearance of Pega objects, follow the user interface.Examples include: fields, controls, placeholder text, labels, links, and buttons.
If you see camel case, remind your engineering teams to strip camel case from their UI.The UI conventions for capitalization are:
- Labels on fields use sentence case and are instructive where possible.
- Placeholder text is in sentence case.
- Rule names no longer use camel case, for example, RuleSet is now ruleset.
- Labels on containers (layouts) and grids are in all caps because the style is inherited from the skin.
For other capitalization cases, use the following guidelines:
- For captions, use sentence style.
- For course names, use headline style.
- For glossary terms, use all lowercase unless the term is usually capitalized.
- For headers in help, use sentence style.
- For lesson group names, use headline style.
- For lesson titles, use headline style.
- For Pega Community article titles, use sentence style.
- For topic titles, use sentence style.
- For video titles, use headline style.
- Punctuation guidelines
Ensure that you use punctuation correctly to create clear and unambiguous documentation.
Previous topic Language and grammar Next topic Punctuation guidelines