(anonymous guest) (logged out)

Copyright (C) by the contributors. Some rights reserved, license BY-SA.

Sponsored by the Wiki Symposium and the Nuveon GmbH.


I have been thinking more about escape. I have started leaning towards the "Escape character should be core" idea (in conjunction with "Escape character should escape a single character" and "Escape character should be ~"). I think it fits well with any future expansion of Creole. However, my real concern is what to do with preformatted block content and external links containing escape characters which are not rendered in the final output. For me, escaping whole Creole markup sequences is not a broad enough solution and imposes hidden constraints and limits future expansion. It was an excellent idea, but I don't believe it's the right way to go. Either we have all or we have nothing.

In the meantime, the simple escape mechanism proposed here for preformatted blocks, I believe, is both adequate and safe. If we don't end up with an escape character then this is the best alternative, without a doubt. Having said that, I will endeavour to work through my escape thinking over the next few weeks and input into any escape arguments.

-- MarkWharton 2007-05-10

We changed the two angle brackets to three angle brackets, to make it easier to write plugin syntax (see GenericExtensionElementProposal, BlockMarkupNotionCriticism). Placeholder syntax is generated by the wiki engine, while plugin syntax has to be written by users. I think this last small change will not influence any implementation since nobody uses placeholders so far, and on the other hand will make it easier to evolve creole additions in a way that is consistent with the goals of fast to type and readable markup.

-- ChristophSauer, 2007-Jun-01 15:54 (CEST)

The escape character should become part of the core Creole 1.0. Adding a simple and generic escaping rule now isn't that big deal. However, adding it later (or make it optional) will cause some headaches I think...

-- OliverHorn 2007-06-05

I agree. With you now we have a majority ;-) Let's add it. Let's replace Creole1.0#section-Creole1.0-EscapingPreformattedNowiki with the more generic escape character rule from Creole Additions. Radomir? Yves?

-- ChristophSauer, 2007-Jun-06 10:19 (CEST)

I still don't like having an escape character. If we must have one, however, I prefer Radomir's mechanics, as explained on Talk.Escape Character Decision.

-- AlexSchroeder

Yes, I still agree with an escape character in Creole Core which escapes the next non-alphanumeric character only, everywhere but in inline nowiki and block preformatted. Wrt Radomir's mechanics, everything is fine, except that I wouldn't convert tilde+newline to forced newline; trailing invisible blanks would have an effect very difficult to track down for most authors. GNU make has this problem, which is a real nuisance imo.

Ideally, what's between angle brackets for plugins and placeholders should be better defined (escape, quotes, etc.), but I'm affraid we won't reach easily a consensus. I'm most probably going to have block plugins similar to block preformatted where nothing is interpreted except for the left-aligned end mark, and inline plugins where the first occurence of right angle brackets marks their end (with "block" and "inline" I mean in the Creole text, not in the parser output); i.e. I'll keep my current implementation, adding basic support for placeholder's triple angle brakcets. So the escape character wouldn't have an effect there either.

-- YvesPiguet, 2007-Jun-06

1) (view wiki source to see the correct markup :-) ) Inconsistency for "Nowiki (Preformatted)". The text says "As a block, the three curly braces should be on one line by itself to open and another line of three curly braces should be on a line by itself to close. In a block, characters are displayed in monospace. For inline nowiki text, wiki implementers can decide whether to display this text regularly or in monospace."

The example says: "Some examples of markup are: ** <i>this</i> ** "

Is it ok for inline nowiki to be formatted like this?

2) Really no definition lists? ;-)

-- MaxVoelkel, 2007-Jun-06

1) Why would it not be ok for inline nowiki to be formatted like that?

2) Definition lists can be added to Creole Additions.

-- ChuckSmith, 2007-Jun-06

2) Done.

-- YvesPiguet, 2007-Jun-06

From my experience it is possible to break creole elements down to a reasonable set of features for processing on a case by case basis. The main feature is the creole line type, the remaining features are open and closed creole elements. If we treat creole elements as either line type elements, open elements, or closed elements it then becomes possible to easily determine when to escape and when not to escape.

Line type elements describe the block and, depending on their actual type, can contain regular text and/or other open or closed creole elements.

Line type elements include: heading, horizontal rule, lists (ordered and unordered), paragraph, placeholder, preformatted, and table.

With line type elements, starting characters are escaped. Escaped line type elements change the line type itself (e.g. ~== changes from heading to paragraph). The contents of the block are escaped on a case by case basis. With preformatted, nothing is escaped. However, there is a special case for one or more escape characters (i.e. tilde) followed by three curly braces on a line by themselves. In such cases, following tradition, one tilde will be dropped to effectively escape and also allow representing any possible text inside the preformatted block. With placeholder, nothing is escaped. Perhaps it should have a special case like preformatted?

Open elements contain regular text and other open or closed creole elements.

