Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

This is a custom Confluence template that is intended to be re-used in the creation of workshops presented by ARCC on the Wiki. All of the content in these sections is intended to be replaced by the author of the workshop. The first step in this style guide is to ensure that the the page is in wide mode to maximize the real estate for content when possible. The Title of the Page should be the same as the Title of the workshop and this section should include a quick intro to the topic, why it’s important for ARCC users, and what users should expect to get out of this workshop. Next should be a Table of Contents macro in vertical format. The Table is intended to be used as an agenda section for presenter mode as well as navigation for non-presenting viewing so that users can find the documentation and navigate to what they need to brush up on. Finally, at the end of each section, there should be a divider to indicate the separation of “slides”



Headers and Sections

Each sections should start with a header of ‘Heading 1’. This helps to make sure that the Table of Contents operates like an agenda. Also it helps when we “advance a slide” it jumps to the top of the section. Each section should be limited in length to no more than 14 lines of straight text to ensure that when presenting it can be viewed as a “Slide”.













This is 14 lines A.K.A the End.


Code Examples

Two Column Tables are nice ways to separate content/ Background info along with a code example on the same “Slide”. Please notice the table width. This should stop scroll bars from appearing

  • Bullets are nice to include for distinct points

  • yep

  • they

  • sure

  • are

    This is 14 lines

Please use the "code snippet" in the + button when creating code examples. Also please do not go
past the width of the table. This is to prevent scroll bars appearing













This is the Max number of code lines to show on an example

Straight Code - No context

Limit to 16 lines in the example. 














This is the end

Same Thing With Images

Two Column Tables are nice ways to separate content/ Background info along with an image example on the same “Slide”. Please notice the table width. This should stop scroll bars from appearing

  • Bullets are nice to include for distinct points

  • yep

  • they

  • sure

  • are

    This is 14 lines

image-20240514-000033.png


Alternatively No Table

image-20240514-000127.png


Finally The End

Link to Previous sub-module or Home Module

Align left link to next sub-module or home

  • No labels