Skip to main content

This site requires you to update your browser. Your browsing experience maybe affected by not having the most up to date version.

Archive

Our old forums are still available as a read-only archive.

Moderators: martimiz, Sean, biapar, Willr, Ingo, simon_w

proposal for Forum - readability


Go to End
Reply

11 Posts   18717 Views

Avatar
zyko

8 May 2008 at 7:53pm (Last edited: 14 May 2008 9:04pm), Community Member, 66 Posts

i've a proposal for Forum layout.

i think doing SilverStripe websites has todo a lot with writing code,
and therefore this forum will be used often to show some pieces of code
and discuss aout it.

What would make things easyer was, if you would format this pieces of code
in an alternate way.

fe. if someone clicks 'View Formatting Help' beneath a thread, there it shows this
'codeblock' BBode.

I've done some threads using it, but the layout here doesn't differ from the rest of the posting.
fe:
http://www.silverstripe.com/site-builders-forum/flat/66662

this is a codeblock, please show me in an alternate way ;-)

if you look at the html, my 'code'-block has turned into a 'pre' statement.

so, i think if someone would spend a minute, to css-fomat this tag
in another layout,
this forum could get an immediate 'boost' of readability ;-)

g
Helmut

Avatar
Willr

8 May 2008 at 9:01pm Forum Moderator, 5511 Posts

Posting large blocks of code in the forum is a bit of a hassle and generally if you want to paste code in the forum we recommend using pastie - http://pastie.caboo.se/ and posting the link in the post. That way the code is nicely highlighted and formatted and users dont have to bear with great mass's of code outputs on the threads.

Avatar
saimo

9 May 2008 at 12:09am (Last edited: 9 May 2008 12:12am), Community Member, 67 Posts

I have to agree with zyko here.
code blocks should have a different style than the rest of the post, here are some points:

  • Keep indentation (as is done already)
  • Put the code in an iframe or a div with scrollbar, so that it is easy to skip past the code if you have already read it
  • Make the style of this div or iframe so that it is clear where is starts and ends, to improve overall readability of the post
  • Ideally provide syntax highlighting for php, css, xml markup, and template tags.

I really think that being able to read the code directly in the message is important, both for readability and for archive reasons as well. What if someone googles a problem and finds a thread that seems to solve the problem, but all the code is somewhere else, in a paste that might not be around anymore?

EDIT: It seems like there's a problem with the ulist tags as well, my ulist should be right below "here are some points:"

Avatar
saimo

9 May 2008 at 12:17am Community Member, 67 Posts

Well, that doesn't seem to work right either...
this is how I meant for it to look (copy + paste + fixup):

I have to agree with zyko here.
code blocks should have a different style than the rest of the post, here are some points:

* Keep indentation (as is done already)
* Put the code in an iframe or a div with scrollbar, so that it is easy to skip past the code if you have already read it
* Make the style of this div or iframe so that it is clear where is starts and ends, to improve overall readability of the post
* Ideally provide syntax highlighting for php, css, xml markup, and template tags.

I really think that being able to read the code directly in the message is important, both for readability and for archive reasons as well. What if someone googles a problem and finds a thread that seems to solve the problem, but all the code is somewhere else, in a paste that might not be around anymore?

EDIT: It seems like there's a problem with the ulist tags as well, my ulist should be right below "here are some points:"

Avatar
zyko

9 May 2008 at 1:34am (Last edited: 9 May 2008 1:35am), Community Member, 66 Posts

THX saimo.
i have to agree to the following thing:
"What if someone googles a problem and finds a thread that seems to solve the problem, but all the code is somewhere else, in a paste that might not be around anymore? "

the main problem for me, starting with silverstripe was 'how to get into it'.
if these code-fragements were outside, they wouldn't be searchable...
and the first thing anyone does in theses days, is 'look for something similar'
to my problem.
becouse in 80% i'm not the first to have this problem...
BTW: things would be better additionally, if dokumentation was capable of getting 'page-comments',
(i wrote a trac-proposal for this)

and if readability was better too, anyone could get things faster...

Avatar
Willr

9 May 2008 at 9:38am Forum Moderator, 5511 Posts

zyko for your proposal about doc comments you might want to add to it this plugin - http://wiki.splitbrain.org/plugin:discussion for docwiki. Seems that plugin would work pretty well.

Avatar
sarahk

9 May 2008 at 1:44pm Community Member, 46 Posts

I'm happy with the caboo suggestion but it would be good to get the list styling sorted. I use it habitually and it really screws up here :)

Avatar
zyko

10 May 2008 at 3:47am Community Member, 66 Posts

Hi willr,

WOW, yessss that docwiki-discussion plugin would be absolutely cool to have :-)
g
helmut

Go to Top