3 ms·
he said.. in courier, monospaced paragraphs format, morally as close to "plaintext" as you can be with a couple of diagrams which could have been ASCII art...
by ggm 5y ago
he said.. in courier, monospaced paragraphs format, morally as close to "plaintext" as you can be with a couple of diagrams which could have been ASCII art...
- lbriner 5y agoExactly. The OP said what they needed to in plain text because it captures what they wanted to say in the simplest format. If they had needed to convey an image or contextual information like some rich API spec, they would presumably have used something else.
- kleiba 5y agoThat is not a contradiction. The OP is just arguing that you should use the best medium + format for the job - and sometimes simple text is sufficient (as it says in the article).
- ciphol 5y agoIronically, the "pro plain text" link posted earlier used lots of formatting. I don't see why pure plain text is better in any way than plain text with formatting, like a simplified form of HTML (<a>, <b>, <sup>, some kind of table formatting, etc). The latter is non-proprietary, easily read and diffed, and communicates better than pure text. Images have their own value, as do animations and video on occasion. Here matters become more complicated - image formats are generally non-human-readable and non-diffable (though SVG or a similar format could solve those problems for schematic-type images) and image conversions generally involve data loss. For starters, though, one should at least use a non-proprietary format for images and video.
- alanbernstein 5y agoAs the pro-plain-text post said: HTML, Markdown, JSON, LaTeX, and many other standard formats, are just plain text.
- ciphol 5y agoIt depends. XML is generally not human-readable, it's got way too much programming code in relation to the amount of human content. But a simple subset of HTML is definitely human-readable.
- mro_name 5y agoNo, not when it comes to what reading person they target. Here text/plain is the only that works for e.g. my mother.
- b112 5y agolike a simplified form of HTML (<a>, <b>, <sup>, some kind of table formatting, etc). The latter is non-proprietary, easily read and diffed, and communicates better than pure text. Yes, but, the problem isn't typically being proprietary, when it comes to future use, but a closed, non standard, unknown format. Yet you're creating a new standard here, with your own rules, which no one will understand, and which no automated tools can convert to another format. (Eg some kind of table formatting) Better to be 100% html than this. (Maybe you meant that, but regardless, this is a good place for me to comment on standards being more important than anything else.)
- mro_name 5y ago> no one will understand that's a bit harsh. And frankly, I don't understand 100% english either, but still we use it to communicate.
- b112 5y agoThe point isn't that you can learn it, but instead, having to learn it by examining it in depth, always wondering if there are things not used yet (does the doc you look at, only show part of the standard in its formatting? Imagine a doc not using a tag, but the tag is in other docs...), and then, writing code to covert it. Standards exist for a reason. We already have issues with people not understanding specs, and writing data out of spec, even with that spec in RFC's!
- mro_name 5y agomy favourite is the spec that was changed after the fact: Applications using this syntax may choose, for the sake of readability, to specify a full-date and full-time separated by (say) a space character. https://datatracker.ietf.org/doc/html/rfc3339#section-5.6 https://datatracker.ietf.org/doc/html/rfc3339#section-5.6 But what harm does it to restrict oneself to a few html tags?
- gwern 5y agoAnd if the diagrams had been ASCII art diagrams (eg https://twitter.com/thorstenball/status/1498541884796542977 https://twitter.com/thorstenball/status/1498541884796542977 ), OP could fix the typo in the diagram with a keystroke.
- yumiris 5y agoCheers for the heads-up on the typo. The diagram's an SVG, with the labels being in plain ASCII. One keystroke is all it took indeed! :P On the serious side, ASCII art diagrams are splendid and I very often use them myself, though they can get quite complex and thus messy to maintain. There comes a certain point where they lose their simplicity, sadly.