Agsbs Markdown Helper
===================

Latest Release for Sublime Text 3 is st3-0.6.1


This is a sublime plugin which is used in our working group. Our working group is transcribing study materials
for blind and visual impaired students ([Elvis - german Website](http://elvis.inf.tu-dresden.de)).

After the creation of the Markdown files a customized pandoc converter is used for the transformation to HTML
([pandoc-website](http://johnmacfarlane.net/pandoc/))

## The Plugin

The plugin offered different functions to fulfil our guidelines, add Markdown content and
helps unknown transcribers to create markdown-files.

<!--

A details description of all functions and shortcuts will be written soon.

### The directory structure of material

The shortcut F2 opens the dialog for the input of the title, chaptercount, language, preface.
You have the separats the values by | .
sampleBook|3|en|0
The plugin creates the following folders and files:

sampleBook/
k01/
k02/
k03/
.lecture_meta_data.dcxml





### Shortcut

There are shortcuts for the generation of content like folder structure, convert to HTML or check the md-content by our check-tool. All these commands are set to the function-keys (see table below)

#### Shortcuts for Generation/Conversion of content

| Shortcut | Explanation                                 | implemented for |
| -----    | -------                                     | ---             |
| F2       | create structure                            | Windows         |
| F3       | check selected Markdown-file                | Windows         |
| F4       | check all Markdown-files in (parent)-folder | Windows         |
| F5       | convert the selected Markdown-file to HTML  | Windows         |
| F6       | generated HTML from all Markdown-files      | Windows         |
| F7       | Open Configuration file                     | Windows         |

#### Shortcuts for the transcription

The following shortcuts helps during the transcriptions and are working for Windows, Linux and OS X.

| Shortcut    | Selection required | Explanation                                                                  |
| ----------  | --------------     | -------------------------------------------------------------------------    |
| ALT+SHIFT+H | yes                | insert heading markdown for level 1, multiple input is supported             |
| ALT+SHIFT+R | no                 | horizontal row                                                               |
| ALT+SHIFT+R | yes                | markdown syntax for italic                                                   |
| ALT+SHIFT+S | yes                | markdown syntax for strong/bold                                              |
| ALT+SHIFT+O | yes                | ordered list                                                                 |
| ALT+SHIFT+U | yes                | unordered list                                                               |
| ALT+SHIFT+Q | yes                | quotes                                                                       |
| ALT+SHIFT+T | no                 | table syntax                                                                 |
| ALT+SHIFT+C | yes                | insert tabs for code format                                                  |
| ALT+SHIFT+L | no                 | markdown syntax for a link, input the link text and URL via inputs fields    |
| ALT+SHIFT+P | no                 | add syntax for page, input page number below                                 |
| CTRL+ALT+I  | no                 | markdown syntax for image and alternative description, input via text fields |


-->