Open elements include: bold, italics, and table (cell separators).

With open elements, all regular text is escaped. A tilde followed by a non alpha numeric character which is not a tab or a space (e.g. [^\t 0-9A-Za-z]) will drop the tilde and remove any special meaning from the following character.

Closed elements contain regular text, optional modifiers generally followed by regular text, and the necessary closing characters or end of line or file.

Closed elements include: links (regular and free standing external links), image, nowiki, and placeholder.

With closed elements, nothing is escaped.

When a series of closing characters exceeds the minimum requirement (e.g. ]]]), only the final characters are used to close the element. This technique allows natural nesting of special characters to achieve results which might otherwise require escaping (e.g. [[Home|[{{home.jpg|{Home!}}}]]] produces <a href="Home">[<img src="home.jpg" title="{Home!}" />]</a>). Note: It was necessary to escape the example to produce the desired effect here.

I don't believe pipe is legal in filenames and URLs (please correct me if I'm wrong!) and therefore doesn't present any issue here. Image source and link references are always specified first in their respective creole elements so pipe as an optional modifier works as expected, and does not require escaping.

This escape design provides a simple, safe and effective escaping mechanism which does not force authors to change important filenames and URLs to avoid accidentally escaping them. Of course, this idea depends a lot on the available parsing tools. It is implemented and working well in my Ragel based creole parser.

I must admit that I tend to over complicate things. If there's a better way to escape without forcing authors to change important filenames and URLs then let's do that. If I need to change my thinking around this issue then please help me with it. Actually, now that I've gone and written all this, it looks way too complicated! I'll respond later.

-- MarkWharton 2007-06-07

OK, so I have gone through the current spec and notes on escape character etc. Everything looks mostly fine with the current spec in regards to the escape character. However, I feel there are a small number of issues which still need to be clarified...

Escaping Nowiki and Preformatted

The current spec implies escaping nowiki and preformatted, however this will not work in practice, particularly with preformatted. I believe the original ideas presented in AddNoWikiEscapeProposal for preformatted are still useful. Therefore please consider the following.

Preformatted escape specification requires:

  1. a similar special case for preformatted, or
  2. to specify that preformatted cannot be escaped.
(The special case for preformatted being my preference.)

Nowiki escape specification requires:

  1. to specify greedy closure,
  2. allow full escaping as is possible elsewhere in a wiki document,
  3. allow minimum escaping of the nowiki close character and the escape character itself, or
  4. to specify that nowiki cannot be escaped.
(I have no particular preference, it just needs to be clear. Maybe 1 or 3, if I had to choose.)

Escaping Placeholders and Plugins etc.

Similar issues. Should the same rules for nowiki and preformatted apply?

Apologies for being such a late comer to the escape discussions. Obviously, I should have followed the original escape discussions more closely! It would be great to get some feedback here. ;-) A simple discussion could resolve these issues. I would change the spec directly but I feel it could lead to discontent.

-- MarkWharton 2007-06-09

I have difficulties in understanding exactly where this is leading to. I don't know what is the more generic escape character rule from Creole Additions mentionned above by Christoph. I thought the one-escaped-char rule would finally be adopted (I think Christoph or Chuck said so recently but I can't find it now), but it isn't in 1.0, so I don't know what will be retained in the final spec.

Basically I share all the concerns of Mark; I just didn't know I had to have such concerns. What I'd propose:

  1. tildes escape one nonalphanumeric nonblank character outside nowiki, block preformatted, plugins and placeholders and are rendered as tildes everywhere else
  2. greedy rule for nowiki is preserved
  3. end marker of block preformatted must be aligned to the left; so the "space escape" still works
  4. "block plugins" with lines containing only double angle brackets make possible to embed >> in the body of the plugin.

Except for this last rule, I believed this was what Christoph and Chuck had accepted. I know I shouldn't propose the last rule here, just use it quietly in my implementation, because the time for discussion is over.

-- YvesPiguet, 2007-Jun-9

I'm confused. Can somebody rewrite the above and add some examples?

-- AlexSchroeder

Alex, on the poll page you are proposing that the escape character should have no effect inside URLs. I'm against such a proposal because a) it complicates things, and b) it is not not needed.

Nearly all occurences of tildes in URLs are at the beginning of path segments. But then they are usually followed by an alphanumeric character and are rendered as-is with current escape rule (which escapes only when followed by a non-alphanumeric non-whitespace character).

-- OliverHorn, 2007-06-10

Well, we have the choice between two complications: Only use the tilde as escape character when followed by a non-alpanumeric and non-whitespace character, or not use the tilde as an escape character inside URLs. I think that the second option is easier to implement and easier to understand.

-- AlexSchroeder

I personally think it should be obvious to a user that he/she should not not have to escape a tilde without a URL, because most likely such addresses will just be cut and pasted anyway.

