Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
D
Developer Documentation
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
brienne
Developer Documentation
Commits
1dcbc9f2
Commit
1dcbc9f2
authored
7 years ago
by
wmortada
Committed by
GitHub
7 years ago
Browse files
Options
Downloads
Patches
Plain Diff
Make it clear that the text is an example
Also remove some superfluous commas.
parent
3b42fae8
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/documentation/style-guide.md
+6
-4
6 additions, 4 deletions
docs/documentation/style-guide.md
with
6 additions
and
4 deletions
docs/documentation/style-guide.md
+
6
−
4
View file @
1dcbc9f2
...
...
@@ -59,25 +59,27 @@ Titles for parts, chapters, and sections should all be in sentence case
Menu selections, buttons, tabs (basically, things that the reader is
being told to click) should be in bold.
For example:
-
Navigate to
**Administer > CiviEvent > Event Types**
to review the
default list of event types.
-
Modify event type labels by clicking
**Edit**
on any row.
-
Click
**Add Event Type**
to create a new category for your events.
Elements of the system and interface should be capitalized (e.g.
,
the
Elements of the system and interface should be capitalized (e.g. the
Events component, the Template Title field).
It is also sometimes helpful for clarity when discussing concepts to use
capitalization to distinguish between a specific activity within CiviCRM
and a generic activity (e.g.
,
the Send Email activity versus sending an
and a generic activity (e.g. the Send Email activity versus sending an
email). However, sometimes it is too cumbersome or just plain weird to
capitalize every instance of a term even if it refers to a specific CiviCRM
thing or technical definition (e.g.
,
scheduled reminders, plain text).
thing or technical definition (e.g. scheduled reminders, plain text).
Use your best judgment as to what serves the reader; trying to enforce
consistency in this arena will slow us down or drive us crazy.
Quotes should be avoided as much as possible; however, do use them when
they seem necessary for clarity (e.g.
,
if you are talking about setting
they seem necessary for clarity (e.g. if you are talking about setting
or field labels that are long phrases).
You can divide the CiviCRM interface into administration pages and
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment