activated
Duckietown
Home
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 2018-06-02 by Andrea Censi

The system supports parsing of some special paragraphs.

some of these might be redundant and will be eliminated. For now, I am documenting what is implemented.

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

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.

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 (9 of 17) index
for:Andrea Censitask

The following was marked as "question".

this is a question on one paragraph.

File docs/docs-duckumentation/book/duckumentation/20_markduck/66_special_envs.md.

File book/duckumentation/20_markduck/66_special_envs.md
in repo duckietown/docs-duckumentation branch master commit 164b6c01
last modified by Andrea Censi on 2018-06-03 12:58:05

Created by function create_notes_from_elements in module mcdp_docs.task_markers.
previous task next (8 of 17) index
for:Andrea Censitask

The following was marked as "question".

question

this is a question on one paragraph.

File docs/docs-duckumentation/book/duckumentation/20_markduck/66_special_envs.md.

File book/duckumentation/20_markduck/66_special_envs.md
in repo duckietown/docs-duckumentation branch master commit 164b6c01
last modified by Andrea Censi on 2018-06-03 12:58:05

Created by function create_notes_from_elements in module mcdp_docs.task_markers.
Doubt: I have my doubts on one paragraph.
doubt

I have my doubts on one paragraph.

previous task next (11 of 17) index
for:Andrea Censitask

The following was marked as "doubt".

I have my doubts on one paragraph.

File docs/docs-duckumentation/book/duckumentation/20_markduck/66_special_envs.md.

File book/duckumentation/20_markduck/66_special_envs.md
in repo duckietown/docs-duckumentation branch master commit 164b6c01
last modified by Andrea Censi on 2018-06-03 12:58:05

Created by function create_notes_from_elements in module mcdp_docs.task_markers.
previous task next (10 of 17) index
for:Andrea Censitask

The following was marked as "doubt".

doubt

I have my doubts on one paragraph.

File docs/docs-duckumentation/book/duckumentation/20_markduck/66_special_envs.md.

File book/duckumentation/20_markduck/66_special_envs.md
in repo duckietown/docs-duckumentation branch master commit 164b6c01
last modified by Andrea Censi on 2018-06-03 12:58:05

Created by function create_notes_from_elements in module mcdp_docs.task_markers.

These are the multiple-paragraphs forms:

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

A second paragraph...
</div>
comment

A comment…

A second paragraph…

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

A second paragraph...
</div>
question

A question…

A second paragraph…

previous task next (13 of 17) index
for:Andrea Censitask

The following was marked as "question".

A question…

A second paragraph…

File docs/docs-duckumentation/book/duckumentation/20_markduck/66_special_envs.md.

File book/duckumentation/20_markduck/66_special_envs.md
in repo duckietown/docs-duckumentation branch master commit 164b6c01
last modified by Andrea Censi on 2018-06-03 12:58:05

Created by function create_notes_from_elements in module mcdp_docs.task_markers.
previous task next (12 of 17) index
for:Andrea Censitask

The following was marked as "question".

question

A question…

A second paragraph…

File docs/docs-duckumentation/book/duckumentation/20_markduck/66_special_envs.md.

File book/duckumentation/20_markduck/66_special_envs.md
in repo duckietown/docs-duckumentation branch master commit 164b6c01
last modified by Andrea Censi on 2018-06-03 12:58:05

Created by function create_notes_from_elements in module mcdp_docs.task_markers.
<div class='doubt' markdown='1'>
A question...

Should it not be:

    $ alternative command

A second paragraph...
</div>
doubt

A question…

Should it not be:

$ alternative command

A second paragraph…

previous task next (15 of 17) index
for:Andrea Censitask

The following was marked as "doubt".

A question…

Should it not be:

$ alternative command

A second paragraph…

File docs/docs-duckumentation/book/duckumentation/20_markduck/66_special_envs.md.

File book/duckumentation/20_markduck/66_special_envs.md
in repo duckietown/docs-duckumentation branch master commit 164b6c01
last modified by Andrea Censi on 2018-06-03 12:58:05

Created by function create_notes_from_elements in module mcdp_docs.task_markers.
previous task next (14 of 17) index
for:Andrea Censitask

The following was marked as "doubt".

doubt

A question…

Should it not be:

$ alternative command

A second paragraph…

File docs/docs-duckumentation/book/duckumentation/20_markduck/66_special_envs.md.

File book/duckumentation/20_markduck/66_special_envs.md
in repo duckietown/docs-duckumentation branch master commit 164b6c01
last modified by Andrea Censi on 2018-06-03 12:58:05

Created by function create_notes_from_elements in module mcdp_docs.task_markers.
Because of mathjax bug

No questions found. You can ask a question on the website.