-- ChuckSmith, 2007-06-11

I tried to write a grammar parser for the Creole 0.6 specification. Thus the specification is desired for regular expression based translation to HTML, I have some issues you might not consider and I hope it’s could be interesting for you. I mean if the 1.0 specification should be valid for two years, you could/should consider that some people want to use a scanner/parser created from a grammar. Why not, it offers much more potential for the future. Further you can offer a grammar instead of a prose specification. Wiki engine developer could easily use different scanner/parser generator for different target programming languages.
"The bold/italic text will end at the end of paragraphs, list items and table cells": This implies that closing bold/italic markup is optional in a grammar and this implies that the unacceptable **//bolditalic** cannot throw an error. I think a user who can handle an escape character that only escapes in front of an non-alphanumerical and non-whitespace character can close the markup or at least can see on the rendered page that something is wrong.
The leading spaces before list items are user-friendly, but imo not necessary, because you get an indentation by the number of asterisks/pounds. On the other hand, why isn’t it allowed before a heading? (This conflicts with usability.) Using a greater look-ahead for skipping the leading spaces decreases the performance of the parser and complicates the definition of a grammar.
Paragraphs: "A list, table or preformatted block end paragraphs too." I think it is mentioned that each list, table, preformatted block is its own paragraph, isn’t it? Btw, it would be much easier to parse if every time a blank line separates the paragraphs.
Independent from any implementation, an escape character should be context-free. I would expect this behavior and I think it's easier for a user to remember that there is an escape character and what it effects than giving a specification where it works and where not.
Annotations for publishing a clearer specification:
Lists: "Bold, italics, links, nowiki can be used in list items". Nowiki could be nowiki inline or nowiki block. Later this is called preformatted. It becomes more confusing as the monospaced occurs (in Tables). It would be easier to use a fixed nomenclature. The example "* This is a single list item
followed by a paragraph?" does not really fit to forced linebreaks. It should be in the Lists section to clarify the end of a list.

-- Martin Junghans, 2007-06-11

About closing bold and italics, I had implicitly put in the examples that if there is an opening double slash without a closing double slash, then it would be rendered as just a double slash without italic markup. However, since then, many developers have coded the functionality that an opening double slash would just start italics and it will automatically close at the end of the paragraph. Is this worth changing? I hate to change things now so close to when we planned 1.0 to go live, but then again, it will be frozen for 2 years. I am now going back to the spec to fix the monospace, preformatted, nowiki inconsistency.

-- Chuck Smith, 2007-Jun-12

Automatic closing on paragraph end enables one-pass parsers, without the requirement to parse complete paragraphs before generating any output. That's why I think it's a good thing.

-- YvesPiguet, 2007-Jun-12

Many things remain unclear in the current Creole 1.0 draft:

