Thread 'Wiki formatting'

Message boards : Documentation : Wiki formatting
Message board moderation

To post messages, you must log in.

AuthorMessage
Nicolas

Send message
Joined: 19 Jan 07
Posts: 1179
Argentina
Message 16974 - Posted: 30 Apr 2008, 18:12:51 UTC

I'm playing around with the boinccmd wiki page.

Current junk
Using subheadings for each command, and a code block for the syntax
Variation of the code block (not a block anymore, helps with wrapping set_proxy_settings)

Which of the last two should I keep? Or any other change?
ID: 16974 · Report as offensive
Eric Myers
Avatar

Send message
Joined: 12 Feb 06
Posts: 232
United States
Message 16997 - Posted: 1 May 2008, 0:45:11 UTC - in response to Message 16974.  

Nicolas wrote:
I'm playing around with the boinccmd wiki page.

Current junk
Using subheadings for each command, and a code block for the syntax
Variation of the code block (not a block anymore, helps with wrapping set_proxy_settings)

Which of the last two should I keep? Or any other change?


Maybe it's because the other two are examples, not fully fleshed in yet (right?), but I think "current junk" version is more readable (and thus not junk). But I see what you are trying to do, and that's a good idea. Hmmmm....
-- Eric Myers

"Education is not the filling of a pail, but the lighting of a fire." -- William Butler Yeats
ID: 16997 · Report as offensive
Nicolas

Send message
Joined: 19 Jan 07
Posts: 1179
Argentina
Message 17045 - Posted: 1 May 2008, 21:38:56 UTC - in response to Message 17004.  

I also think the junk one is more readable.

I find lots of color changes on a page distracting (looks like clown pants). Blocks are nice when the block is several lines long because the beginning and end are easy to see. When the blocks are just 1 line and there are several on the same page, I find putting the text in bold or italics is less distracting to my eye. Others may see it differently.

So what about the 3rd link?
ID: 17045 · Report as offensive
ProfileKSMarksPsych
Avatar

Send message
Joined: 30 Oct 05
Posts: 1239
United States
Message 17047 - Posted: 1 May 2008, 21:43:25 UTC - in response to Message 17045.  
Last modified: 1 May 2008, 21:43:38 UTC

So what about the 3rd link?


That one looks the best to me.
Kathryn :o)
ID: 17047 · Report as offensive

Message boards : Documentation : Wiki formatting

Copyright © 2024 University of California.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation.