update from sparkleup
This commit is contained in:
parent
08889065ae
commit
4c20feb6cc
|
|
@ -16,27 +16,43 @@
|
|||
<h2 id="what-it-does">What it does</h2>
|
||||
<p>I want to be able to have editing comments in Markdown, so I came up with some extensions to the syntax. The goal should be for the text to still be at least mostly readable.</p>
|
||||
<ul>
|
||||
<li class="done4"> Additions <code><ins class="addition">new text</ins></code></li>
|
||||
<li class="done4"> Deletions <code><del class="deletion">old text</del></code></li>
|
||||
<li class="done4"> Substitutions <code><span class="substitution"><del>old</del><ins>new</ins></span></code></li>
|
||||
<li class="done4"> Comments <code><mark class="selected">la de da<q class="comment">comment</q></mark></code></li>
|
||||
<li class="done4"> Resolutions <code><q class="comment">-{bad wolf</q>}(STET)</code></li>
|
||||
<li class="done4"> Additions <code>+{new text}</code></li>
|
||||
<li class="done4"> Deletions <code>-{old text}</code></li>
|
||||
<li class="done4"> Substitutions <code>~{old}{new}</code></li>
|
||||
<li class="done4"> Comments <code>?{la de da}(comment)</code></li>
|
||||
<li class="done4"> Resolutions <code>!{-{bad wolf}}(STET)</code></li>
|
||||
<li>Metadata:<ul>
|
||||
<li class="done4"> Comments on all types in parentheses after <code><span class="substitution"><del>old</del><ins>new</ins><q class="comment">comment</q></span></code> etc</li>
|
||||
<li class="done4"> Attribution in parentheses in comment <code><ins class="addition">new<q class="comment">comment<span class="attribution">Commenter</span></q></ins></code></li>
|
||||
<li class="done4"> Date with attribution <code><del class="deletion">old<q class="comment">comment<span class="attribution">Commenter</span><span class="date">2020-04-21</span></q></del></code></li>
|
||||
<li class="done0"> Comment as footnote <code><mark class="selected">la de da<q class="comment">^note</q></mark> ... (^note): comment</code></li>
|
||||
<li class="done0"> Comments can contain markup <code><mark class="selected">la de da<q class="comment">some *markup*</q></mark></code></li>
|
||||
<li class="done4"> Comments on all types in parentheses after <code>~{old}{new}(comment)</code> etc</li>
|
||||
<li class="done4"> Attribution in parentheses in comment <code>+{new}(comment (Commenter))</code></li>
|
||||
<li class="done4"> Date with attribution <code>-{old}(comment (Commenter 2020-04-21))</code></li>
|
||||
<li class="done0"> Comment as footnote <code>?{la de da}(^note) ... (^note): comment</code></li>
|
||||
<li class="done0"> Comments can contain markup <code>?{la de da}(some *markup*)</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="codehilite"><pre><span></span><code><span class="nv">This</span> <span class="nv">is</span> <span class="nv">a</span> <span class="o">+</span>{<span class="nv">new</span>} <span class="nv">addition</span>
|
||||
|
||||
<span class="nv">This</span> <span class="o">-</span>{<span class="nv">this</span>} <span class="nv">word</span> <span class="nv">is</span> <span class="nv">removed</span>
|
||||
|
||||
<span class="nv">I</span> <span class="nv">say</span>, <span class="o">~</span>{<span class="nv">out</span> <span class="nv">with</span> <span class="nv">the</span> <span class="nv">old</span>}{<span class="nv">in</span> <span class="nv">with</span> <span class="nv">the</span> <span class="nv">new</span>}
|
||||
|
||||
<span class="nv">Here</span> <span class="o">!</span>{<span class="nv">just</span> <span class="nv">a</span> <span class="nv">comment</span>} <span class="nv">is</span> <span class="nv">a</span> <span class="nv">line</span> <span class="nv">with</span> <span class="nv">a</span> <span class="nv">comment</span>
|
||||
|
||||
<span class="nv">You</span> <span class="nv">can</span> <span class="nv">also</span> ?{<span class="nv">add</span> <span class="nv">comments</span> <span class="nv">to</span> <span class="nv">some</span> <span class="nv">text</span>}<span class="ss">(</span><span class="nv">Like</span> <span class="nv">this</span><span class="ss">)</span>
|
||||
|
||||
<span class="nv">All</span> <span class="o">-</span>{<span class="nv">new</span>}<span class="ss">(</span><span class="nv">Redundant</span> <span class="ss">(</span><span class="nv">Makyo</span><span class="ss">))</span> <span class="nv">edit</span> <span class="nv">marks</span> <span class="nv">can</span> <span class="nv">have</span> <span class="nv">comments</span> <span class="nv">with</span> <span class="nv">attributions</span> <span class="nv">and</span> <span class="nv">dates</span> <span class="o">+</span>{<span class="nv">like</span> <span class="nv">this</span>}<span class="ss">(</span><span class="nv">See</span>? <span class="ss">(</span><span class="nv">Makyo</span> <span class="mi">2020</span><span class="o">-</span><span class="mi">04</span><span class="o">-</span><span class="mi">22</span><span class="ss">))</span> <span class="ss">(</span><span class="nv">though</span> <span class="nv">it</span><span class="s1">'</span><span class="s">s ignored with comments !{like this}(won</span><span class="s1">'</span><span class="nv">t</span> <span class="k">show</span><span class="ss">))</span>
|
||||
|
||||
<span class="nv">Bottom</span> <span class="nv">text</span>
|
||||
</code></pre></div>
|
||||
|
||||
|
||||
<p>This is a <ins class="addition">new</ins> addition</p>
|
||||
<p>This <del class="deletion">this</del> word is removed</p>
|
||||
<p>I say, <span class="substitution"><del>out with the old</del><ins>in with the new</ins></span></p>
|
||||
<p>Here <q class="comment">just a comment</q> is a line with a comment</p>
|
||||
<p>You can also <mark class="selected">add comments to some text<q class="comment">Like this</q></mark></p>
|
||||
<p>All <del class="deletion">new<q class="comment">Redundant<span class="attribution">Makyo</span></q></del> edit marks can have comments with attributions and dates <ins class="addition">like this<q class="comment">See?<span class="attribution">Makyo</span><span class="date">2020-04-22</span></q></ins> (though it's ignored with comments <q class="comment">like this</q>)</p>
|
||||
<p>Text after</p>
|
||||
<p>Bottom text</p>
|
||||
<h2 id="how-to-use-it">How to use it</h2>
|
||||
<div class="codehilite"><pre><span></span><code><span class="n">default_config</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="s1">'tag_tuple'</span><span class="p">:</span> <span class="p">(</span><span class="s1">'<div class="verse">'</span><span class="p">,</span> <span class="s1">'</div>'</span><span class="p">),</span>
|
||||
|
|
|
|||
Loading…
Reference in New Issue