From c0c757e5789fa8cdb1231b4aa89e581aa4ec4148 Mon Sep 17 00:00:00 2001 From: PeterThoeny Date: Fri, 18 Aug 2000 09:08:04 +0000 Subject: [PATCH] none --- TWiki/GoodStyle.mdwn | 19 ++++++ TWiki/PeterThoeny.mdwn | 0 TWiki/RegularExpression.mdwn | 141 +++++++++++++++++++++++++++++++++++++++++++ TWiki/TWikiTutorial.mdwn | 71 ++++++++++++++++++++++ 4 files changed, 231 insertions(+) create mode 100644 TWiki/GoodStyle.mdwn create mode 100644 TWiki/PeterThoeny.mdwn create mode 100644 TWiki/RegularExpression.mdwn create mode 100644 TWiki/TWikiTutorial.mdwn diff --git a/TWiki/GoodStyle.mdwn b/TWiki/GoodStyle.mdwn new file mode 100644 index 0000000..e90866d --- /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 `` . + +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. + +-- [[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. + +-- [[TWikiGuest]] - 27 May 2000 diff --git a/TWiki/PeterThoeny.mdwn b/TWiki/PeterThoeny.mdwn new file mode 100644 index 0000000..e69de29 diff --git a/TWiki/RegularExpression.mdwn b/TWiki/RegularExpression.mdwn new file mode 100644 index 0000000..5d50aec --- /dev/null +++ b/TWiki/RegularExpression.mdwn @@ -0,0 +1,141 @@ +Regular expressions allow more specific queries then a simple query. + +**Examples** + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
compan(y|ies) Search for company , companies
(peter|paul) Search for peter , paul
bug* Search for bug , bugs , bugfix
[Bb]ag Search for Bag , bag
b[aiueo]g Second letter is a vowel. Matches bag , bug , big
b.g Second letter is any letter. Matches also b&g
[a-zA-Z] Matches any one letter (not a number and a symbol)
[^0-9a-zA-Z] Matches any symbol (not a number or a letter)
[A-Z][A-Z]* Matches one or more uppercase letters
[0-9][0-9][0-9]-[0-9][0-9]-
[0-9][0-9][0-9][0-9] 		US social security number, e.g. 123-45-6789
+ +Here is stuff for our UNIX freaks:
(copied from 'man grep') + + \c A backslash (\) followed by any special character is a + one-character regular expression that matches the spe- + cial character itself. The special characters are: + + + `.', `*', `[', and `\' (period, asterisk, + left square bracket, and backslash, respec- + tively), which are always special, except + when they appear within square brackets ([]). + + + `^' (caret or circumflex), which is special + at the beginning of an entire regular expres- + sion, or when it immediately follows the left + of a pair of square brackets ([]). + + + $ (currency symbol), which is special at the + end of an entire regular expression. + + . A `.' (period) is a one-character regular expression + that matches any character except NEWLINE. + + [string] + A non-empty string of characters enclosed in square + brackets is a one-character regular expression that + matches any one character in that string. If, however, + the first character of the string is a `^' (a circum- + flex or caret), the one-character regular expression + matches any character except NEWLINE and the remaining + characters in the string. The `^' has this special + meaning only if it occurs first in the string. The `-' + (minus) may be used to indicate a range of consecutive + ASCII characters; for example, [0-9] is equivalent to + [0123456789]. The `-' loses this special meaning if it + occurs first (after an initial `^', if any) or last in + the string. The `]' (right square bracket) does not + terminate such a string when it is the first character + within it (after an initial `^', if any); that is, + []a-f] matches either `]' (a right square bracket ) or + one of the letters a through f inclusive. The four + characters `.', `*', `[', and `\' stand for themselves + within such a string of characters. + + The following rules may be used to construct regular expres- + sions: + + * A one-character regular expression followed by `*' (an + asterisk) is a regular expression that matches zero or + more occurrences of the one-character regular expres- + sion. If there is any choice, the longest leftmost + string that permits a match is chosen. + + ^ A circumflex or caret (^) at the beginning of an entire + regular expression constrains that regular expression + to match an initial segment of a line. + + $ A currency symbol ($) at the end of an entire regular + expression constrains that regular expression to match + a final segment of a line. + + * A regular expression (not just a one- + character regular expression) followed by `*' + (an asterisk) is a regular expression that + matches zero or more occurrences of the one- + character regular expression. If there is + any choice, the longest leftmost string that + permits a match is chosen. + + + A regular expression followed by `+' (a plus + sign) is a regular expression that matches + one or more occurrences of the one-character + regular expression. If there is any choice, + the longest leftmost string that permits a + match is chosen. + + ? A regular expression followed by `?' (a ques- + tion mark) is a regular expression that + matches zero or one occurrences of the one- + character regular expression. If there is + any choice, the longest leftmost string that + permits a match is chosen. + + | Alternation: two regular expressions + separated by `|' or NEWLINE match either a + match for the first or a match for the + second. + + () A regular expression enclosed in parentheses + matches a match for the regular expression. + + The order of precedence of operators at the same parenthesis + level is `[ ]' (character classes), then `*' `+' `?' + (closures),then concatenation, then `|' (alternation)and + NEWLINE. diff --git a/TWiki/TWikiTutorial.mdwn b/TWiki/TWikiTutorial.mdwn new file mode 100644 index 0000000..5d1f297 --- /dev/null +++ b/TWiki/TWikiTutorial.mdwn @@ -0,0 +1,71 @@ +This is a short, step-by-step tutorial to get you up to speed on %WIKITOOLNAME%. + +- Preparation: + - Open up a new browser window. While you are working in one window, you can look at the step-by-step tutorial instructions in the other window. + +- Navigation and search: + - %WIKITOOLNAME% is divided up into webs; each one represents one area of collaboration. The webs are accessible at the upper right corner of each web page. + - Each web has hyper-linked topics. A topic is one web page in your browser. + - The home page in each web is the [[WebHome]] topic. + - To browse a %WIKITOOLNAME% web, just click on any highlighted link. These links are called [[WikiWords]] and comprise two or more words with initial capitals, run together. + - Follow the [[WikiWord]] link and learn what it is. + - If you know the name of a topic, you can jump directly to it by typing its name into the **Go** field on the top of the page. Type `WebSearch` to jump to the search page. **_Hint:_** Do not confuse the **Go** field with search. + - You can search each %WIKITOOLNAME% web. Enter a search string in the [[WebHome]] topic or the [[WebSearch]] topic accessible from the `Search` link on each topic. %WIKITOOLNAME% searches for an exact match; optionally, you can also use [[RegularExpressions]]. **_Note:_** A search only looks in the current web unless you use the advanced search option. + +- Create your account: + - To edit topics, you need to have a %WIKITOOLNAME% account. + - Go to the [[TWikiRegistration]] page to create your TWiki account. + +- %WIKITOOLNAME% Users and offices: + - Go to the [[TWikiUsers]] topic in the %WIKITOOLNAME%.Main web; it has a list of all users of %WIKITOOLNAME%. Your [[WikiName]] will be in this list after you register. + - Go to the [[OfficeLocations]] topic in the %WIKITOOLNAME%.Main web; it has a list of corporate offices already entered into %WIKITOOLNAME%. + +- Operations on topics: + - Go the the [[WebHome]] topic to learn what we can do with a topic. + - The bottom of the page has some links: + - `Edit` : Allows you to edit the topic (discussed later) + - `Ref-By` : Find out what other topics link to this topic (reverse link) + - `Attach` : Attach files to a topic (discussed later) + - `Diffs` : Topics are under revision control. Diffs shows you the complete change history of the topic, e.g. who changed what and when. + - `r1.3 | > | r1.2 | > | r1.1` : Allows you to see a previous topic revision or the difference between revisions. + +- Editing a topic and creating hyperlinked pages: + - Go the the [[Test|Test/WebHome]] topic of the %WIKITOOLNAME%.Test web. This web is the sandbox where you can make changes at will. + - Press the `Edit` link. You are now in edit mode and you can see the source of the page. (Go to a different topic like [[TestTopic3]] in case you see a "Topic is locked by an other user" warning.) + - Look at the text in edit mode and compare it with the rendered page (move back and forth in your browser.) + - Notice how [[WikiWords]] are linked automatically; there is no link if you look at the text in edit mode. + - Now let's create a new topic, your own sandbox topic: + - In edit mode, enter a new text with a [[WikiWord]], i.e.
`This is PaulsSandBox topic.` + - Preview and save the topic. + - You can see a linked question mark after the topic name. This means that the topic does not exist yet. + - Click on the question mark. Now you are in edit mode of the new topic. + - Type some text, basically like you write an email. + - A signature with your name is already entered by default. **_Note:_** Please note the `Main.` in front of your name. This means that you have a link from the current web to your personal topic located in the Main web. + - Preview and save the topic. + - Learn about text formatting: + - You write text in [[WikiSyntax]], a very simple markup language. Follow the [[WikiSyntax]] link and learn how to write text. + - Go back to your sandbox topic end edit it. + - Enter some text in [[WikiSyntax]]: **bold** text, _italic_ text, **_bold italic_** text, a bullet list, tables, paragraphs, e.t.c. **_Hint:_** If you need to look up the [[WikiSyntax]], click on the [[TextFormattingRules]] link located below the edit field. + - Preview and save the topic. + +- Attaching files to a topic: + - You can attach any file to a topic, not unlike attachments to an email. + - Go back to your sandbox topic and click on the `Attach` link at the bottom. + - Browse for any file you would like to attach; enter an optional comment. + - Upload and attach the file. + - Do this again with a JPG or GIF image file. + - Checkmark the box "Create a link to the attached file at the end of the topic." + - Upload and attach the image file. + - The image will show up at the bottom of the topic. To move the image, you can edit the topic and move the last line ( starting with `