Inclusive Learning Design Handbook Contributor's Guide

Owned by Jonathan Hung
Last updated: Dec 23, 2015
3 min read

This is work in progress.

 

Outline:

  • How to contribute
    • Prepare your content
    • Sign-up for github
    • Fork the ILDH
    • Add / modify the appropriate content file
      • explain how content is structured and which files are editable
    • push to github
    • issue a pull request
  • Markdown syntax
    • Front matter
    • How to do external links
    • figure with figcaptions
    • header hierarchy
    • Others?

How to Contribute

The Inclusive Learning Design Handbook uses Github to host its content. The following instructions outline the steps required in order to contribute to the ILDH.

Getting Set Up with Github

  1. Prepare your content using a word processor or text-editor.
  2. Sign-up for a user account on Github.
  3. Login to your account on Github
  4. Go to the Inclusive Learning Design Handbook repository and make a copy of it by forking the repository to your account by selecting the Fork button near the top of the screen.
  5. Once the repository has been forked, go back to the Github main page and select 'docs-inclusive-learning' under the "Your repositories" list.
  6. You should now be in your own personal copy of the ILDH repository. You are done.

The next section describes the process of editing and contributing content to the ILDH.

Using Github.com to Edit or Create Content

You can use Github to directly create or edit content in the ILDH. The following are instructions on how to do this.

  1. Start from the forked copy of the ILDH in your account, then select the src folder and then the documents folder.
  2. Inside the documents folder you should now see a list of many files - these are the content pages for the ILDH.
  3. To create a new document, choose the "New" button near the top of the page.
  4. To edit an existing document first select a file from the list, then choose the pencil icon located in the top-right corner.
  5. You are now ready to start editing or creating content. The next section describes how to format your content so it appears properly in the ILDH.

Content Creation Guide

The ILDH uses a document syntax called Markdown to format content. Markdown goes into plain text files and gets interpreted by another application to output the correct formatting. In the ILDH, a basic content file looks like this:

---
title: Learner Needs and Preferences
subheader: Floe references: Learner Options (aka User Interface Options)
layout: default
category: Methods
---

The key principle behind [inclusive learning](InclusiveLearning.html) is the ability for learning resources to be malleable and transformable with respect to learner needs and preferences. This enables learners who have articulated their particular needs and preferences (whether implicitly or explicitly) to be given learning content in a format that they can fully interact with, understand, and consume (see [Accessibility principles](AccessibilityPrinciples.html) for perceivable, operable, understandable, and robust content).

Learners should be able to articulate their needs and preferences, and have returned to them content packaged in a way that meets those requirements.

## Take Away
* Users have individual needs and preferences when it comes to content
* The presentation and interaction to content should be flexible
* Learners should be able to articulate those needs and preferences, and have appropriate content returned
* See a <a href="http://build.fluidproject.org/infusion/demos/prefsFramework/" rel="nofollow" target="_blank" class="link-external">demo of the current version of Floe Learner Options</a>

 

The first 6 lines of the text document is called "Front Matter". This is information tells the site how to build its navigation and what content layout to use. In your content you will need these six lines at the start of the file.

  • title: A short title that will appear in the navigation and at the top of the content page. All titles should be unique to avoid confusion.

  • subheader: An optional subtitle that appears below the title.

  • layout: 'default' layout is should be used.
  • category: The category the content belongs under. The categories are the major navigation links that appear in the header. Currently the categories are: Introduction, Methods, Accessible Standardized Testing, and Inclusive EPUB 3.
  •  

 

Â