build details

Show: section status errors & todos local changes recent changes last change in-page changes feedback controls

Special paragraphs and environments

✎

Modified 2018-06-02 by Andrea Censi

Special paragraphs tags

✎

Modified 2019-04-28 by tanij

The system supports parsing of some special paragraphs.

Special paragraphs must be separated by a line

✎

Modified 2018-06-02 by Andrea Censi

A special paragraph is marked by a special prefix. The list of special prefixes is given in the next section.

There must be an empty line before a special paragraph; this is because in Markdown a paragraph starts only after an empty line.

This is checked automatically, and the compilation will abort if the mistake is found.

For example, this is invalid:

See: this book
See: this other book

This is correct:

See: this book

See: this other book

Similarly, this is invalid:

Author: author
Maintainer: maintainer

and this is correct:

Author: author

Maintainer: maintainer

Todos, task markers

✎

Modified 2018-06-02 by Andrea Censi

TODO: todo

TODO: todo

previous task next (2 of 5) index
task

The following was marked as "todo".

TODO: todo

Location not known more precisely.

Created by function n/a in module n/a.
TOWRITE: towrite

towrite

previous task next (3 of 5) index
task

The following was marked as "special-par-towrite".

towrite

Location not known more precisely.

Created by function n/a in module n/a.
Task: task

task

Assigned: assigned

assigned

previous task next (4 of 5) index
task

The following was marked as "special-par-assigned".

assigned

Location not known more precisely.

Created by function n/a in module n/a.

Notes and remarks

✎

Modified 2018-06-02 by Andrea Censi

Remark: remark

remark

Note: note

note

Warning: warning

warning

Troubleshooting

✎

Modified 2018-06-02 by Andrea Censi

Symptom: symptom

symptom

Resolution: resolution

resolution

Guidelines

✎

Modified 2018-06-02 by Andrea Censi

Bad: bad

bad

Better: better

better

Questions and answers

✎

Modified 2018-06-02 by Andrea Censi

Q: question

question

A: answer

answer

Authors, maintainers, Point of Contact

✎

Modified 2019-04-27 by tanij

Maintainer: maintainer

Maintainer: maintainer

Assigned: AndreaCensi

AndreaCensi

previous task (5 of 5) index
task

The following was marked as "special-par-assigned".

AndreaCensi

Location not known more precisely.

Created by function n/a in module n/a.

References

✎

Modified 2018-06-02 by Andrea Censi

See: see

see

Reference: reference

reference

Requires: requires

requires

Results: results

results

Next steps: next steps

next steps

Recommended: recommended
See also: see also

see also

Other div environments

✎

Modified 2018-06-02 by Andrea Censi

For these, note the rules:

  • You must include markdown="1".
  • There must be an empty line after the first div and before the closing /div.

Example usage

✎

Modified 2018-06-02 by Andrea Censi

<div class='example-usage' markdown="1">

This is how you can use `rosbag`:

    $ rosbag play log.bag

</div>

This is how you can use rosbag:

$ rosbag play log.bag

Check

✎

Modified 2018-06-02 by Andrea Censi

<div class='check' markdown="1">

Check that you didn't forget anything.

</div>

Check that you didn’t forget anything.

Requirements

✎

Modified 2018-06-02 by Andrea Censi

<div class='requirements' markdown="1">

List of requirements at the beginning of setup chapter.

</div>

List of requirements at the beginning of setup chapter.