6

Following on from the discussion about block quotes and text starting with !, I think it might be a good idea to look at how best to format messages, etc. For actual TeX code, life is clear enough (mark up as code), but for messages from software we can either use code mark up (as it's terminal output) or blockquote mark up (as it is something 'said' by the software). To date, I've always marked up messages as code, but obviously this is not true of everyone. How do other people see this: is there a consensus for one or other approach?

7

It seems to be a good idea to use code blocks. I can't find the example any more, but once I changed a blockquote to a code block where something like this happened:

LaTeX Error: File articl.cls' not found. blah blahsomething else' with quotes `' around it.

This looks very bad in a blockquote; it's supposed to look like this:

LaTeX Error: File `articl.cls' not found.
blah blah `something else' with quotes `' around it.
  • 2
    Also any white space vanishes. – Caramdir Dec 19 '10 at 12:33
  • 1
    I agree that it should be in code blocks. The point, as I see it, of the other discussion is that for a new user, it's not obvious and so the software should still display something sensible when it is put in a blockquote. – Loop Space Dec 20 '10 at 8:10
  • @Andrew: I couldn't agree more. – Hendrik Vogt Dec 20 '10 at 8:14

You must log in to answer this question.

Not the answer you're looking for? Browse other questions tagged .