Foswiki on GitHub is open for business! Next release meeting: Monday September 29, 1300Z

Item9415: System documentation: improve readability and add syntax highlighting to examples

Priority: CurrentState: AppliesTo: Component: WaitingFor:
Enhancement Closed Engine   Main.PaulHarvey
-- PaulHarvey - 30 Jul 2010

Some users might have written their own tips locally (we have), and some plugins ship their own tips to work with the TipsContrib. Is this backwards compatible, or would they all need to be updated?

If this is not backwards compatible, it might be best to raise a feature request to remove TipsContrib from the core but have it on the extensions web for compatibility. Then we could implement a new approach to tips in the core using DataForms.

-- AndrewJones - 12 Aug 2010

Of course. Sorry about that. I will fix the searches, or revert the changes.

-- PaulHarvey - 12 Aug 2010

We will not fix this.

I have just reverted the change to TipsContrib.

It requires a feature proposal to be considered for at least 14 days - during which I would raise concern for sure.

And it requires we are not in a feature freeze.

So TipsContrib - which works just fine as it is - will remain as it is in 1.1.0

And if someone wants something new, we can take it out of core in 2.0 and freeze it as a downloadable plugin for those that want to continue to use it as it is.

Paul. Don't feature creep. I am very unpolite and rude when anyone does and I revert with no mercy. That is my role as release manager. We are already late with 1.1

If it works - don't fix it.

Adding the colouring to the core standard docs is OK because we always exclude pure documentation from feature freeze to encourage better documentation. And a spelling error will not break code. So you can continue that work on this report. Even though I would personally prefer spent the time closing bugs instead.

-- KennethLavrsen - 12 Aug 2010

After some coffee and a chat with Sven on IRC I agree with your decision to revert.

Sorry about that. I got carried away. Hopefully the FAQ app will serve as a decent example for 1.1 users to learn from, and I can fix that to be compatible with old FAQs too.

I am now realising just how important the doc is to new users of Foswiki, however. Only a fraction of them bother with IRC, it seems. So this does need to be addressed at some point. It is quite urgent. You would be surprised the WYSIWYG bugs they have put up with in Confluence in the past; but if the admin can't figure out how to do simple things on their wiki, it won't last long.

So I won't creature feep on this task any more.

-- PaulHarvey - 13 Aug 2010

We released this stuff in 1.1.0

-- PaulHarvey - 09 Nov 2010
Topic revision: r79 - 09 Nov 2010, PaulHarvey
The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. see CopyrightStatement. Creative Commons License