taking screenshots - new section for Documentation Guide (was installation guide)

Paul W. Frields paul at frields.com
Tue Aug 31 18:15:14 UTC 2004


On Mon, 2004-08-30 at 21:21, Karsten Wade wrote:
> I do know that we will need to keep our content on separate lines than
> the tags.  This is a sanity checking device.  If you have a code or
> configuration file:
> 
> foo {
>   bar {
>    some.call ()
>   }
> }
> 
> and the first and lines of that are flush with tags, e.g.:
> 
> <programlisting>foo {
>   bar {
>    some.call ()
>   }
> }</programlisting>
> 
> it is hard to tell if the code indenting is correct, which matters in
> many contexts.  This simple example is easy to fix, but complex examples
> are much harder, as I have personally experienced many times.

Agreed. I didn't like having to stack tags one bit from a readability
standpoint, but I figured the end justified the means (i.e. readable
output). If this part of xmlto (or something else) needs fixing, it
would be great if someone could identify what's broken.

With regard to your test ([...snipped...]), I think that examples 1-2
prove my point. Example 2 shows a rendering with the least amount of
extra vertical whitespace surrounding the actual code snippet. That's
what I was seeing as well, and why I started stacking tags.

If wiser heads think that I am putting the cart before the horse there,
I'm happy to comply. Just means I can read it easier while editing,
anyway! :-)

-- 
Paul W. Frields, RHCE





More information about the fedora-docs-list mailing list