Writing Stack Exchange
Writing Stack Exchange

Questions tagged [markup-languages]

Source languages like HTML, Markdown, and XML schemas/DTDs like DocBook.

9 questions
9
votes
2 answers

How can I prevent, or work around, unfortunate hyphenation in critical words?

In technical documentation, sometimes the tool's automatic hyphenation makes a bad break in the middle of a term, like the name of an environment variable or function. In these cases I would rather have a short line than hyphenation, though I want…
Monica Cellio
  • 21,489
  • 3
  • 68
  • 110
8
votes
4 answers

Web-based WYSIWYG Markdown editor with commenting?

My question is similar to this one, but with (hopefully) a clearly defined use case: sharing and reviewing basic tech docs with a minimal, intuitive GUI. I'm producing technical documents using MS Word. These docs need to be reviewed, commented and…
Michael
  • 381
  • 1
  • 8
6
votes
1 answer

Is markdown a good choice for large-scale, web-based software developer documentation?

"Markdown" has become very popular for people creating developer documentation due to how easy it is to learn compared to most alternatives. Unfortunately there are dozens of "flavors" of markdown and no official standard. We are creating software…
David Vogel
  • 516
  • 2
  • 5
5
votes
2 answers

Modern Markup for lengthy novel suited for self-publishing

I wrote a lengthy novel using a program I wrote. This produces a suitable LaTeX source I can use to generate a nice-looking PDF. Markup, beside customary division in Part/Chapter/Scene, is used to put emphasis, to handle direct-speech (which I use a…
ZioByte
  • 1,033
  • 1
  • 7
  • 13
2
votes
2 answers

Is it discouraged to format a list of items vertically?

In my writing, I tend to format lists of items: The school has a vegetable garden in which the children grow cabbages, onions, potatoes, and carrots during their free time. as actual vertical lists: The school has a vegetable garden in which the…
Witiko
  • 123
  • 5
1
vote
0 answers

Is there a markup language for writing stage plays?

Is there an equivalent of the Fountain markup language for theatre plays rather than film scripts?
user56590
1
vote
0 answers

AsciiDoc: how can I get the author's name in the output document?

This is the beginning of an AsciiDoc document, where the author is specified: = Writing Documentation using AsciiDoc Tom White v2.0, 2020-11-06 :toc: The author name is accepted by the AsciiDoc processor, i.e. no error is…
Pietro
  • 111
  • 3
0
votes
0 answers

Workflow for Markdown or Asciidoc documents

I write a lot of teaching material on using coding languages. I have taken to using Markdown because it’s very easy to just get into it and mark up headings, tables and code samples. The software I’m using on my Macintosh is Macdown. It’s good for…
Manngo
  • 233
  • 2
  • 4
0
votes
1 answer

Markup langage to easily write technical texts

I'm looking for a syntax that allows me to write in a simple way (not like in LaTeX or HTML) documents with technical elements (chess boards, music scores, tables ...) in addition to the usual bold, italic, underlined ... Does such a thing exist?
user44649