( I have answered you as a subpoint under each appropriate item. --Chuck Smith, 2007-Jun-12 )

  • Some block markup must be aligned on the left (headings), some must not (list items), and some lack information (block preformatted); any justification?
    • Do you mean justification as in alignment of text or as in reasoning of why we did it that way? -CS
      • I think it would be easier to remember if there is a general rule, with maybe an exception with good, explicit explanation. For instance all block markup should be left-aligned, except list items where indenting makes multilevel lists easier to read and titles where the optional end tags are on the same line. In the current draft, for headings, it's written that "whitespace is not allowed before the left-side equal signs"; for lists and horizontal rules, that "whitespace is optional before and after the * or # characters"; for tables, no indication; and for block preformatted, I guess it's more or less implicit that spaces aren't permitted before braces. -YP
  • Escape character introduction should be rewritten ("it would be useful", "it would certainly never escape"...)
  • Mix between escape+nonalphanumeric ("certainly never escape if followed by an alphanumeric character"), escape+any single character (recommendation for camelCase), escape+markup ("only trigger if you use it in combination with a character that has special meaning in creole"), and ad hoc ("Also note that tildes within URLs should not be escaped")
    • Rewrote section on escape character to make it clearer. -CS
      • Could you add that a tilde does not escape alphanumeric characters and blanks (general rules which makes URL stuff useless) except before camelCase (useful exception for some wikis), and remove completely the part related to existing markup? Or may I do it? That's the way I interpret all the polls and discussions. -YP
  • It isn't specified if escape characters are recognized inside nowiki and preformatted (I fear they are). What about double-tilde?
    • I think we should not interpret escape characters within nowiki except for the closing triple braces. Do you agree? If so, I can change the spec to make this clearer. -CS
      • I'd prefer no exception, since then one should add double-tilde, and all fragments where a tilde appears couldn't be used verbatim. Triple closing braces in the middle of nowiki are rare enough that one can end a nowiki fragment and start a new one (like (((some))))))(((unlikely fragment))) to be rendered as some)))unlikely fragment, where I've replaced braces with parenthesis to make sure this sample will always be rendered as I want it now); tildes are much more frequent. -YP
  • If tildes aren't interpreted as escape characters in preformatted/nowiki (which I'm not the only one to wish), "removed escaping closing nowiki triple curly brackets" should be reverted
    • I think it would be best if only the closing triple curly brackets could be escaped within a nowiki and that tildes cannot escape anything else in a nowiki block. What do you think? -CS
      • Same as above; if you want to use tildes to escape braces, you must also have a way to escape tildes, and it complicates the description a lot (and the implementation, but it's less of a problem). -YP
  • "An escape character can be escaped by putting a space after it, since a space cannot be escaped": wrong, this would be rendered as tilde+space instead of a single tilde for a truly escaped tilde
    • We had agreed before that a space could escape an escape character, but perhaps this is no longer a good idea since we have now chosen the tilde instead of a backslash. Do you agree? -CS
      • You mean tilde+space would be rendered as a tilde? That's backward escaping, one more exception I'd rather avoid. -YP
  • What does "added escape character to core (as requested in Creole 1.0 Poll) with exception to URLs" mean?
    • It meant that tildes would be escape characters, but would have no effect within URLs, which was unspecified before. -CS
      • But since there are other exceptions (spaces, alphanumeric, in nowiki/preformatted), it'd be clearer not to mention it here. -YP
  • May an implementation which fixes all these issues still be named "Creole"?
    • I believe so. -CS

-- YvesPiguet, 2007-Jun-12

Yves, your recommendations sound reasonable, so I would ask that you edit the spec directly with your corrections and then we can see if anyone complains. I think if I saw your recommendations in the spec, it would help to see what you want to change. There's always the revert button, but I think you'll be conservative in your edits. Thanks! Afterwards, we'll probably drop the acceptance date back another week to give others a chance to respond.

-- ChuckSmith, 2007-June-12

Ok, thanks, I've done it. I've also rephrased optional markup interpreting in headings (slightly less negative) and removed "This is the only new markup introduced in Creole" in the placeholder section (not relevant anymore, imo).

There are still the leading spaces before the four hyphens for horizontal rules which I'm not sure about.

-- YvesPiguet, 2007-June-12

I approve your changes.

-- ChuckSmith, 2007-June-12

Chuck Smith wrote: "I had implicitly put in the examples that if there is an opening double slash without a closing double slash, then it would be rendered as just a double slash without italic markup."
Okay, I didn't find it, but is this really a good idea to have several meanings of the markup depending on the text following somewhere far behind? IMHO it's the worst issue of the specification. ;-)

-- Martin Junghans, 2007-06-12

Martin, thanks for your comments. Not sure if you know but there was an early attempt to provide a context-free grammar for Creole. It was before I joined the Creole community. For whatever reasons, the original author (I believe) has written it off as a "failed attempt". It was an interesting direction but was not pursued.

On the subject of compiler tools, I was able to create a reasonable state chart for an earlier version of Creole using the Ragel State Machine Compiler. IMO, it is entirely possible to generate parsers for the current Creole specification using grammar and/or state machine definitions with these types of tools.

I'd be opposed to changing the spec now to accomodate another attempt to provide a formal grammar for Creole.

-- MarkWharton 2007-06-13

Yves, thanks for all your hard work on the spec. It looks much better! The escape character description is logical and clear. It makes sense to keep things simple but how would you feel about adding a small note describing the greedy rule for nowiki and the "space escape" for block preformatted. I'd feel more comfortable if that was specified too.

-- MarkWharton 2007-06-13

Thanks Yves.

Generally, I'd avoid this kind of sentences, as they contrast the Extensible by omission goal:

"Whitespace is not allowed before the left-side equal signs."

I agree syntax can be simplified making it stricter, but implementations should be free to extend it.

-- Michele Tomaiuolo, 2007-06-13

Thanks for the kind words! I've added the escaping rules of Add No Wiki Escape Proposal. The sample code isn't rendered correctly yet by the current engine.

Michele, I did it to be consistent with other places where whitespace was specified (explicitly forbidden before headings, explicitly permitted before horizontal rules and lists).

-- YvesPiguet, 2007-Jun-13

1. Escaping recommendation for WikiWords: I think this scenario should be covered. But I don't like the current recommendation because it contradicts the general escaping rule (which says that the tilde followed by a letter does not escape!). Such discrepancies in behavior limit interoperability between Creole engines: A Creole engine with WikiWord support would render these words without the tildes whereas a pure Creole engine would render them with the tilde.

2. Escaping free-standing URLs: Shouldn't it be possible to escape free-standing URLs too to prevent them from becoming a link?

3. Closing braces in (inline) nowiki: I'm not really satisfied with the current escaping rule because it only works at the end of the nowiki text. It is not possible to include (escape) three or more closing braces anywhere within the inline nowiki text.

