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 (3 of 12) 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 (4 of 12) 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 (5 of 12) 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 next (6 of 12) 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.

Notes and questions

Modified 2018-06-02 by Andrea Censi

There are three environments: “comment”, “question”, “doubt”, that result in boxes that can be expanded by the user.

These are the one-paragraph forms:

Comment: this is a comment on one paragraph.
comment

this is a comment on one paragraph.

Question: this is a question on one paragraph.
question

this is a question on one paragraph.

previous task next (8 of 12) index
task

The following was marked as "question".

this is a question on one paragraph.

Location not known more precisely.

Created by function n/a in module n/a.
previous task next (7 of 12) index
task

The following was marked as "question".

question

this is a question on one paragraph.

Location not known more precisely.

Created by function n/a in module n/a.
Doubt: I have my doubts on one paragraph.
doubt

I have my doubts on one paragraph.

previous task next (10 of 12) index
task

The following was marked as "doubt".

I have my doubts on one paragraph.

Location not known more precisely.

Created by function n/a in module n/a.
previous task next (9 of 12) index
task

The following was marked as "doubt".

doubt

I have my doubts on one paragraph.

Location not known more precisely.

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

These are the multiple-paragraphs forms:

<div class='comment' markdown='1'>
A comment...

A second paragraph...
</div>

A comment…

A second paragraph…

<div class='question' markdown='1'>
A question...

A second paragraph...
</div>

A question…

A second paragraph…

previous task next (11 of 12) index
task

The following was marked as "question".

A question…

A second paragraph…

Location not known more precisely.

Created by function n/a in module n/a.
<div class='doubt' markdown='1'>
A question...

Should it not be:

    $ alternative command

A second paragraph...
</div>

A question…

Should it not be:

$ alternative command

A second paragraph…

previous task (12 of 12) index
task

The following was marked as "doubt".

A question…

Should it not be:

$ alternative command

A second paragraph…

Location not known more precisely.

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