General Design Guidance
Below are some general design guidelines for maintaining the look of the CommCare Help Site.
Page Structure
Avoid Child Pages
In an effort to streamline the user experience and improve search-ability, please avoid child pages. Instead, you can make longer pages easier to navigate by using tools such as the https://confluence.atlassian.com/doc/expand-macro-223222352.html .
Associated Software Plans
Ensuring that all pages with features that refer to software plans are audited and have the most up to date software plan. Use the https://dimagi.atlassian.net/wiki/spaces/commcarepublic/pages/edit-v2/2213576737#Software-Plans below for this.
Table of Contents
In order to see information in a page, please ensure that your pages have a Table of Contents at the top. This requires using headers in formatting.
(Occasionally) Use of Excerpts at the top
To automatically reference the topic of Child Pages in parent pages, we use the Excerpt Macro. You will see this throughout pages: https://confluence.atlassian.com/doc/excerpt-macro-148062.html
Page Design
Referenced links
Please reference Confluence links like this by copying them directly in CommCare Messaging , not hyperlinked text. This prevents links from breaking. If an external page does not pop up as a referenced link, you can use the hyperlink text as backup.
Consistent Spacing & Bullet Points
Overall the site should maintain a clean look with consistent spacing and bullet points.
“Skinny” pages for readability
To change this, you can select the button to the top right
Site-Wide Multi-Excerpts
Confluence supports a macro called https://marketplace.atlassian.com/apps/169/multiexcerpt?tab=overview&hosting=cloud that allows you to reference source information, copy it into different places, and automatically update all information by updates the source.
The below are referenced throughout the CommCare Help Site. When using them, please copy the “Copy into Pages” version.
Software Plan Multi-Excerpts
Standard
Original (Don’t Touch)
This feature requires a CommCare Software Plan
This feature is only available to CommCare users with a Standard Plan or above. For more details, please see the CommCare Pricing Overview.
Copy Into Pages
This feature requires a CommCare Software Plan This feature is only available to CommCare users with a Standard Plan or above. For more details, please see the CommCare Pricing Overview.
Pro Plan
Original (Don’t Touch)
This feature requires a CommCare Software Plan
This feature is only available to CommCare users with a Pro Plan or above. For more details, please see the CommCare Pricing Overview.
Referenced (Copy this in Pages)
This feature requires a CommCare Software Plan This feature is only available to CommCare users with a Pro Plan or above. For more details, please see the CommCare Pricing Overview.
Advanced Plan
Original (Don’t Touch)
This feature requires a CommCare Software Plan
This feature is only available to CommCare users with an Advanced Plan or above. For more details, please see the CommCare Pricing Overview.
Referenced (Copy this in Pages)
This feature requires a CommCare Software Plan This feature is only available to CommCare users with an Advanced Plan or above. For more details, please see the CommCare Pricing Overview.
Enterprise Software Plan
Original (Don’t Touch)
This feature requires a CommCare Software Plan
This feature is only available to CommCare users with an Enterprise Plan. For more details, please see the CommCare Pricing Overview.
Referenced (Copy this in Pages)
This feature is only available to Enterprise Partners Learn more about the CommCare Enterprise offering here: https://dimagi.com/commcare-enterprise/
Other Multi-Excerpts
Community of Practice
Original (Don’t Touch)
These features are supported by the CommCare Community of Practice.
While Support for these features is not included as part of your CommCare subscription, please feel free to refer any questions or issues about the content of these pages to the CommCare Forum.
Referenced (Copy this in Pages)
These features are supported by the CommCare Community of Practice. While Support for these features is not included as part of your CommCare subscription, please feel free to refer any questions or issues about the content of these pages to the CommCare Forum.
Requires Professional Services
Original (Don’t Touch)
This offering requires professional services from Dimagi
Due to the support burden of this feature, this is only available through direct support from Dimagi staff. Please reach out to info@dimagi.com for more information.
Referenced (Copy this in Pages)
This offering requires professional services from Dimagi This is only available through direct support from Dimagi staff. Please reach out to info@dimagi.com for more information.
Up to Date Version
Original (Don’t Touch)
Make sure that you are running the most up to date version of CommCare
While it’s always best practice to run the most recent version of CommCare, it is especially important with these instructions. Please follow these instructions here: Upgrading to the Latest Mobile Version
Referenced (Copy this in Pages)
Make sure that you are running the most up to date version of CommCare While it’s always best practice to run the most recent version of CommCare, it is especially important with these instructions. Please follow these instructions here: Upgrading to the Latest Mobile Version
Technical Instructions
Original (Don’t Touch)
Please note the documentation below requires more technical expertise
The documentation below may require knowledge of more technical software management and development topics.
Please note the documentation below requires more technical expertise The documentation below may require knowledge of more technical software management and development topics.