X-Git-Url: https://codewiz.org/gitweb?p=wiki.git;a=blobdiff_plain;f=EditingTips;h=7847d78530c58a9a564aa9b7ff6b1c4a91ffb4cf;hp=563f12a66e4ae42a332a8169f4b08e34970c2b9d;hb=baeb370da99334d99655b129e6e2f7998dea29ce;hpb=f34ae4838e95e20660751593e18073525b67db47 diff --git a/EditingTips b/EditingTips index 563f12a..7847d78 100644 --- a/EditingTips +++ b/EditingTips @@ -1,43 +1,67 @@ +Click **Raw Text** to see the markup for this page, and try it yourself in WikiSandBox. + +--- + +Our wiki syntax is deliberately similar to MoinMoin and WikiCreole. + Note: You should use formatting sparingly, WikiWikiWeb is about content, not look. +See WikiDesignPrinciples. -Click '''Raw''''''Text''' in the header to see the markup for this page, and try it yourself in WikiSandBox. +== Links == -==Text Styles== +You can Link to URLs by enclosing them in double square brackets: [[http://www.codewiz.org/]], +or you can make descriptive links with [[http://www.codewiz.org/ | some anchor text]]. -You can also write ''italics'' and '''bold'''. -To write italics, enclose the text in double single quotes. -To write bold, enclose the text in triple single quotes. +Anchored links also work with [[FrontPage|wiki pages]], [[/index.html | local paths]], and [[non_wiki_words]]. -Leave blank lines between paragraphs. +If you link to a directory, GeekiGeeki will automatically generate an index for it: [[sys/macros]] + +Image links: [[http://www.laptopgiving.org/|GiveOneGetOne.jpg]] + +== Inline media == +==== Images ==== +{{GerryStich.jpg}} -==Links== +==== Images with thumbnails ==== +{{GerryStich.jpg|Stich!}} -Names of pages have to LookLikeThis. -It's called a WikiName. -If you write a word that LooksLikeThis, it will be automatically turned into a link. +==== Scaled images ==== +{{GerryStich.jpg|tiny|maxwidth=48}} -You can use URLs directly: http://www.codewiz.org/ , or you can make descriptive links with [[http://www.codewiz.org/ some anchor text]]. Links to images will appear inline: http://www.w3.org/Icons/valid-css.png +==== Including other wiki pages ==== -Anchored links also work with [[FrontPage wiki pages]] -and [[/index.html local paths]]. +Use the same syntax to embed wiki pages inside other wiki pages: + {{IncludedPage}} -==Block elements== +You can also pass arguments to included pages! It works like a simple template system: + + {{TemplatePage | hello=Ciao | world=mondo}} + + +==== Including external resources inline ==== +{{http://www.codewiz.org/wikigit/geekigeeki.git/blob_plain/HEAD:/geekigeeki.py}} + +== Macros == + + * Your remote IP: <> + * Query string: <> + * <> + +== Block elements == + +Leave blank lines between paragraphs. + +You can insert line\\ +breaks\\ +with double backslashes: \****\. If you indent text like this, then it is indented in the output you can have multiple levels of indent -And if you put asterisks at the start of the line - - * you get a - * bulleted - * list - * which can also be indented - * to several levels - To insert program source without reformatting in a monospace font, use three curly braces: {{{ @@ -48,28 +72,88 @@ To insert program source without reformatting in a monospace font, use three cur Just like that. -==Rulers== +== Itemized lists == + +If you put asterisks (*) at the start of the line + + * you get a + * bulleted + * list + * which can also be indented + * to several levels + +You can also have numbered lists, using the number (#) sign: + # first item + # second item + # first indented item + # second indented item + # third item + +== Text Styles == + +To write **bold text**, enclose it in double stars: *////*some word*////*. \\ +To write //italic text//, enclose it in double slashes: /****/some word/****/. \\ +To write ##monospace text##, enclose it in double hashes: #****#some word#****#. \\ +To write __underlined text__, enclose it in double underscores: _****_some word_****_. \\ +To write ^^superscript text^^, enclose it in double carets: ^****^some word^****^. \\ +To write ,,subscript text,,, enclose it in double commas: ,****,some word,****,. \\ +''Double'' and '''triple''' quotes are also supported for compatiblity with other wikis. \\ +These keywords are highlighted: FIXME, TODO, DONE. + +TIP: four consecutive stars (*////*////*////*) or slashes (/****/****/****/****) are a good +way to escape the syntax. :-) + + +== Rulers == --- ---- ----- ------ -==Headings== + +== Headings == ===Level 2=== ====Level 3==== =====Level 4===== ======Level 5====== + == Tables == -|| Table cell 1 || Table cell 2 || Table cell 3 || -|| Table cell 4 || Table cell 5 || Table cell 6 || -|| Table cell 7 || Table cell 8 || Table cell 9 || +||= Table Heading 1 ||= Table heading 2 ||= Table heading 3|| +|| Table cell 4 || Table cell 5 || Table cell 6 || +|| Table cell 7 || Table cell 8 || Table cell 9 || + + +== Inline HTML == -TODO: support table headers +
+You can use ##div##, ##span## and ##iframe## elements with any attribute, including +CSS, of course. +
-==Final Notes== +== Pragmas == + +Wiki pages can specify special-purpose commands in their header. In the form: + +{{{ +# <keyword> <values> +}}} + +=== Access Control Lists === + +{{{ +# acl SomeUser:read,write OtherUser:read All:none +}}} + +Limit read or write access to specific authenticated users + +=== Custom cascading style sheets === + +{{{ +# css my_style.css +}}} -Be aware that PikiPiki does not lock pages during editing, so if you pause for a long time on the edit screen you may overwrite somebody else's changes. +Include a user-specified custom CSS before the default one(s).