Hi all,

When making changes to our documentation files, please use asciidoc to render the document and then examine it in your browser, before committing it to the repository. We've worked hard to make the document look good, in its final form -- and we want to keep it that way!

Here are a few hints about markup details in the "FAQ" section:

For reasons best known to the AsciiDoc designers, the "question" must be entered as a single line of text, followed by a double colon "::". No hard line breaks in the question! This is also a good reminder that good questions for an FAQ section should be short.

Answers should be short, too. But if necessary, paragraphs should be separated as follows:

Paragraph one, in a long-winded answer.
+
Paragraph two...

That single "+" character (rather than a blank line) tells asciidoc that what follows is still part of the answer to the most recent question.

If you have questions about editing and formatting of *.adoc files, or why we have done things in certain ways, other asciidoc questions, please feel free to ask on the wsjt-devel list!

        -- Joe, K1JT
_______________________________________________
Wsjt-devel mailing list
[email protected]
https://lists.berlios.de/mailman/listinfo/wsjt-devel

Reply via email to