mbakeranalecta / sam

Semantic Authoring Markdown
Other
79 stars 8 forks source link

New idea for remarks #118

Closed mbakeranalecta closed 7 years ago

mbakeranalecta commented 7 years ago

The difference between comments on the source and remarks on the text is important. I think we need a clearer separation. Here is the proposal for remarks:

A remark is a block element introduced by three exclamation marks:

!!!(mb)
     This is a remark.

The parentheses contain the attribution to the author of the remark.

I can't think of a good way to get remarks into running text. However, we can refer to a block remark in running text:

            This is a reference[*foo] to the remark. 

            !!!(mb)(*foo)
                Need to think about this.

                !!!(mb)
                    Really, what is to think about?

Remarks can be nested, as shown above.

I can't see any reason why the body of a remark cannot be a flow.

Remarks could also be a way to comment out a section of text, by indenting it under a remark.

Not sure if there is any role of text after the remark header. Perhaps best to avoid it for the sake of consistency.

The use of "!!!" seems apt. It is for comments on the text, which are, a reaction to the text.

A single ! is currently used for a language attribute. There is no case for a triple ! language tag and no case for a single ! remark tag, so there is no conflict technically. It would be easy enough to change the language flag to another symbol such as ~

mbakeranalecta commented 7 years ago

Re ! for language vs !!! for remarks, I note that single quote and triple quotes, and # in different places have different meanings for the same symbol.

mbakeranalecta commented 7 years ago

Implemented.