summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Thoeny <web-hurd@gnu.org>2000-08-18 08:42:11 +0000
committerPeter Thoeny <web-hurd@gnu.org>2000-08-18 08:42:11 +0000
commit624ab34a114e47b840d227e77ed601dedcacb4e6 (patch)
treef112dccad8931385663093b5a06ad6e18f16415e
parent06df27935cdffb8c62bf9dad9ec6bb4d1307f51e (diff)
none
-rw-r--r--TWiki/GoodStyle.mdwn19
1 files changed, 19 insertions, 0 deletions
diff --git a/TWiki/GoodStyle.mdwn b/TWiki/GoodStyle.mdwn
new file mode 100644
index 00000000..25e04f08
--- /dev/null
+++ b/TWiki/GoodStyle.mdwn
@@ -0,0 +1,19 @@
+TWiki has very simple [[TextFormattingRules]]. You won't go wrong if you start each line without spaces and separate paragraphs with a blank line. Run capitalized words together to make [[WikiWords]], which become hyperlinks. This sometimes requires creativity; you're up to it. [[WikiWords]] tells you how to create good topic names.
+
+If a discussion is going on on a [[WikiTopic]], separate each follow up with a separator. It is style to add your [[WikiName]] and date at the end.
+
+A good format for a new topic is "dissertation followed by discussion": a factual introduction followed by opinions. After a while, the discussion will die down and the page will become static. At that point, feel free to "refactor mercilessly" to capture the key points whilst reducing the noise; this is how wiki content matures with time.
+
+If you summarise an old discussion and merge or delete individual contributions, you can add the word "Contributors:" to the bottom of the page, and list the contributors there.
+
+If you want to link to external sites: Just type hyperlinks directly into the text - that makes it clear to readers whether they're browsing within %WIKITOOLNAME% or leaving it. It is usually better **not** to use the HTML tag `<A HREF="...">` .
+
+Date format: %WIKITOOLNAME% is international, so the ISO date format like "06 Feb 1998" is preferred to one like "2/6/98", which can mean either February or June to different readers. For the month use Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov or Dec.
+
+-- [[Main/PeterThoeny]] - 30 Jul 2000
+
+----
+
+Feel free to look at the source to an existing page if you want to see how something is formatted. A bit of HTML experience can't hurt, but is far from necessary.
+
+-- [[Main/TWikiGuest]] - 27 May 2000