[Phpwiki-talk] Re: Wiki RFC Discussion

[Philippe C. <ch...@sy...>]

electron wrote:

>This seems fine by me, a standard could benefit everyone well. Below are my
>thoughts:
>
>---
>
>2.2. Colored Text 
>Text can be any color you want it to be. Two Tildes (~) are used followed by
>the name of a color and a Colon (:) to specify the start of the Colored
>Text. Two additional Tildes (~) are used to end the Colored Text. 
>
>Example: ~~red:This is text is Red~~ 
>
>Colored Text can also be specified using HTML colors. HTML colors use 3
>pairs of Hex numbers; one for Red, Blue, & Green so that 00 00 00 would
>produce white. The syntax is two Tildes (~) followed by the Pound (#)
>character and the Hex Numbers with a Colon (:) followed by the text to be
>colored. Two Tildes (~) mark the end of the Colored Text. 
>
>Example: ~~#ff00ff:This is text is the color Magenta ~~ 
>
>Note: Not all Color Names are valid in all Browsers, so to be on the safe
>side, it is usually best to use the HTML number by default.
>
>---
>
> Add Section 2.2.1 or an appendix where Wiki applications define red, blue,
>green, etc. Wiki applications should not pass on these words to the browser,
>only the #sequence. One has to think of international compatibility as not
>everyone speaks English.
>
>---
>
>2.11. Page Breaks 
>Page breaks allow you to control the length of a page for easy reading. A
>new page can be added anywhere but should start at the beginning of a line.
>A page break uses 3 Periods (.), the keyword page and another 3 periods (.) 
>
>Example: ...page...
>
>---
>
>Suggestion: Use 3 underscores instead. (___) No need for any sort of
>"Keywords" in Wiki. Wiki is supposed to be simple.
>  
>
Good idea I think. "page" is only francophone and anglophone AFAIK.

>---
>
>2.15. Non-parsed text 
>It may be needed in some instances to avoid wiki to interpret any text. The
>use of (~np~) and (~/np~) can be used to enclose a non parsed text. 
>
>Example: ~np~ non parsed text ~/np~
>
>---
>
>Suggestion: Use 3 tildes instead (~~~). I see HTML leaking in there. :)
>
>  
>
Seems better, rendering of ~~~ in tutorials would be done with special 
characters instead but that's a very minor disadvantage. TikiWiki would 
currently need a bit of hacking for this change when plugins are embedded.