-- OliverHorn, 2007-06-13

1,2) Very good points. I will try to add them to the spec, then you can check to see that I added them as you wish.

3) Can you see when it would be useful to escape triple curly braces in inline text? It seems like it is such a rare case that if it were that important in a specific case, users would be able to do it in block nowiki.

-- ChuckSmith, 2007-Jun-14

3) The current ways to do it inline are with two consecutive inline nowikis or with the escape character outside nowiki.If you support a more general escape mechanism in nowiki, you either need to escape the escape character itself (painful since tildes are common in many programming languages and nowiki is especially well suited to code fragments) or to have more exceptions. I much prefer the current rules.

-- YvesPiguet, 2007-Jun-14

I don't like the way wikis which don't support camelcase autolinks should still recognize camelcase words following tildes. I suggest the following rules:

Outside nowiki, preformatted, and URL, the escape character only escapes the character immediately following it, provided that it is not a blank (space or line feed).

The escape character disables the automatic conversion of URL to links and any similar mechanism supported by the wiki engine (camelcase wikiwords, copyright sign, etc.)

Unix paths where the tilde usually represents the home directory would have to be escaped, but this is not a big problem since they're likely to be put in inline nowiki anyway. And we can't be expected to handle automatically all situations where some syntactic construct of a language or shell might collide with Creole.

-- YvesPiguet, 2007-Jun-14

Escaping an url is easy: http~://something

-- Michele Tomaiuolo, 2007-06-14

Yves, I modified your add to the "Escaping Nowiki". I agree that it is useful to not use tilde in nowiki to escape, but using a completely different mechanism now that we have a general escaping mechanism agreed upon feels odd. I think saying: Tilde does not escape in nowiki except with use on three closing curly braces is much simpler to understand, furthermore it is not new: JSPWiki uses it.

-- ChristophSauer, 2007-Jun-16 14:48 (CEST)

Michele, the URL escaping via http~:// may work but it is not very intuitive. I personally like the rule that a tilde in front of a link (i.e. a URL or a WikiWord) disables the link behavior.

Two address Yves' concern about the current recommendation that engines not supporting WikiWords should still recognize them: I think that engines whether or not they support WikiWords should behave equally. But maybe we could cover these cases in a general way by a slight change to the escape rule. Why not saying that a tilde at a beginning of word always escapes. If it is a link, then the tilde will additionally disables the link behavior...

-- OliverHorn, 2007-06-16 16:33

using tilde with three closing curly braces as an exception simplifies rules: no, because then you must escape the escape sign; and we had already limited the escape scope to a single character.

What's wrong with the previous rules? (greedy nowiki and leading spaces)

-- YvesPiguet, 2007-Jun-16

I would tend to agree with Yves here and would like to change it back where a leading space before the triple curly quote escapes it. Would anyone object to going back to this way of escaping the end of a nowiki block?

-- ChuckSmith, 2007-Jun-16

Chuck, I have no objection whatsoever. The greedy nowiki and leading spaces rules are my preference. These two rules, as presented in AddNoWikiEscapeProposal, allow the most flexibility with minimum side effects. It is the natural complement to an escape character everywhere else. There is the one special case, as Oliver points out above "3. Closing braces in (inline) nowiki". However, this can be accomodated by closing the (inline) nowiki and immediately opening a new (inline) nowiki. An optimizing parser could even factor this in to produce seamless one span nowiki output, if it is considered an issue.

-- MarkWharton 2007-06-17

