You are here: Foswiki>Tasks Web>Item9415 (09 Nov 2010, PaulHarvey)Edit Attach

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

Priority: Enhancement
Current State: Closed
Released In: 1.1.0
Target Release: minor
Applies To: Engine
Reported By: PaulHarvey
Waiting For: Main.PaulHarvey
Last Change By: 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

ItemTemplate edit

Summary System documentation: improve readability and add syntax highlighting to examples
ReportedBy PaulHarvey
Codebase trunk
SVN Range
AppliesTo Engine
Priority Enhancement
CurrentState Closed
WaitingFor PaulHarvey
Checkins distro:78a5b1d52ab2 distro:536afb417e75 distro:f0bdc03bcfc3 distro:fe6b2f43f1f9 distro:c72e22863110 distro:373b2d860d8c distro:2fb49f236db3 distro:b6a0a705b2b8 distro:1ce576970f9a distro:50fe62183e8b distro:3795ae960740 distro:02f751f9b5c6 distro:689cdd89e311 distro:36d674130f70 Rev 8466 not found distro:fa5aeefc38f7 distro:e211241d4b9c distro:9889533a32a3 distro:cc159cab21fe distro:d9ad6e0534d1 distro:4cc0db841b5c distro:d1052d557cc2 distro:22acb48ea8f6 distro:a4d660f35d7f distro:15a8dbe8d665 distro:3586e6bfdf3f distro:04b1a8dfc9dc distro:b605610cd802 distro:43db68555d6a distro:275ef8822359 distro:5e6e77df5149 distro:879a4e46e820 distro:145e6150e8e5 distro:6fe64b572211 distro:dd530d94edfb distro:5aee24997d44 distro:664cae7e2dfd distro:253e044615c0 distro:95daff9cf5e0 distro:e8197d83d53b distro:72cb7f9d5a17 distro:ecc4238385de distro:cead6a83be01 distro:cff326aa6a3b distro:c43415c232c0 distro:bf53824ed61e distro:5abf4b3adb6a distro:96eb06faff8d distro:26d5821c297f distro:3cc028f5eec5 distro:1fc979863eb7 distro:b396ed6f3547 distro:a8a611a10f57 distro:944fbfa170cc distro:639168da542b distro:ac6b2b71dbff distro:23023cb2f75b distro:b195b5e55ea1 distro:34bcbbbaf235 distro:9e3ffbb6751a distro:2d957c738934 distro:c1ff4f054520 distro:cb7e04cdeb4e distro:b2c2d8a9347a distro:7b67fb397900 distro:8a8ea7f29a99 distro:69764069af45 distro:410f12dbae6d distro:2f84e15fb8af distro:2308fa1ce9f9 distro:ad09ae2377d9
TargetRelease minor
ReleasedIn 1.1.0
Topic revision: r79 - 09 Nov 2010, PaulHarvey - This page was cached on 17 Oct 2018 - 22:57.

The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. See Copyright Statement. Creative Commons License    Legal Imprint    Privacy Policy