>---
>
>2.16. Tables 
>Tables can be rendered using the double bar separator (||) to mark the
>begining and end of a table, the bar separator (|) to define cells limits
>and carriage line return to define the end of the row. 
>
>Example: 
>|| 
>::Color Name:: | :: Color HEX :: | :: - Colored Text - :: 
>AliceBlue| ::#F0F8FF:: | ~~#F0F8FF:Colored Text~~ 
>AntiqueWhite| ::#FAEBD7:: | ~~#FAEBD7:Colored Text~~ 
>||
>
>---
>
>Suggestion:  Tables can be rendered using the triple bar separator (|||) to
>mark the begining and end of a table, the bar separator (|) to define cells
>limits and double bar (||) to define the end of the row. 
>
>Never rely on /n.
>
>Example: 
>||| 
>::Color Name:: | :: Color HEX :: | :: - Colored Text - :: ||
>AliceBlue| ::#F0F8FF:: | ~~#F0F8FF:Colored Text~~ ||
>AntiqueWhite| ::#FAEBD7:: | ~~#FAEBD7:Colored Text~~ || 
>|||
>
>---
>
>2.17. Images 
>Images can be used in text using a syntax similar to the HTML sysntax but
>using ({) and (}) to enclose the image. 
>
>Example: {src=http://tikiwiki.org/logo.png width=20 height=10 desc=Logo} 
>
>The application MUST check that the image is in fact an image and process it
>accordingly.
>
>---
>
>Suggestion: {src|desc|height|width}
>
>Example: {http://www.phpwiki.org/images/logo.png|Logo}
>Example: {http://www.phpwiki.org/images/logo.png|Logo|10|20}
>
>Simplify, Simplify.
>
>---
>2.18. Special Characters 
>Of course - any of the characters in the ASCII table can be added to a wiki
>page by enclosing it's number within a pair of Tildies. 
>
>Example: ~169~
>
>---
>
>This should be expanded to include Unicode characters. My only suggestion
>could be including ~U:450373~ . I don't have a better way.
>
>---
>
>2.22. Adding Hidden Details in Lists 
>An expandable area allows you to display the major items in your list by
>default. Every item is still there, but it needs to be expanded to become
>visible. An expandable area is created by adding a minus (-) character after
>the star (*) characters. 
>
>Example: 
>*This is a Level 1 item. 
>*This Level 1 item has Hidden Details. Click the Plus [+] to open it. 
>**-This is a Level 2 item. Clicking the Minus [-] will close it. 
>**This Level 2 item did not need the minus character. 
>*Back to Level 1. 
>
>Expandable areas work with Bulleted and Numbered lists. 
>
>---
>
>This can cause some really strange behaviors and puzzled users. ("Where did
>my text go?!!") Possibly require the previous line has a +, such as:
>
>Example: 
>*This is a Level 1 item. 
>*+This Level 1 item has Hidden Details. Click the Plus [+] to open it. 
>**-This is a Level 2 item. Clicking the Minus [-] will close it. 
>**This Level 2 item did not need the minus character. 
>*Back to Level 1. 
>
>Maybe that was an omission?
>
>  
>
I don't really understand the objection, as why is *+ on second line? 
Obviously users can be puzzled a bit at first time. We use it (and also 
for titles) in TikiWiki documentation though, and it's pretty useful.

>---
>
>2.25. HTML 
>Any HTML syntax can be used but MUST not be rendered by default displaying
>HTML as normal text unless the user or administrator authorize the rendering
>of HTML syntax in the application. In that way any application is by default
>exempt of any scripting, embedded object or HTML vulnerability. 
>HTML rendering is discouraged. 
>
>---
>
>PhpWiki requires HTML to be Encapsulated, I suggest it in the RFC as well.
>
>Example: [[<a href=http://www.phpwiki.org>Hi!</a>]]
>
>---
>
>Section 3 XML Schema:
>
>Here the RFC should include the schema for Wiki XML files. Content between
>Wikis should be easily movable and dumps/revisions should have a standard
>schema.
>
>PhpWiki uses 3 different methods for database dumps. Ugly. Hopefully the
>goal will be a dump from phpwiki could be imported with ease to another
>wiki.
>
>I intend to write a schema if none exists but not for a month or two.
>Requires digging into more than one of my XML books. :)
>
>
>Jason Potkanski
>Potkanski System Services
>Orland Park, IL 60462
>
>E-mail: ele...@mg...
>
>
>Comments in this email above this line are under the Creative Commons
>License. Comments below are owned by their respective persons.
>
>
>
>
>
>-----Original Message-----
>From: php...@li...
>[mailto:php...@li...] On Behalf Of Reini Urban
>Sent: Thursday, February 26, 2004 10:44 PM
>To: php...@li...
>Subject: [Phpwiki-talk] Someone is proposing a Wiki RFC with strange syntax
>
>See http://tikiwiki.org/tiki-index.php?page=RFCWiki
>
>hey! want to fix some wiki format conventions, which is based NOT in the 
>Wiki's I used to know: c2, usemod, phpwiki, moinmoin to mention the 
>biggest and oldest ones, though tiki is of course the biggest now in 
>terms of features.
>
>Bold Text 2 Underscores "_" 	__text__
>Centered Text 2 Colons ":" 	::text::
>Colored Text  2 Tildes "~" 	~~blue:text~~
>Italic Text   2 Single Quotes "'"  ''text''
>MonoSpaced Text                 -+text+-
>Underlined Text 3 Equals "=" 	===text===
>
>~~red:This is text is Red~~
>Example: -=~~red:::A Red Centered Title Bar:: ~~ =-
>Example: ^ This is a Box ^.
>Example: ...page...
>
>Example: ((new page))
>Example: NewPage
>Example: ))NotAWikiPage((
>Example: ((New Page|Description of my new page))
>Example: [http://tikiwiki.org/]
>Example: [mailto:so...@so...]
>Example: [http://tikiwiki.org/|The TikiWiki Site]
>
>by some guy from the fiji's.
>  
>
I'm posting this to Tiki devel-list.
A comment on syntax I already received from a Tiki admin was that using 
__ for bold instead of underlining (currently ===) was strange. This 
makes sense to me at first glance. Luis Argerich first implemented that 
syntax, I think it would be interesting to get his comments on those 
changes.

Philippe Cloutier