Re: [xwiki-devs] [Proposal] XWiki 2.0 syntax : going further on the syntax overhaul (SUMMARY)
Summary : 1) Usage of // instead of ~~ for italic Three +1, two 0, no -1. 2) Usage of equal signs instead of 1./1.1/etc for Headings Three +1, two 0, no -1 for this change. Three +1, two 0, no -1 for choice a) : consider a line as a heading only if there is the same number of equal signs at the beginning and at the end of the line. Thanks, JV. On Fri, Sep 12, 2008 at 5:29 PM, Jean-Vincent Drean <[email protected]> wrote:
Hi XWikiers,
Those last months we've discussed a lot about precise elements of the new XWiki 2.0 syntax : - usage of 2 chars for **bold** and [[links]] - {{macro/}} syntax - Linebreaks on carriage returns - Linking to attachments/Insert link to image - |table| syntax - styling syntax - emoticons
So far the idea was to keep the xwiki/2.0 syntax as close as possible from xwiki/1.0. IMHO we've reached a point where xwiki/2.0 is so different from xwiki/1.0 that it could be the occasion to go further and replace our few radeox leftovers by their widespread equivalent. That's the first thing I'd like to discuss, do we all agree to make other substantial modifications to xwiki/2.0 ?
Here's my +1.
Being completely in line with Creole [1] or WikiSyntaxCommon [2] is not an option since we've already made some incompatible choices (like linebreaks on carriage returns) and it would imply a big amount of work now that the new rendering is approaching a stable state. That's the reason why this proposal is about 2 basic (and important) wiki syntax elements, those 2 modifications would make xwiki syntax familiar to wikiPowerUsers.
1) Usage of // instead of ~~ for italic
Creole rationale : A slash (/) looks like slanted italics, so it is intuitive and thus easier to remember. See http://www.wikicreole.org/wiki/BoldAndItalicsReasoning Note : on all the keyboard mappings I know slashes are more easily reachable than ~.
Here's my +1.
2) Usage of equal signs instead of 1./1.1/etc for Headings
Creole rationale : Using equal signs (=) is the most popular wiki header markup. Since there are more equal signs for smaller headers, subheaders will become more indented making it easier to get a visual overview from the markup alone. See http://www.wikicreole.org/wiki/HeadingsReasoning
Note : We've experienced problems in the past with the 1/1.1 syntax (bad document section computation, problems with table cells starting with 1, etc) but those problems are addressed in the new rendering. Anyway I think users are more likely to unintentionaly start a line with a 1 than a = (like in "1 is more than 2" in the middle of a paragraph). What I personnaly like with this syntax is that it makes sections very visible when editing a page in wiki mode.
About unclosed titles :
=== Also level 3 === Also level 3 = === Also level 3 ==
a) Don't interpret them
+0.
b) Interpret them but make closed title our default (generated by wysiwyg)
+1, as I wrote above I think that having clear sections in a page helps to navigate in edit mode.
c) Interpret them and make it our default
-0.
[1] : http://www.wikicreole.org/wiki/Creole1.0 [2] : http://code.google.com/p/wikimodel/wiki/WikiSyntaxCommon
Thanks, JV.
-- Jean-Vincent Drean
On Sep 15, 2008, at 4:42 PM, Jean-Vincent Drean wrote:
Summary :
1) Usage of // instead of ~~ for italic
Three +1, two 0, no -1.
2) Usage of equal signs instead of 1./1.1/etc for Headings
Three +1, two 0, no -1 for this change. Three +1, two 0, no -1 for choice a) : consider a line as a heading only if there is the same number of equal signs at the beginning and at the end of the line.
what about the other options? Thanks -Vincent
On Fri, Sep 12, 2008 at 5:29 PM, Jean-Vincent Drean <[email protected]> wrote:
Hi XWikiers,
Those last months we've discussed a lot about precise elements of the new XWiki 2.0 syntax : - usage of 2 chars for **bold** and [[links]] - {{macro/}} syntax - Linebreaks on carriage returns - Linking to attachments/Insert link to image - |table| syntax - styling syntax - emoticons
So far the idea was to keep the xwiki/2.0 syntax as close as possible from xwiki/1.0. IMHO we've reached a point where xwiki/2.0 is so different from xwiki/1.0 that it could be the occasion to go further and replace our few radeox leftovers by their widespread equivalent. That's the first thing I'd like to discuss, do we all agree to make other substantial modifications to xwiki/2.0 ?
Here's my +1.
Being completely in line with Creole [1] or WikiSyntaxCommon [2] is not an option since we've already made some incompatible choices (like linebreaks on carriage returns) and it would imply a big amount of work now that the new rendering is approaching a stable state. That's the reason why this proposal is about 2 basic (and important) wiki syntax elements, those 2 modifications would make xwiki syntax familiar to wikiPowerUsers.
1) Usage of // instead of ~~ for italic
Creole rationale : A slash (/) looks like slanted italics, so it is intuitive and thus easier to remember. See http://www.wikicreole.org/wiki/BoldAndItalicsReasoning Note : on all the keyboard mappings I know slashes are more easily reachable than ~.
Here's my +1.
2) Usage of equal signs instead of 1./1.1/etc for Headings
Creole rationale : Using equal signs (=) is the most popular wiki header markup. Since there are more equal signs for smaller headers, subheaders will become more indented making it easier to get a visual overview from the markup alone. See http://www.wikicreole.org/wiki/HeadingsReasoning
Note : We've experienced problems in the past with the 1/1.1 syntax (bad document section computation, problems with table cells starting with 1, etc) but those problems are addressed in the new rendering. Anyway I think users are more likely to unintentionaly start a line with a 1 than a = (like in "1 is more than 2" in the middle of a paragraph). What I personnaly like with this syntax is that it makes sections very visible when editing a page in wiki mode.
About unclosed titles :
=== Also level 3 === Also level 3 = === Also level 3 ==
a) Don't interpret them
+0.
b) Interpret them but make closed title our default (generated by wysiwyg)
+1, as I wrote above I think that having clear sections in a page helps to navigate in edit mode.
c) Interpret them and make it our default
-0.
[1] : http://www.wikicreole.org/wiki/Creole1.0 [2] : http://code.google.com/p/wikimodel/wiki/WikiSyntaxCommon
Thanks, JV.
-- Jean-Vincent Drean _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
On Mon, Sep 15, 2008 at 4:52 PM, Vincent Massol <[email protected]> wrote:
2) Usage of equal signs instead of 1./1.1/etc for Headings
Three +1, two 0, no -1 for this change. Three +1, two 0, no -1 for choice a) : consider a line as a heading only if there is the same number of equal signs at the beginning and at the end of the line.
what about the other options?
a) Don't interpret unclosed titles : three +1, two 0, no -1 b) Interpret unclosed titles but closed titles as default : Two +1, three 0, no -1 c) Interpret unclosed titles, unclosed titles as default : Zero +1, five 0, no -1 Option a) wins. JV.
Jean-Vincent Drean wrote:
On Mon, Sep 15, 2008 at 4:52 PM, Vincent Massol <[email protected]> wrote:
2) Usage of equal signs instead of 1./1.1/etc for Headings
Three +1, two 0, no -1 for this change. Three +1, two 0, no -1 for choice a) : consider a line as a heading only if there is the same number of equal signs at the beginning and at the end of the line.
what about the other options?
Sorry I'm coming late on this..
a) Don't interpret unclosed titles : three +1, two 0, no -1
-1 because wikicreole does not do that
b) Interpret unclosed titles but closed titles as default : Two +1, three 0, no -1
+1
c) Interpret unclosed titles, unclosed titles as default : Zero +1, five 0, no -1
+0 Ludovic
Option a) wins.
JV. _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Ludovic Dubost Blog: http://blog.ludovic.org/ XWiki: http://www.xwiki.com Skype: ldubost GTalk: ldubost
participants (3)
-
Jean-Vincent Drean -
Ludovic Dubost -
Vincent Massol