11 Feb
2016
11 Feb
'16
11:40 a.m.
Hi devs,
Point 1: We still have some leftovers of the xwiki/1.0 syntax in platform. To give 2
examples:
* XWikiDocument.getUniqueWikiLinkedPages()
* XWikiDocument.getSections()
In both cases the code is like:
public List<DocumentSection> getSections() throws XWikiException
{
if (is10Syntax()) {
return getSections10();
} else {
… new rendering algorithm…
Point 2: We still have a lot of pages (hundreds) written in xwiki/1.0 syntax on
xwiki.org (old release notes, old FAQ entries, the curriki wiki, etc)
Some details (http://www.xwiki.org/xwiki/bin/view/Admin/Syntaxes):
* platform: 49 pages (5%)
* xwiki: 530 pages (13%)
* curriki: 398 pages (37%)
* dev: 126 (3%)
* xclams: 29 (6%)
* etc
total of pages for the wikis supported by the xwiki dev team: 770 pages.
Possible actions
================
A - Migrate xwiki.org content. Hard and tedious to do since there are lots of pages.
B - Discard content written in xwiki/1.0 syntax on xwiki.org (and migrate the few pages
that are in 1.0 but still needed, like the site Survey page)
C - Continue to support the xwiki/1.0 syntax located in xwiki-contrib to ensure it doesn’t
break so that we can install it on xwiki.org when we migrate to 8.x in the future.
D - Continue moving xwiki/1.0 code from platform into the contrib module for xwiki/1.0.
This means doing some refactoring and introducing some component. I think it would be
interesting to deprecate XWikiDocument.getUniqueWikiLinkedPages()
and XWikiDocument.getSections() (and move them to legacy) and instead introduce some new
components somewhere TBD. Generally speaking I’m in favor to not manipulate the XDOM
inside of the XWikiDocument class (just let it return the XDOM but consider it a black
box) and instead do any XDOM manipulation elsewhere (refactoring module or other
modules).
E - Break the xwiki/1.0 syntax by removing the code in platform, i.e. the is10Syntax()
above for example. We would need to decide when it’s ok to do this. In 8.x? In 9.x?
Later?
I see 2 main strategies that seem valid to me:
- Strategy 1: Do C and D. This would mean continuing to leave the old content
of xwiki.org in xwiki/1.0 syntax and convert only the few pages that are still used today
such as the site Survey page - but for example not translating old release notes.
- Strategy 2: Work as a task force (i.e. with everyone helping actively do the work) to
migrate the content of xwiki.org (and possibly move away curriki and some older instance
of xwiki). Consider that xwiki/1.0 syntax is not working anymore if you install XWiki 8.x
(9.x? later?). That’s A and E.
Any other ideas? Thoughts?
WDYT?
Personally I’d be ok with both.
Thanks
-Vincent