Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(after STL2018 release) Text files: write one sentence per line #115

Open
dennisguse opened this issue Nov 8, 2018 · 2 comments
Open

(after STL2018 release) Text files: write one sentence per line #115

dennisguse opened this issue Nov 8, 2018 · 2 comments

Comments

@dennisguse
Copy link
Member

While writing and maintaining text files, it usually easier to read (especially skimming), diffs are simplier, and long sentences are easy to spot etc.
Moreover, it is easier to navigate by keyboard while reviewing ;)

And there are some more arguments: https://asciidoctor.org/docs/asciidoc-recommended-practices/#one-sentence-per-line

Could we change this after the STL2018 release?

@ludomal
Copy link
Member

ludomal commented Nov 9, 2018

Thanks for your guidance, @dennisguse . I would definitely be in favor of doing this.
I do not think this would change the presentation of the word document.

Having worked on the Markdown document towards the generation of docx, here are some pain points:

  • using pandoc, the inline code style is lost in the conversion from md to docx. A work around is to use pandoc to convert md to html, then to open the html file in MS word. That way styles are preserved.

  • Annex A is full of tables, and paragraphs in table cells have to be on a single line, with
    tags to handle line breaks. This is quite hard to read. If we stay with Markdown, we may want to use a different layout.

  • I have created a CMake config to generate the HTML file automatically using Pandoc. It may need further work but it could be a good start point.

@dennisguse
Copy link
Member Author

This wouldn't change the "rendered" layout - latex/pandoc ignore single line breaks while treating 2+ line breaks as new paragraph.

About Pandoc: would you submit a pull request?
Sounds like a nice feature to integrate.

About tables (in Markdown): depending on the actual content, it might be easier to use enumerated lists if possible.
This, in fact, would also change the HTML layout.
However, I would prefer cleaner Markdown files as long as there is need to automate the HTML rendering (e.g., using it for a web page and therefore requiring frequently updates).
If necessary, the "annual" updates of the recommendation could be done manually (not nice, but doesn't happen often enough).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants