uccser/verto

Allow markdown to render verto tags inside a numbered list

hayleycodes opened this issue · 5 comments

Use case:

1. Hold the first 5 cards (1, 2, 4, 8 and 16 dots), but don't let students see the dots. Ask for 5 students to volunteer to be “bits”, and have them stand in a line in front of the class.

2. Hand out the 1-dot card to the person on the right. Explain that they are one "bit" (binary digit), and can be on or off, black or white, 0 or 1 dots. The only rule is that their card is either completely visible, or not visible (i.e. flipped over). Hand out the second card to the second person from the right. Point out that this card has either 2 dots (visible), or none (upside down). 

    {image file-path="img/topics/col_binary_2cards.png"}

3. Ask the class what the number of dots on the next card will be. Get them to explain why they think that.

Result:

1. Hold the first 5 cards (1, 2, 4, 8 and 16 dots), but don't let students see the dots. Ask for 5 students to volunteer to be “bits”, and have them stand in a line in front of the class.

2. Hand out the 1-dot card to the person on the right. Explain that they are one "bit" (binary digit), and can be on or off, black or white, 0 or 1 dots. The only rule is that their card is either completely visible, or not visible (i.e. flipped over). Hand out the second card to the second person from the right. Point out that this card has either 2 dots (visible), or none (upside down). 

    {image file-path="img/topics/col_binary_2cards.png"}

1. Ask the class what the number of dots on the next card will be. Get them to explain why they think that.

Note this is just one case, it is also very likely that there will be panels and videos in numbered lists also (and probably eventually glossary tags , interactives....)

The line {image file-path="img/topics/col_binary_2cards.png"} should have one less space at the start. The { should match up with the H in the previous line. Does this fix it?

Sorry @ravenmaster001, reopening this issue :(

1. Hold the first 5 cards (1, 2, 4, 8 and 16 dots), but don't let students see the dots.
  Ask for 5 students to volunteer to be “bits”, and have them stand in a line in front of the class.

2. Hand out the 1-dot card to the person on the right. 
  Explain that they are one "bit" (binary digit), and can be on or off, black or white, 0 or 1 dots.
  The only rule is that their card is either completely visible, or not visible (i.e. flipped over).
  Hand out the second card to the second person from the right.
  Point out that this card has either 2 dots (visible), or none (upside down). 

    {image file-path="img/topics/col_binary_2cards.png"}

3. Ask the class what the number of dots on the next card will be. Get them to explain why they think that.

^ this gives the expected output (i.e. continues at 3. rather than resetting to 1.)

However, this:

3. Ask the class what the number of dots on the next card will be. Get them to explain why they think that.

    {panel type="general" title="Teaching Observations"}

    Students will usually suggest it should be three. If they suggest 4, they have probably done the activity before (or have seen the cards you are holding!)
    If they suggest the wrong number, don't correct them, but continue without comment, so that they can construct the rule for themselves.

    {panel end}

Results in an error:

verto.errors.TagNotMatchedError.TagNotMatchedError: no end tag found to close start tag

Using three spaces rather than four, in both the image and panel cases, does not throw an error, but also resets the list numbers back to 1. Am I doing something wrong here...or does this bug still exist?

Both of the cases above is not what I would expect the required Markdown to be, it might be worth officially documenting what is required with Verto, as we seem to all have different ideas.

From the official Markdown syntax documentation:

To make lists look nice, you can wrap items with hanging indents:

    *   Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
        Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi,
        viverra nec, fringilla in, laoreet vitae, risus.
    *   Donec sit amet nisl. Aliquam semper ipsum sit amet velit.
        Suspendisse id sem consectetuer libero luctus adipiscing.

But if you want to be lazy, you don't have to:

    *   Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
    Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi,
    viverra nec, fringilla in, laoreet vitae, risus.
    *   Donec sit amet nisl. Aliquam semper ipsum sit amet velit.
    Suspendisse id sem consectetuer libero luctus adipiscing.

List items may consist of multiple paragraphs. Each subsequent
paragraph in a list item must be indented by either 4 spaces
or one tab:

    1.  This is a list item with two paragraphs. Lorem ipsum dolor
        sit amet, consectetuer adipiscing elit. Aliquam hendrerit
        mi posuere lectus.

        Vestibulum enim wisi, viverra nec, fringilla in, laoreet
        vitae, risus. Donec sit amet nisl. Aliquam semper ipsum
        sit amet velit.

    2.  Suspendisse id sem consectetuer libero luctus adipiscing.

It looks nice if you indent every line of the subsequent
paragraphs, but here again, Markdown will allow you to be
lazy:

    *   This is a list item with two paragraphs.

        This is the second paragraph in the list item. You're
    only required to indent the first line. Lorem ipsum dolor
    sit amet, consectetuer adipiscing elit.

    *   Another item in the same list.

@hayleyavw @JackMorganNZ
Please see the section Indentation/Tab Length here https://pythonhosted.org/Markdown/index.html#differences

Which means the following is wrong because of bad indentation:

3. Ask the class what the number of dots on the next card will be. Get them to explain why they think that.

    {panel type="general" title="Teaching Observations"}

    Students will usually suggest it should be three. If they suggest 4, they have probably done the activity before (or have seen the cards you are holding!)
    If they suggest the wrong number, don't correct them, but continue without comment, so that they can construct the rule for themselves.

    {panel end}

Where as it should be this:

3.  Ask the class what the number of dots on the next card will be. Get them to explain why they think that.

    {panel type="general" title="Teaching Observations"}

    Students will usually suggest it should be three. If they suggest 4, they have probably done the activity before (or have seen the cards you are holding!)
    If they suggest the wrong number, don't correct them, but continue without comment, so that they can construct the rule for themselves.

    {panel end}

I believe you'll find that your first example which apparently works shouldn't have also because of bad indentation, as it follows the rules set out by Jack.

I will leave this ticket open until I add a testcase for containers within lists, and verify that they are working.

Closing again for container tags.