RFE: Integrate Critic Markup into AsciiDoc

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|

RFE: Integrate Critic Markup into AsciiDoc

Patrick Ben Koetter
Hey there!

I've come across CriticMarkup and I think something /like/ CriticMarkup would
be a useful addition to AsciiDoc:

    "CriticMarkup was designed to make plain text copyediting markup easy to
    write and easy to read."

ATM AsciiDoc supports comments, but none of the other elements regularly used
in copyediting text. This is where CriticMarkup comes in by adding these
elements:

* Addition {++ ++}
* Deletion {-- --}
* Substitution {~~ ~> ~~}
* Comment {>> <<}
* Highlight {== ==}{>> <<}

Something like this would certainly make copyediting of documentation we
(sys4) work on easier. ATM we use comments in merge request, but they are not
part of the document and its history.

Opinions?

p@rick

P.S.
Yes, this should probably go to a list that discusses AsciiDoc as a standard
and not the asciidoctor tool.

--
[*] sys4 AG

https://sys4.de, +49 (89) 30 90 46 64
Schleißheimer Straße 26/MG,80333 München

Sitz der Gesellschaft: München, Amtsgericht München: HRB 199263
Vorstand: Patrick Ben Koetter, Marc Schiffbauer, Wolfgang Stief
Aufsichtsratsvorsitzender: Florian Kirstein


smime.p7s (5K) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: RFE: Integrate Critic Markup into AsciiDoc

Alvis
I 2nd this, I struggle with finding a smooth way of providing Business User reviews of our user manual.

-Kristian
Reply | Threaded
Open this post in threaded view
|

Re: RFE: Integrate Critic Markup into AsciiDoc

Alexander Schwartz
That I've tried in the past (as technical prototype) as critics markup is not available:
  1. Marking block manually as added/removed using roles
    ++++
    <style>
    .removed{background-color: #fdb8c0}
    .added{background-color: #acf2bd}
    </style>
    ++++
    
    Hello [.added]##to the ##world! This [.removed]##an##[.added]##a## test!
    
    Produces:
  2. Post-processing HTML output of a new version and an old version using HTML-diffing (for example NPM package htmldiff-js). This leads to very similar results, but will highlight all changes in the HTML. A very minimal live prototype is here: https://asciidoc-editor.ahus1.de; once you edit a file, you can toggle the preview to show you a HTML-diff
Alexander Schwartz (alexander.schwartz@gmx.net)
https://www.ahus1.de
Reply | Threaded
Open this post in threaded view
|

Re: RFE: Integrate Critic Markup into AsciiDoc

Mamamio
We use the same approach here (defining roles). But I second Patrick's request!
Valentin