Personal tools
You are here: Home Products Ploneboard Roadmap #2: Allow rich text
Document Actions

#2: Allow rich text

Contents
  1. Motivation
  2. Proposal
by Jon Stahl last modified June 11, 2006 - 00:21
In order to promote more readable posts, we believe that Ploneboard should support rich-text conversation text and reply text.
Proposed by
Jon Stahl, ONE/Northwest
Seconded by
Marshall Mayer, LiveModern.com
Proposal type
User interface
Assigned to release
State
completed

Motivation

In many forums, users wish to write somewhat lengthy messages that would be much more readable if basic formatting (bold, italic, blockquoting) were available.

Proposal

We propose that Ploneboard enable basic text formatting, ideally using the familiar Kupu WYSIWYG editor.

It would be nice (but not essential) to have optional support for reStructuredText or even better, BBCode, which is familiar to many users of other forum systems.

Not sure I like this one either ;)

Posted by Alexander Limi at October 19, 2005 - 05:10

To get the simple one out of the way: BBCode is definitely out of the question. Introducing yet another markup language is not an option.

Having an editor like Kupu available might be an option, as long as it's stripped down a bit and doesn't offer the full range of formatting options.

In my opinion, it's no less readable as plain text. If your forum post requires headings, subheadings, image inserts - you should use a document to get your point across instead.

The ideal thing would be to have a simple transform that did the following:

  • Any inserted HTTP links are hyperlinked + formatted for display so that the link doesn't exceed 30 characters. The resulting link would look like: http://plone.org/documentation.../introduction
  • Any email addresses added would be obscured using HTML entities to offer a rudimentary level of spam protection, and hyperlinked.

That's all that is required, IMO.

Again, this comes down to whether you want to do content management within forum posts (formatting, attachments, the whole enchilada - aka. the CMFBoard approach), or whether you want to make it as easy as possible for people to participate, and keep the content compatible with mailing list integration.

I'm not sure we disagree

Posted by Jon Stahl at October 19, 2005 - 06:10

Didn't think that you'd think BBCode was a good idea. ;-) For the record, I don't really either. Just thought it was worth floating.

Just to be clear, I'm not advocating for "full formatting" options (e.g. images, headings, etc.) either.

However, I do think that minimalist formatting, which I define as:

  • bold & italic blockquoting basic bullets * hyperlinked phrases -- not just URLs

Really helps improve usability/readability for users, especially in longer posts.

I agree that a stripped down Kupu would be a good way to do this
that we we'd reuse a tool we've already got.

Substituting other content types doesn't really seem like a viable substitution to me.

That said, auto http:// and mailto:// linking would be a useful step forward.

Depends on the forum use

Posted by David Bourgeois at October 19, 2005 - 09:31

I agree that most of the time images and complete formatting are more annoying than serving a forum. But in some cases it can be necessary. We need it in our intranet when discussing prototypes improvement.

My point is that it's more a functionnality which is to choosen by the site manager. I would prefer a tunable version of kupu with choices to enable images, formatting, ...

Two options only

Posted by Marshall Mayer at October 19, 2005 - 16:46

It's either Kupu or plain text (with utility to auto format http:// and mailto: content), depending on their preference setting. Having other options, whether transparent or not, is too confusing for the user.

kupu as option, yes

Posted by Adam Theo at October 21, 2005 - 08:17

I completely agree that allowiing kupu integration is needed. I for one despirately want users to use kupu to edit conversations and comments, to be consistent with the rest of my site. I understand other people may not want kupu, or all of kupu's features, so I guess this should be a feature similar to kupu's use in the rest of Plone (ex: the admin sets an option to use kupu or not).

Now, as far as the feature set of the used kupu, I don't mind allowing the full, unmodified kupu. My users will be used to it from the rest of the site, and I as an admin don't mind complex formatting in comments.

BTW, I don't care about BBCode

Posted by Adam Theo at October 21, 2005 - 08:18

I've never used BBCode personally, and I think that if HTML editing via kupu was available, none of my users would want BBCode anyway.

Make it easily pluggable

Posted by Florian Schulze at October 29, 2005 - 10:58

I think there is already some code to make this pluggable. We should just provide very basic stuff.

Forums should be easy to use

Posted by Jean-Paul Ladage at January 25, 2006 - 12:13

Offering kupu to manage forum messages is way overdone. I agree with limi to use plain text and transforms for basic markup only.

One common remark to the development of Ploneboard. I think we should keep Ploneboard minimalistic and focused to the most common use case. Let's prevent Ploneboard from drowning of features like CMFBoard did.

Let's aim for the gray and allow choice...

Posted by David Groos at November 21, 2006 - 04:29
I'm not for CMFBoard-overboard. Nor am I into mandatory minimalism. I agree that my communications would be augmented by having the standard, rich text options provided by kupu. Standard Plone kupu options aren't 'overboard'. While I generally prefer the text editing allowed by FCKeditor, I would be quite happy with standard kupu. I can see that there are strong feelings on both sides, so why not let site admins decide with a simple control panel to turn options on or off? I know it means work/money--and that is a good reason. However, let's not limit ourselves because we think minimal is good enough because it is good enough for 50% of plone users. BTW has anyone taken a poll on editing capabilities? That could be some interesting research...

Already done

Posted by Jon Stahl at November 21, 2006 - 04:31
David,

Note that this PLIP is now "completed and merged." We decided to use Kupu, but to strip out a bunch of unneeded formatting controls (which could be added back in).

Thanks

Posted by David Groos at November 21, 2006 - 11:57
Jon,

I'm looking forward to upgrading my ploneboard and trying it out. Actually, I did know that this particular issue had been solved. I guess I was weighing in on the larger issue I see in the plone community of whether to permit admins to decide on how much text editing control to allow their users. Over the last 3 years that I've worked (on a very superficial but extensive level) with Plone and with this issue, I've gotten the impression that Plone developers don't want 'big pink letters' on a site that uses their cms and I'm a big advocate for pragmatism.
David

Not clear why Kupu is bad

Posted by Joe Malin at February 27, 2006 - 17:22

I agree that an add-in is in danger of drowning from add-ons. But unless the code changes and maintenance are horrendous, I don't see the issue with Kupu.

I recognize that other forms of discussion are possible in Plone, but that means then that you have two separate threads going on. And, the built-in discussion model assumes one is discussing a piece of content. It would be nice to have a discussion board implementation within Plone. If that's not the goal of Ploneboard, then why have Ploneboard at all.

Also, the Plone discussion model is not as familiar as the Ploneboard model.

I think I'm trying to say that if one constructs an add-on to implement a particular feature in Plone, then one must confront the minimum feature set that customers expect in that feature, especially if the feature is well-known in the community. I haven't yet seen a discussion board that didn't offer rich text. If Ploneboard doesn't offer it, then why have Ploneboard at all?


For any issues with the web site functionality, please file a ticket.

Please consult the policy on plone.org content if you want your content published on this site.

Servers and hosting by