HELP ON USING SPEAGRAM LIVE FILES

Live files allow you to edit and run Speagram directly from the Web. You can create them using our live interface and if you want to use them from an application you can query them from PHP.

Each live file consists of a number of parts which are used to group related content, for example all the elements that define a class or all the rules that define a function. You can operate on each part separately and use the attached buttons to edit it or run the Speagram code inside that part. You should remember that the code in a given part is always run in the context of the code from all parts above it, so the order of parts in your document is relevant. You can move parts up and down the document using the up and down buttons. To make editing and viewing easier you can use the hide button to contract a part and see just a summary of its first lines.

At the top of each live file on the right side there is a button that allows you to save the file on the server. Whenever a live file is saved we create a backup copy that remains available through the live interface. To save a file you must know and enter the key to that file. The key is specified at the moment when the file is created and can be empty if you want to allow everyone to edit your file. You should be aware that on the server the keys are never stored or processed in unencrypted form, but the transmission from your computer to our server is currently not encrypted.

Formatting rules when editing live files

When you click edit in a live file you can enter any text into the box. But if you want to add links, bold or preformatted text, paragraph breaks and Speagram code then you must obey the following simple wiki-like formatting rules.

To create a new paragraph in the text just leave one blank line.

  This is the first paragraph.

  This is the second paragraph, notice the blank line in between.

To enter Speagram code that can then be run with the run button enclose it inside %$ and $% delimiters.
```
  This is normal text and %$ this is Speagram code $% and text again.
```
To make a part of your text bold enclose it within double apostrophes ('').
```
  You can have a ''bold part'' inside your text.
```
To create a preformatted text fragment enclose it inside %P and P% delimiters.
```
  Now we enter a %P preformatted text part P% into this part.
```
To create links to other web pages use double brackets. You can either just enter the URL inside the brackets ([[url]]) or write the URL, a | and then a description ([[url|description]]).
```
  We can link to [[http://www.google.com]] but as you might not want to
  see the whole address let's write [[http://www.google.com|Google]].
 
```