Islandora Style Guide
Examples: Basic Image Solution Pack, BagIt Module, JWPlayer
Each page should have a title and subsections. Please make sure that all descriptive text is under a heading.
Example: Virtual Machine Installation Page:
This section outlines...
This section outlines...
This section outlines...
As a general rule, please use the paragraph styles prebuilt/predefined in the Wiki (Atlassian Confluence). This will make our work efficient over time.
Example:
Page Title
Use page title for the page title. This is already built in and cannot be modified.
This is an H1 example. This is not used often. Use h2 instead to separate the main sections of the document.
This is an H2 example. Used to separate the main sections of the document.
This is an H3 example. Used to separate the sub-sections of the document. When inserting code, information boxes, warning boxes, quotes, notes, etc.. please take advantage of the predefined macros. Macros can be accessed using the Ctrl+Shift+A keyboard shortcut or from the main editing menu, click on “Insert more content” icon and select Other Macros from the expanded menu.
Examples:
Code Block:
Note:
Information:
Warning:
Follow the World Wide Web Consortium's (W3C) Web Content Accessibility Guidelines (WCAG) 2.0 AA.
Use of screenshots is encouraged as much as possible. In particular, for pages with lots of details use of screenshots is highly recommended.
Link to GitHub when pointing to content that only exists on GitHub or when referencing the source code for a module.