Re: [xwiki-devs] [xwiki-notifications] r28505 - enterprise/trunk/wiki/src/main/resources/XWiki

On 04/22/2010 09:04 AM, Vincent Massol wrote: We call them wrong. A header is not the same as a heading, and just because we're using a wrong terminology in too many places, doesn't mean that we can ignore semantics. If we were to call them heders (typo intentional) I'm sure nobody would complain about correcting the typo. Yes, we want to use the correct terms, headers for headers (table headers), headings for headings (section titles). But I don't think that we need to do this in one full sweep. The syntax page is fairly standalone, it definitely doesn't depend on the classes we use in the java code. People that consult the syntax help want to know how to write a heading in a wiki page, they really don't care that the java class that implements them is called HeaderBlock or HeadingLevel. Do you really want to oppose documentation improvement just because the inner code is still wrong?

Now, back to plans, we should update the rest of the documentation if it is wrong. And renaming the java classes should be done sooner rather than later, while we don't have too many external users of the codebase.

Correcting the syntax page is not a big change.

header != heading. It's not about how the HTML spec calls them, it's about calling a duck a goose, and insisting on calling it a goose even if it isn't one.

> WDYT? > > Thanks > -Vincent > > On Apr 22, 2010, at 12:56 AM, sdumitriu (SVN) wrote: > >> Author: sdumitriu >> Date: 2010-04-22 00:56:11 +0200 (Thu, 22 Apr 2010) >> New Revision: 28505 >> >> Modified: >> enterprise/trunk/wiki/src/main/resources/XWiki/XWikiSyntax.xml >> Log: >> XE-647: Misuse of the "header" term instead of "heading" when referring to the html h1-6 >> Fixed. >> Patch from Dan Bozaru applied without changes. >> >> Modified: enterprise/trunk/wiki/src/main/resources/XWiki/XWikiSyntax.xml >> =================================================================== >> --- enterprise/trunk/wiki/src/main/resources/XWiki/XWikiSyntax.xml 2010-04-21 22:55:34 UTC (rev 28504) >> +++ enterprise/trunk/wiki/src/main/resources/XWiki/XWikiSyntax.xml 2010-04-21 22:56:11 UTC (rev 28505) >> @@ -85,7 +85,7 @@ >> |Two standalone elements not separated by 2 new lines|{{{| table cell}}}\\{{{* list item}}}|{{{| table cell}}}\\\\{{{* list item}}} >> |Two standalone elements not separated by 2 new lines|{{{paragraph}}}\\{{{----}}}\\{{{paragraph}}}|{{{paragraph}}}\\\\{{{----}}}\\\\{{{paragraph}}} >> |Ignored new line at beginning of document|&lt;new line at beginning of document&gt;\\paragraph|paragraph >> -|Not closed header syntax|{{{=== header}}}|{{{=== header ===}}} >> +|Not closed heading syntax|{{{=== heading}}}|{{{=== heading ===}}} >> >> = Paragraphs = >> >> @@ -102,11 +102,11 @@ >> |Two paragraphs|Paragraph one\\\\Paragraph two|Paragraph one\\\\Paragraph two|Paragraph one\\\\Paragraph two|Paragraph one\\\\Paragraph two >> |Parametrized paragraph|&lt;p style="text-align:center;color:blue"&gt;Centered and blue paragraph&lt;/p&gt;|{{{(% style="text-align:center;color:blue" %)}}}\\Centered and blue paragraph|(% style="text-align:center;color:blue" %)\\Centered and blue paragraph|(% style="text-align:center;color:blue" %)\\Centered and blue paragraph >> >> -= Headers = >> += Headings = >> >> (% style="width:100%" %) >> |=Feature|=XWiki Syntax 1.0|=XWiki Syntax 2.0|=Result >> -|Standard headers|((( >> +|Standard headings|((( >> 1 level 1 >> 1.1 level 2 >> 1.1.1 level 3 >> @@ -125,11 +125,11 @@ >> &lt;!-- Note: replace this with wiki syntax when http://jira.xwiki.org/jira/browse/XWIKI-4358 is implemented --&gt; >> &lt;h1 id="Hlevel1"&gt;&lt;span&gt;level 1&lt;/span&gt;&lt;/h1&gt;&lt;p&gt;&amp;nbsp;&lt;/p&gt;&lt;h2 id="Hlevel2"&gt;&lt;span&gt;level 2&lt;/span&gt;&lt;/h2&gt;&lt;h3 id="Hlevel3"&gt;&lt;span&gt;level 3&lt;/span&gt;&lt;/h3&gt;&lt;h4 id="Hlevel4"&gt;&lt;span&gt;level 4&lt;/span&gt;&lt;/h4&gt;&lt;h5 id="Hlevel5"&gt;&lt;span&gt;level 5&lt;/span&gt;&lt;/h5&gt;&lt;h6 id="Hlevel6"&gt;&lt;span&gt;level 6&lt;/span&gt;&lt;/h6&gt; >> {{/html}}))) >> -|Parametrized headers|&lt;h1&gt;&lt;span style="color:blue"&gt;header&lt;/span&gt;&lt;/h1&gt;|{{{(% style="color:blue" %)}}}\\= header =|((( >> +|Parametrized headings|&lt;h1&gt;&lt;span style="color:blue"&gt;heading&lt;/span&gt;&lt;/h1&gt;|{{{(% style="color:blue" %)}}}\\= heading =|((( >> {{html}} >> -&lt;h1 id="Hheader" style="color:blue"&gt;&lt;span&gt;header&lt;/span&gt;&lt;/h1&gt; >> +&lt;h1 id="Hheading" style="color:blue"&gt;&lt;span&gt;heading&lt;/span&gt;&lt;/h1&gt; >> {{/html}}))) >> -|Headers with wiki syntax|1.1.1 Header with *bold*|{{{=== Header with **bold** ===}}}|(((=== Header with **bold** ===))) >> +|Headings with wiki syntax|1.1.1 Heading with *bold*|{{{=== Heading with **bold** ===}}}|(((=== Heading with **bold** ===))) >> >> = Text Formatting = >> >> @@ -829,12 +829,12 @@ >> (% style="width:100%" %) >> |=XWiki Syntax 1.0|=XWiki Syntax 2.0|=Generated XHTML >> |((({{{ >> -&lt;h1 class="myClass" style="myStyle" id="myId"&gt;header&lt;/h1&gt; >> +&lt;h1 class="myClass" style="myStyle" id="myId"&gt;heading&lt;/h1&gt; >> }}})))|((({{{ >> (% class="myClass" style="myStyle" id="myId" %) >> -= header = >> += heading = >> }}})))|((({{{ >> -&lt;h1 class="myClass" style="myStyle" id="myId"&gt;header&lt;/h1&gt; >> +&lt;h1 class="myClass" style="myStyle" id="myId"&gt;heading&lt;/h1&gt; >> }}}))) >> >> {{id name="syntaxes"/}} >> @@ -848,4 +848,4 @@ >> * [[Creole 1.0&gt;&gt;http://www.wikicreole.org/wiki/Creole1.0]] >> * [[XHTML 1.0&gt;&gt;http://www.w3.org/TR/xhtml1/]] >> >> -{{warning}}The implementation for these syntaxes is not fully finished yet. For example support for links is not working perfectly yet. We also need to define if we want to extend the original syntaxes to support XWiki-specific features like ability to link to another sub-wiki.{{/warning}}</content></xwikidoc> >> \ No newline at end of file >> +{{warning}}The implementation for these syntaxes is not fully finished yet. For example support for links is not working perfectly yet. We also need to define if we want to extend the original syntaxes to support XWiki-specific features like ability to link to another sub-wiki.{{/warning}}</content></xwikidoc>