User Documenta... > Topic

Wiki Syntax / #3651

New topicBookmark

Headings

There are two levels of headings:
== Top Level ==

=== Second Level ===

or

Top Level
=========  <-  3 or more '=' characters

Second Level
------------   <- 3 or more '-' charaters

List

# Numbered
# Numbered
  1. Numbered
  2. Numbered


1. First line
2. Second line
  - Sub

inbetween

5. Forth line
  1. First line
  2. Second line
    • Sub
inbetween
  1. Forth line
The lines must not be indented to start a list. The indention level is not limited. There has to be exactly one whitespace between "-" and the first word. Precise numbers are used even if out of order (you could number a list backward).


Code Blocks

[ code from="index.php"]
some more code
[ /code]

NOTE: Actually the blank before code and /code must be removed - but we have some trouble with code blocks inside of code blocks ;-(

from index.php

some more code

All utf8 chars (including all sorts of quotes or html-chars) are allowed.
NOTE: As with version v0.08 the indented code blocks have been depreciated.

Links

By Naming

[[item:3651|more about wiki syntax]]
[[link to new page page]]

more about wiki syntax
link to new page page

Clarifying the meaning

[[wiki syntax|more about wiki syntax]]

more about wiki syntax

Via Item-Id

[[item:234]]
or
#234

Grouped lists

External

Lines starting with http:// will create a clickable external link:

www.pixtur.de

E-Mail

Text starting with mailto: generates a link to your Mail-Editor:

Send to mailto:thomas@pixtur.de

Send to thomas@pixtur.de

Images

Simple

[[image:234]]

Advanced syntax

[[image:234|?options?|?description?]]

Whereas ?options? could be a comma separated combination of the following:
  • left - float left
  • right - float right
  • framed - display with description as subtitle. Use image-description, if no description is given within link
  • maxsize=234 - will use gd2 to scale this down to 234 pixels if too large.
e.g.:

[[image:234|maxsize=320,framed,right]]


Tables

|Header |Header |
|Cell |Cell |

Header Header
Cell Cell
The first line is always treated as table header. There must not be any characters before or after the pipes. Links and other formatting can be used inside cells.

More formating

''emphasize'' # two quotes
`monospace / code` # back quotes
*bold text*
V[sub]speed[/sub]
~~striked~~

emphasize
monospace / code
bold text
Vspeed
striked

Horizontal Line

______ <- 3 or more '_' (underscore) characters




Quotes

  [quote from="Mark Twain" url="http://www.twain.com"]
  Something
  [/quote]

Something

from Mark Twain



Note: The "from=" and "url=" statements are optional.

47 Comments

guest

Jan 9, 2007
what about strike through?
is there a possibility to get strike throuhg (e.g. < u>test< /u>

pixtur

Jan 9, 2007
Reply to what about strike through?
already requested in: I just implemented this in rev249

nraspail

Jun 29, 2007
Reply to Reply to what about strike through?
Hi,

if I use ~~bla bla /etc/syconfig/blabla~~, it doesn't work. Is it possible to change this behaviour ?

Thanks

binder

Jan 12, 2007
linking of "wiki-syntax"
problem "WikiSyntax!" does not lead to the correct item! ;)
please add 3651, as this is the correct item-id.

pixtur

Jan 13, 2007
Reply to linking of "wiki-syntax"
very good hint :) This was a typo in the rating of search results. It cause the shortname to be ignored... But adding the item id is a much better solution, though.



guest

Jan 20, 2007
FCKeditor?
streber is such a great application, I love the flow, organization and functionality. I work at a very large telecom company - wish they had something this nice.

Anyway, I'm new to the whole Wiki thing. Maybe this is blasphemy - but what about adding a WYSIWYG editor like FCKeditor to task creation, comments etc.?

Or is Wiki that much more efficient? (For instance I know coders love VI but being a mere mortal I always have to have my icons and menus)

Thanks for the great tool!

pixtur

Jan 20, 2007
Reply to FCKeditor?
Thanks for you feedback!

I love FCKeditor and spent some time thinking about the pros and cons for a WYSIWYG editor. But at this end my person opinion boils down like this:


