About this wiki

The goal of this wiki is to make the Responsive Framework easy to use and understand. As such, we've defined a number of conventions which help clarify what kind of information we're giving you where.

Editors: Please follow these conventions as you edit the wiki.

Conventions used within the Wiki

When we talk about code in our documentation, we use inline code syntax, like so:

---

The url attribute embeds media in the page using a URL of your choice.

---

When we talk about a larger code snippet in our documentation, we use code block syntax, like so:

[media url="http://www.bu.edu/buniverse/view/?v=1yRj5a1Z7"]
	Your video description text here
[/media]

When we have a non-code related example in our documentation, we use line breaks to separate it from the rest of our content, like so:

---

I could be an example of formatted content, or something else that doesn't fit well in a code block.

---

When we want you to have more information about something in our documentation, we use a blockquote to separate it from the rest of our content, like so:

Why do we do this? Blockquote syntax is used to provide further explanation for complicated concepts. While it is not strictly necessary for our process, you might want to know more about why we're having you do things a certain way.

Editors: To include multiple paragraphs in a blockquote, start each paragraph with a > . Multiple paragraphs using this symbol will collapse, creating a single blockquote with multiple paragraphs.

Editing the wiki

To help keep our wiki organized, we use folders. These aren't visible to you as a user of the wiki, but they allow us to give you better options for navigating our documentation.

Editing this wiki and keeping it up to date is highly encouraged. Please feel free to add, edit, or update pages on your own as needed. Don't worry - we're fully able to roll back your changes if we decide we don't like them! Please remember to keep wiki style in mind as you edit.

You can contribute to this wiki in two ways:

Option 1: Edit the page on Github.com

This is the simplest and easiest option, and appropriate for small changes, such as updating outdated code or adding a section to an existing page. This is sufficient for most purposes.

Option 2: Clone this repository and push your changes back

This option is good if you need to make a major edit to the wiki, such as adding a page or changing where in the folders a page lives. If you are more comfortable editing in a code editor, or you like the workflow of building themes, you might like this way better. To get started, simply clone this wiki's repository as normal !!! TODO: LINK, make your changes, and push back.

Adding a new page to the wiki

When adding a new page to the wiki, you need to clone the repository. This gives you access to the folder structure, so you can place your new page in the appropriate folder.

Please double check the following things when you create your new page:

• Page is in the most appropriate folder available
• Page is written well, with clear, well-formatted steps
• References to other information within the wiki are [linked relatively !!! TODO: PAGE](Markdown Basics)
• Page is formatted well, with clear section headings
• Page has a table of contents at the top, with a bolded label **Contents (here is a thing that will do that for you)
• Page adheres to wiki style
• Page is added to the sidebar in the directory it lives in

Editor's marks

To make it clear where information is still needed in the wiki, please use the following conventions inline with your content:

---

!!! TODO: LINK

---

!!! should apply to any needed change. LINK should be a description of the type of information that is missing. TODO should be a status of the problem information: in this example, TODO stands for something yet to be done.

These allow us to quickly find and update problem content as needed.