×

WHAT?

↹instructionWO☈D is designed with learning as a focus. The main idea is to have a place to post your code, so others can offer suggestions about improvements or solve issues. If you post some code, others members can make changes to your snippet without affecting your original. Each snippet posted also gets its own chat channel

Below are listed the main units used on ↹instructionWO☈D:

• SNIPPET

  • Usually represents the contents of one source file, a function/method or any small section of code
  • It's probably best to post as much code as possible, to give context to your snippet
  • A snippet can act as a title for a Project (see below)

• CHAT

  • Every snippet has its own attached chat channel
  • The idea behind the chat is to quickly clarify anything about the snippet or the edits attached to the snippet
  • The chat channels for each snippet should refer to the snippet wherever possible

• EDIT

  • When you alter an existing snippet, an edit is attached to it. The original is left unchanged
  • The next time you select that snippet, a list of edits will appear in the right panel
  • Please ensure that you also edit the description of the original snippet, this will explain why you are editing the original

• EDITS LIST

  • On the right panel, any edits that have been made to the selected snippet will be listed
  • Clicking on an edit from the snippet edits list will load that edit in place of the original snippet
  • At the top of the snippet edits list is a link back to the original snippet

• PROJECT

  • Make a new snippet that represents the basis of the project
  • The 'base' snippet doesn't need any code content, it might just be a description of the project
  • When you edit this 'base' snippet, completely replace its contents with a source file of the project
  • Each edit you make to the 'base' snippet will be the contents of a new file.

HOW?

LOAD A SNIPPET:

In the right panel, click on the LOAD A SNIPPET button. You'll then be able to select an existing snippet from the list

STORE A NEW SNIPPET:

Log in and make sure you are not viewing any existing snippet. If you are viewing an existing snipper, press the CLEAR button. Enter a title and description then enter the actual text for the snippet. Click SAVE and your snippet will be entered

MAKE AN EDIT: Select the snippet you want to edit. Change the description to inform visitors why you are making an edit. Click SAVE and your edit will be attached to the snippet

MAKE A PROJECT: Create a new snippet and give it the title of the project and a brief description. The snippet text should be a more in depth description of the project. To add a file to the project, just add edits and paste the code for each file as a new edit.