Skip to content

Phaidra flavored Markdown

mlent edited this page Oct 7, 2014 · 9 revisions

Learning content served to the frontend is parsed through an extended version of Python-Markdown.

Some of the features to enhance ease-of-editing include:

  • Setting the language attribute on text
  • Highlighting 'tips' for the user.
  • Audio elements
  • Inflection/Conjugation Tables
    • Cell highlighting
    • Cell check-off
  • Word Breakdowns

Setting the language attribute on text

All Greek text should be denoted as such, so that we can use the best, most readable font face and size.

`grc: ἡ ἡμέρα` - the day

Note to self: Can/should Greek be automatically wrapped? What implications would this have for the workflow for other languages (especially those that need special fonts)?


Marking the Morphology of a Word

Marking the morphology of a word allows our system to highlight that word if the user gets a related question incorrect.

`grc(fem,sg,nom): ἡ ἡμέρα`

Note to self: Investigate more readable alternatives...


Highlighting 'tips' for the user

!!! tip
Ancient Greek is full of irregularities!

(see Adminion, Markdown extension)


Audio elements

When you want to embed a sound file on the page.

@[/static/audio/path/to/file.wav]

Inflection/Conjugation Tables

You can use essentially the same syntax as you would to render a normal table in Markdown, but with some added features.

| Case        | Singular     | Plural                   |
| ----------- |:------------:| ------------------------:|
| Nominative  | `grc:ὁ`      | `grc:οἱ`   {: .checked } |
| Genitive    | `grc:τοῦ`    | `grc:τῶν`  {: .checked } |
| Dative      | `grc:τῷ`     | `grc:τοῖς` {: .checked } |
| Accusative  | `grc:τόν`    | `grc:τούς` {: .checked } |
| Vocative    | -            | -                        |

You can add these markers to inflection and conjugation tables:

  • {: .checked } - Creates a checkmark (adds the class 'checked' to that table)

Word Breakdowns

Say you want to break a word into its parts and point out what they each mean (for example: verb stem + futuristic sigma + ending => whoa!)

[`grc:ἔ`   >   Past Indicative Augment ]
[`grc:λιπ` >   Verb Stem               ]
[`grc:ον`  >   Ending                  ]

Developer Guide

Backend

Frontend

Content Guide

What did you break?

  • Postgres Database
  • Neo4j
  • Django
  • "The server"
  • Git
  • UI
Clone this wiki locally