{% extends 'markup/base.html' %} {% block pagetitle %}: Markup help{% endblock pagetitle %} {% block breadcrumb_items %} {{ block.super }} Help {% endblock %} {% load automarkup %} {% block content %}

Markup help

On many occasions while contributing to SciPost, one has to fill in a text-based field in a web form. For many reasons, it is desirable to give structure to what one writes. We offer markup facilities to enable you to do this.

We support three options:

Each of these supports LaTeX via MathJax, though the precise semantics varies from one option to the other.

The important point is that for each text field you fill in, you should choose one option (mixing will give errors).

Which one should you choose? This is mostly a question of personal preference. To help you decide, here is a quick summary of main points to bear in mind:
Option Advantages Disadvantages Recommended for
Plain text
  • Simplicity
  • No markup!
Anybody not wanting to bother with markup
Markdown
  • ease of use
  • purposefully simple
  • provides more or less all the markup you'll ever need, at least for small, simple snippets
  • non-standardized: many dozen "dialects" exist
  • facilities for some simple things (e.g. tables) are missing
  • not really meant for large, complex documents
Everybody wishing for or requiring markup
reStructuredText
  • relative ease of use
  • standardized: the language is well-defined and stable
  • it's the standard documentation language for Python; Sphinx uses ReST files as input
  • ReST files are easily exportable to other formats such as HTML, LaTeX etc.
  • support for maths is good, but remains less extensive than in LaTeX, and requires annoying indentation in multiline directives
Pythonistas and Sphinx aficionados

Which option you choose is completely up to you. Our system will automatically determine which one you are using and render your input accordingly.


Plain text  See our plain text-specific help page

{% for suggestion in PlainTextSuggestions %}

Example: {{ suggestion.title }}

If you write:

{{ suggestion.raw }}

You will get:

{{ suggestion.raw|automarkup }}
{% endfor %}

Markdown  See our Markdown-specific help page

{% for suggestion in MarkdownSuggestions %}

Example: {{ suggestion.title }}

If you write:

{{ suggestion.raw }}

You will get:

{{ suggestion.raw|automarkup }}
{% endfor %}

reStructuredText  See our reStructuredText-specific help page

{% for suggestion in ReSTSuggestions %}

Example: {{ suggestion.title }}

If you write:

{{ suggestion.raw }}

You will get:

{{ suggestion.raw|automarkup }}
{% endfor %}
{% endblock content %}