In many many cases Formatting is bad. Although there are some areas where complex formating like tables is mandatory in most cases caring about the format will get you distracted from what you want to write.

Nevertheless I would love to have an editor like FKCE boiled down to allowed wiki syntax, which is converted back to normal wiki text, because:
  1. wikitexts can nicely be stored and compared (important for comparing versions)
  2. wikitexts can easily be formated / style differently.
  3. you can very easily sent wiki text with email (without requiring Word or PDF)
So I guess until this editor is available, we are struck with the current state of affairs...

guest

Jan 26, 2007
Quick icons then?
Why not just create a simple icon bar at the top which just inserts the required start and stop characters for the wiki format items?

This way users who refuse to learn the syntax or use it infrequently can still utilize the text entry with its full potential.

Also, it might be cool to have a preview button for these people also while they are learning. This could be a simple compromise before an editor shows up with wiki-ascii formatting.

guest

Jan 26, 2007
maxsize seems not to work
In at least 0.078...

guest

Mar 7, 2007
Quotes
One line quotes can't be read due to the scrollbars. Any way the box can be made bigger?

pixtur

Mar 7, 2007
version 3
Antwort auf Quotes
I created a ticket: One line quotes can not be read due to the scrollbars. Please provide additional information there.


guest

Mar 13, 2007
Preview button
It would be very nice to have a "Preview" button beside the "Submit" button to show me what I'm about to submit, without having to submit it, edit it, submit it, edit it, etc.

guest

May 2, 2007
Link to sub page
Is there a way to address a sub page in a link.

For example:

To have a link to the Documetnation sub page of a project I provide the full URL:

myserver/streber/index.php?go=projViewDocu&prj=94

But would be more wiki like to provide it like this:

taskEdit>checkbox add another task?projViewDocu


(or the like).



eh

May 2, 2007
Better formatting
Ooops, see rigth now that my text above isnt' very readable. so here it comes again:

For example:

To have a link to the Documetnation sub page of a project I provide the full URL:

http://myserver/streber/index.php?go=projViewDocu&prj=94

But would be more wiki like to provide it like this:

#94?projViewDocu

(or the like).

PS:
Preview could really be something good.


pixtur

May 2, 2007
reply
Yeah. Preview would be really nice. Especially since it could be ajax driven... But this will come in a later version.

I don't really see, why you would want to address projViewDocu at all (the display of documentation topics as task was a bug which has been fixed).

Addressing chapters (e.g. Headlines) would be a cool think, but I have not really good idea, how to do this. I could insert some anchors at the headlines, but links to them would become invalid when changing the headline.

Addressing pages like (projView, taskView, taskViewEfforts, etc) would probably be a nice think, but I am affraid it's too seldom used to be implemented.

We urgently need a syntax to replace an URL with a readable title. Possibilities:
  1. mediaWiki Links enclosed with single square brackets. Optional title after space. 