I agree, too. The changed rules seem to be broken because there is no way to escape the tilde itself (but that's needed if it is used as escape character).

Yves' suggestion for the inline nowiki (with greedy rule) to do it with two consecutive inline nowikis is fine for me.

-- OliverHorn 2007-06-17

Christoph, I restored version 26 because I'm concerned that the escape character for nowiki (preformatted) is getting off track. What you're proposing doesn't work and you're also making small changes here and there without considering the impact to the other areas of the document. It's not a criticism of you so please don't be upset. I'll be travelling in the next couple of days and wanted to reset things around the agreed solution before heading off. I admit it's a little harsh and not like me to restore a version like this. However, I believe the general opinion here is that the greedy nowiki and leading spaces rules are the correct solution and so we should be working more with that. If I'm wrong then please accept my apologies and restore to a later version. Hopefully see everyone in the planned IRC meeting on Tuesday night (my Wednesday morning).

-- MarkWharton 2007-06-18

So what do we decide about Multiline List Items? It seems there are very few wiki engines supporting multiline paragraphs but not multiline list items.

Anyone opposed to the proposal?

-- YvesPiguet, 2007-Jun-18

For the nowiki escape: Whatever. What do you mean by "multiline paragraphs"?

-- ChristophSauer, 2007-Jun-18 21:53 (CEST)

Wiki-like line breaks which were chosen for Creole (see ChangeLinebreakMarkupProposal). The same rule would apply to list items.

-- YvesPiguet, 2007-Jun-18

I am indifferent to Multiline List Items, and am afraid it might break some existing wikis when they introduce Creole into them. I know Alex Shroeder is for this change, but don't know how others stand. Any other opinions on whether we should introduce this into Creole 1.0?

-- ChuckSmith, 2007-Jun-19

I don't find the way the escape character is described very satisfactory (I mostly agree on the mechanism). What about what I proposed above on Jun 14th (remove alphanumeric exception, but add a single exception for URLs)? What I wrote about paths isn't very relevant, because the most common use of tildes there is before a slash where it would need to be doubled anyway, not before a username.

Should we add this to the agenda for tonight?

-- YvesPiguet, 2007-Jun-19

I'm not sure about the change. However, the removal of the alphanumeric exception will also solve the WikiWord escaping problem: A tilde at the beginning of a word will always escape the first character and hence the behavior is independent of the engine's support for WikiWords. (We still need the rule that the tilde disables the linking behavior.)

-- OliverHorn, 2007-06-19

Isn't it the same? The point is to solve wikiwords, urls, and engine-specific autoconversion (smileys etc.) simultaneously.

-- YvesPiguet, 2007-Jun-19

I didn't propose the alphanumeric exception so I am not sure why this exception was initially made. I favor a general rule which covers all these problem cases, so nothing against the change from me.

Multiline list items: I like the idea behind it, but it creates another BoldAndListsAmbiguity ambiguity: How do you distinguish a 2nd level list item from a 1st level list item continuation starting with bold?

-- OliverHorn, 2007-06-19

I've made the escape modification we discussed earlier this morning (CEST), trying to be clearer (The following character is rendered as is and cannot be a part of any Creole markup).

I think the escape character section should come immediately before or after the section on nowiki.

-- YvesPiguet, 2007-Jun-20

Have you ever talked about invisible text (comments)? I think it may be useful to have this. What do you think?

-- Martin Junghans, 2007-06-24

I agree, but it's probably too late. You can have a plugin for that:

<<! comment >>

Plugins will also be required for metadata.

-- YvesPiguet, 2007-Jun-25

I'm back online with some time to talk. Sorry to miss the meeting last week, it looks like it went reasonably well (I read through the log). Unfortunately, I wasn't able to get a connection. I'm still travelling but will be back into my normal routines (and desk ;-) by the end of this week.

I logged in yesterday to vote, but in the process of cleaning up some spam, I was blocked...

  1. Herb says you look like a spammer, and I trust Herb! (Incident code GLVNGU)
  2. You have been temporarily banned from modifying this wiki. (1765 seconds of ban left)

Needless to say, I didn't try to cleanup any spam today.

-- MarkWharton 2007-06-26

Perhaps comments (i.e. invisible text) would be something to put in Creole Additions.

-- ChuckSmith, 2007-Jun-26

The note I wrote about Closing braces in nowiki should be removed when it becomes obsolete (when the wikicreole engine gets creole-compliant), before 1.0 is "released".

-- YvesPiguet, 2007-Jul-4

I just corrected the display of the "Escape Nowiki" using the JSPWiki escape syntax, since the CreoleFilter does not support the syntax as proposed. I'll change it as soon as the Creole 1.0 changes are implemented.

-- ChristophSauer, 2007-Jul-05 11:02 (CEST)

At first I was pretty excited that somebody finally managed to reach an agreement on a common wiki markup. I'll probably adopt it for my Wiki anyhow. But still I'm somewhat concerned about its dead end status.

The 1.0 specification explicitely says "frozen" and "no development for two years". And ultimately, there couldn't be any - after full two years of no-moving. So if there's no chance for a 1.5 or ever seeing a Creole 2.0, won't Wiki markups drift apart again sooner or later? I'm uncertain that Creole additions are going to cut it.

Surely that decision stems from not wanting to implement a moving target (0.1, 0.4, 0.6, 1.0, ...). But why exactly did Creole had to go frozen? That somehow has a little no-progress sound to me, atm.

-- Mario, 2007-Jul-11

I agree. I don't know if, when, and by whom it was discussed openly. I don't know why the last scheduled irc talk was cancelled at the last minute either.

-- YvesPiguet, 2007-Jul-12

In the sense of feature freeze, a goal stated in the wms markup workshop: "Stable for the next three years". We changed that into two, and of course I agree that if it turns out that there are deficiencies in the core we will address them together immediately (I mean real interoperability problems, not something that was already discussed). But now it's time to give developers the certainty that they don't have to change something all the time, that for them is not a core feature. It's time now to collect experiences in the real world, instead of endless discussions what might be good or bad. Feel free to add your opinions on the talk pages, and make suggestions and improvements under Additions.

irc talk was canceled due to lack of interest (according to Chuck), but I would be happy if we could have one again on the topic of promoting creole.

-- ChristophSauer, 2007-Jul-12 13:52 (CEST)

I agree with what Christoph said and just want to add that there can be discussion about Creole 2.0, but we don't want to change the spec, unless there are real shortcomings before a two year period is over. I cancelled the IRC meeting, because it seems like we were going to have a meeting for meeting's sake, instead of meeting to discuss real issues. Also, it was conflicting with the monthly WikiOhana meeting. However, we are planning to host another IRC meeting soon on promoting Creole.

-- ChuckSmith, 2007-Jul-12 14:43 (CEST)

Ok, thanks. I think future evolution should preserve compatibility as much as possible; that's why I'm happy with the last decisions, because it was the last moment to make them. But on the other hand, the term "frozen" might discourage new developers, because long-term congelation is a little too close to death: it could be difficult to restart fruitful discussions in 2009.

Meetings risk to be less active during the holiday season...

-- YvesPiguet, 2007-Jul-12

It was a pity I missed the 03 July meeting, anyway if I could be there I wouldn't have done more than lurking because I am relatively new to Creole in general. I also think that it would be better to say that "discussion and modifications" to the Creole spec are currently on hold, instead of the set amount of time of 2 years which can be an epoch in the IT world. Also, shouldn't the specification change (I know that this democratical concept conflicts with the "moving target" issue and creates a paradox) when more people (let's say for example, in the case that the number of people interested doubles) join? That's why I am generally against a "frozen" idea: it is something that mature projects can do, WikiCreole is a high-quality project but it is not yet so widespread to make such choices (in my humble opinion). I know that having it "frozen" will help developers to catch with it, but was it the correct choice from the marketing point of view? (please no flames, I am new here and I am respectful to this great project and the work that other people have done up to now!) Most probably there isn't a yes/no answer, a compromise had to be done, in such case please excuse me for moving around the dust

-- DanieleC., 2007-Jul-12

Daniele, you are right. "Frozen" is the wrong term here. I changed it to your suggested phrase. Thanks!

-- ~~~

Glad to give some help :)

-- DanieleC., 2007-Jul-14

It would be even better to say why Creole is on hold on the home page of wikicreole; otherwise, new visitors might think there is some major problem which needs a solution (technical issue? conflict between contributors? lack of interest?)

If you don't want these details on the home page, the fact that the specification is on hold could be moved elsewhere, such as in Versions (where the word frozen should be replaced anyway for the sake of consistency).

-- YvesPiguet, 2007-July-17

Hello, not quite sure of how/where corrections should be sent.

There appears to be a conflict between the line break section and the list section.

From the Line break section

Recommended XHTML:
* This is a single list item
followed by a paragraph?

<li>This is a single list item</li>
followed by a paragraph

First note, that the "?" is missing from the XHTML (and the use of "?" here is a bit confusing).

More importantly, this seems to contradict what is in the list section:

A list item ends at the line which begins with a * or # character
(next item or sublist), blank line, heading, array, or nowiki block;
like paragraphs, it can span multiple lines and contain line breaks
forced with \\.

To me, "span multiple lines" implies that

* foo

new paragraph

should render to

<li> foo
new paragraph

Other note: what is an "array" block? I don't think this term is used previously or anywhere else.

What is the correct list element processing?

  1. Close list element at end of line (from Line Break section)
  2. Close list element when new list element is found, or when a block element is encountered (e.g. table, heading, hr, paragraph) (from List section)

thanks all

-- NickGalbreath, 2007-July-17

Thanks for your remarks; I've removed the example in the line break section (no more valid with multiline list items), and I've replaced "array" with "table" (my fault). I hope it's fine to fix these mistakes in 1.0; otherwise, there should be revisions (1.0a, 1.0b, etc.).

List items can span multiple lines.

-- YvesPiguet, 2007-July-20

Excellent. Thanks Nick for the remarks! Yves, I trust you so it's fine if you fix mistakes in 1.0. I wasn't able to do so the last few days. Nick, the multiline list items came in quite late, see 26JunMeeting and Creole 1.0 Poll, so I guess we overlooked to change the mentioned rule in the spec.

-- ChristophSauer, 2007-Jul-24 06:03 (CEST)

This discussion page is much too long. If there has been some consensus that condensed into creole 1.0, the old discussion here should be moved to some archival page and this discussion page should be about creole 1.0 as it is.

The main page also has some contradictions in the change notes vs. the main spec. text and should be cleaned up:

  • escape char
    • The spec section should mention "The escape char is the tilde (~)." Currently you can only guess it from the examples.
    • The change notes talk about "the escape character" at one place and about "tilde" at another place. This should be changed to "the escape char" at both places if this was the intended meaning.
    • The change note "removed escaping closing nowiki triple curly brackets because this is now covered by the escape character" is unclear (removed WHAT escaping?) and contradicts the spec section about "Closing braces in nowiki" (the latter one says "lines with three closing braces which belong to the preformatted block must follow at least one space"). Decide, do we now use "}}}" to escape or " }}}"?

For people not knowing mediawiki, the placeholder stuff is unclear.

-- Thomas Waldmann, 2007-08-09

I've moved Thomas remarks at the end to keep chronological order.

I agree with all your remarks. Thanks! I'd also move the list of changes at the beginning of Creole 1.0, because they're irrelevant there in what should be a reference document.

I've made the changes you propose, except for the escape character" at one place and about "tilde" at another place which I'm not sure to understand."Removed escaping..." is obsolete; I've removed it.

The placeholder is unclear to many people. An implementation which uses it would be helpful to evaluate it. I guess it could contain a number which would refer to a table of unsupported stuff when converting from some richer markup language like mediawiki, to permit restoring them when saving modifications. Whether it would be practical is an open question to me.

I leave the decision to move this discussion or the list of changes to somebody else.

-- YvesPiguet, 2007-Aug-9

Creaole and other wiki-syntaxes like it really fall short if you have lots of external (and therefore often long) links. This is especially the case when using Creole as a Blog-Language, or when writing scientific documents (or other texts where you have to carefully cite your sources).

Therefore it would be great if the parsing rules could be relaxed a bit, so that if a link with description has the link at the second position and the first is clearly not a link, it still gets shown sensible.

That would help greatly.

-- Martin Häcker

What's the problem?

-- YvesPiguet, 2007-Sep-20

how would additional links like the ones used in http://trac.edgewall.org best fit into creole? --ThurnerRupert

Which additional links?

-- ChuckSmith, 2007-Okt-17 15:08 (CEST)

What about underline and strikethrough?

-- Mo 2008-Mar-14

Underline is an addition. Strikethrough is not defined (yet?). It's been discussed at different places, though; do a search for "strike".

-- YvesPiguet, 2008-Mar-16

Self-contradiction in escape character#

I find it self-contradicting or at least ambiguous. On one hand, it says, that escape character escapes just the following character, i. e.

should be rendered as
On the other hand it says a tilde escapes the whole URI.

It is obscure, whether

~** bold ** text
should be rendered as
** bold ** text
(escaping the whole pattern, as an URL) or
** bold <strong> text </strong>
If escaping URI as a whole is an exception, it should be explicitly marked as such.

-- IvanFomichev, 2008-04-04

In front of something which is converted automagically, such as a URL (but not explicit markup), it prevents the conversion. Elsewhere (except in nowiki, preformatted and inside URL, or in front of a blank), it escapes a single character.

-- YvesPiguet, 2008-04-04

The EscapeCharacterProposal is somewhat different from the final spec. I don't like ~ in URLs be considered escapes. They are common in user URLs and there is no need escaping a character that is not considered special by Creole.

On this Wiki, ~ escapes the URL, but the URL is parsed as inline text:

  • ~http://example**.org**/~user/ is rendered http://example.org/~user/
  • ~http://example//.org///~user/ is rendered http://example.org/~user/

Another test; Creole formatting inside URLs:

-- LarsChristensen, 23-May-2008

Please don't consider what this wiki is doing to be "the final spec". The implementation isn't perfect. You've pointed out a few deficiencies here for sure. Tildes in urls are fairly common and Croele should treat them as any other character.

This wiki uses Creole and it does a better job with your tests. ;)

-- StephenDay, 23-May-2008

Example with two opening braces? #

The current (12-May-2008) page gives the following example for inline NoWiki markup:

 {{if (a>b) { b = a; 

There are only two opening braces. Is that intentional?

-- Ben Kovitz, 12-May-2008

The parser is having trouble with this. There should be three opening braces and four closing ones.

An admin needs to unlock the page to fix it (or add a comment that it is not displaying correctly).

-- StephenDay, 13-May-2008

Thanks for the clarification. I'm implementing the {{{ just as a token, and not bothering trying to match up braces inside the Nowiki text with any braces that occur before the }}} appears.

-- Ben Kovitz, 13-May-2008

Use of TT tag for representing code#

For code rendered using the {{{ }}} technique, would it not be better for the markup to be <code></code> tags rather than <tt></tt> tags, as the former gives semantic meaning and allows the browser to choose an appropriate font, wheras the latter is simply a display tag?

-- M1ke, 18-May-2008

Creole doesn't specify that <tt></tt> be used, it's just a suggested implementation. <code> could be used, as could <span>, or no markup at all (or whatever).

-- StephenDay, 18-May-2008

Add new attachment

Only authorized users are allowed to upload new attachments.

« This page (revision-108) was last changed on 24-Sep-2008 09:01 by