[http://www.streber-pm.org streber]
  1. simple syntax (works not inside tables) 
http://www.streber-pm.org|streber
  1. complex syntax (fits best into current syntax) 
[[link:http://www.streber-pm.org|streber]]



eh

May 2, 2007
View comment
We gather documentation for a project and organize it in folders. From time to time I want to give a hint in a task that there's documentation available and want provide the link to the doc overview (and not to a particular doc page), for example for the streber project it would be:

www.streber-pm.org/index.php?go=projViewDocu&prj=5

Actually I can live with the full URL, but it gets broken in case our streber installation gets moved to another server. And since there's no such thing like a "global replace" some manual work would be needed.



pixtur

May 2, 2007
version 3
very good argument...
We could add it like...
[[item:123|Optional name|function=taskViewEfforts] ]

eh

May 3, 2007
very good suggestion!

guest

Jun 18, 2007
How can I mark part of code?
Hi, can you help me, how can I mark part of code, I mean color mark.
And not one or three words. I need mark big text part.
Can I do it?

pixtur

Aug 9, 2007
Antwort auf How can I mark part of code?
You can turn on "Starlight" but this will have some drawbacks.

guest

Jul 2, 2007
Quick link to uploaded file
I got a file at index.php?go=fileDownload&file=98

using "# 98" does not work, any alternatives ?

guest

Jul 2, 2007
View comment
ignore Cannot link to item of type 7, I found the way

guest

Jul 18, 2007
tseting

Top level

Second level

guest

Jul 18, 2007
code testing
[ code from="test.cs"]
for(int i=1;i <100;i++)
{
   console.writeline("this is testing" + i.ToString());
}
[ /code]

guest

Jul 19, 2007
View comment
S.no Name
1 Ram
2 Shyam

guest

Aug 20, 2007
Original text
Hi, can I have the original text (wiki format) of this (Wiki Syntax) content? I'd like to install it locally. I could have just copy and paste whatever seen/rendered by browser that would be rather ugly. Thanks.

guest

Sep 1, 2007
how embed external images?
I want to put external images but i can't.
This could be easy I think but I can't find the formater script wich php file do it?.

Suggested sintax coudl be:

image:url=www.google.com/logo.gif

guest

Sep 28, 2007
test

test

  1. test number list1
  2. test number list2

guest

Nov 8, 2007
What about relative links?
Hi,

Just discovering this fantastic tool. I have however a suggestion: why not support relative links? Today you can link to external pages using http://xxx.xxx.com but it's not possible to create relative links to pages on the same server (something like ../../Doc/mypage.html). This would be very useful when you have several sites on the same server and the location of this server changes: you don't want to have to replace all absolute urls in the pages.

guest

Nov 29, 2007
test
[red]test[/red]

guest

Jan 15, 2008
how about the code?
If I have some code, for example, php, html or css in the documents, the parser will convert them. If there is a way the keep the style of the code?

guest

Jan 30, 2008
Naming Links
Here is how you can give your URL a specific name:
[[http://www.streber-pm.org|streberPM]]
streberPM

guest

Jan 31, 2008
View comment
[color=red]TEST[/color]

guest

Apr 23, 2008
How to link strange url?
I must link this url:
http://mydomain.com/index.html?test=1&asd=*&lol=1234
Ex:
Normal: mydomain.com/index.html?test=1&asd=*&lol=1234
Linked Linked

How I can do it?


guest

Apr 28, 2008
View comment
ghjghjg

guest

Apr 28, 2008
View comment
dfgdhgfd

cody-somerville

May 5, 2008
View comment
test[n]test

cody-somerville

May 5, 2008
test
test[nr]testtest

cody-somerville

May 5, 2008
View comment
test

test
test
test

test


test

cody-somerville

May 5, 2008
View comment
test
test
|test|test
|test|
test|
|test | test|

|test
|test| test
test|test

|test
|test | test
test | test |

cody-somerville

May 5, 2008
View comment
|test |test |
|1
|3 4|

guest

Jun 20, 2008
Syntax for external links
Hello out there:

I'm currently using this syntax for external links:

[CODE]
STREBER
[/CODE]

Is it possible that by clicking on that link it opens the referenced page in new window and display it there???

webbplatsen

Jul 15, 2008
Reply to Syntax for external links
Yes,

http:// links should open a new window like target="blank".
If you use 
#12345
it should be just like today.

guest

Jun 20, 2008
gb5256

guest

Jun 20, 2008
Syntax for external links - again
What about opening all external links on new pages and internal links on the same?
From my point of view that makes perfect sense.

What do you guys think?

gb5256

dekamerone

Jul 9, 2008
Wiki Syntax compatibility?
I'm just looking for a possibility to automatically convert OpenOffice Dokuments to the Wiki-Syntax of Streber.

Maybe there is a OpenOffice macro for other Wiki-Systems usable or could be taken as easy customizable template?

thx and happy projects : Michael

guest

Jul 30, 2008
Reply to Syntax for external links HEY WEBPLATSEN !
Thanks for your reply about external links.
But I do not know what you mean.
My external links do all start with HTTP:// and they all open in the currently open window/tab and not in a new window/tab.
I tested on Firefox and Safari (both MAC).

Furthermore I do not understand your "Item #12345?".

Sorry, I seem to be too dumb for this...

Any help really appreciated.
gb5256


 
 

Comment / Update