Editing EditingTips
ChemistryWiki
|
RecentChanges
|
Preferences
== Some Tips on Writing in the Wiki == For the most part, just click on '''Edit text of this page''' at the bottom of the page, type new text into the box, and click the '''Save''' button. Presto! You've just changed a web page. There's a lot you can do to fancy things up, but basic editing is as simple as click, type, and click. To see how a certain page was formatted, use '''Edit text of this page''' just to see how it was done. On this page, you can see that two equal signs on either side of text makes a "headline" and that three single quotes makes '''bold''' text. (BTW: It's OK to just use your browser's back button to leave an edit box unsaved.) Simple editing is one of the major benefits of Wiki. You can edit pages without knowing HTML, but still use many formatting features of HTML. Some HTML "tags", like <nowiki>, <b>, <i>, and <pre></nowiki> are allowed within a page, but there are also non-HTML ways to accomplish the same thing. === Overview === Here's an overview of Wiki text formatting rules you can use. * Basic Text Formatting * Bold and Italic Text * Creating links ** Wiki links ** URL links ** <nowiki>InterWiki</nowiki> links ** Bracketed Links ** Inline images ** ISBN links ** Avoiding auto-links * Making lists ** bullet lists ** numbered lists ** definition lists * indenting block quote texts * Preformatted Text * Miscellaneous rules To try these rules for yourself, please feel free to edit the SandBox page. <i>To see how any page is formatted, just follow the link "Edit text of this page" at the bottom of the page.</i> The "Preview" button on the editing page may also be helpful for finding formatting errors before saving. ---- === Basic Text Formatting: === Here are a few basic rules: * Do not indent paragraphs with spaces. (Indenting may cause your text to appear in a monospaced font.) * Leave a single blank line between paragraphs. * To create a horizontal line, type 4 or more minus/dash/hyphen (-) characters. ---- === Bold and Italic Text: === To mark text as '''bold''' or ''italic'', you just use a bunch of single quotes before and after the text: <pre> ''Two single quotes are italics'', '''three single quotes are bold''', '''''five single quotes are bold and italic.''''' </pre> looks like: ''Two single quotes are italics'', '''three single quotes are bold''', '''''five single quotes are bold and italic.''''' ---- === Wiki links === You can link to a page by removing the spaces between two or more words, and starting each word with a capital letter. For instance, WikiName and TextFormattingExamples are samples of page links. Non-existing pages, like SampleUndefinedPage, will be displayed with a question-mark for a link. The question mark link indicates the page doesn't exist yet -- follow the link to create and edit the page. [The sample page used here is a special example page -- you <i>can't</i> define it.] ---- === URL links === Write the URL: <nowiki>http://www.usemod.com/cgi-bin/mb.pl?SandBox</nowiki> Result: http://www.usemod.com/cgi-bin/mb.pl?SandBox In nearly all cases trailing punctuation is ignored, so you can safely make links like http://www.usemod.com/, without the trailing comma being part of the link. If the URL itself is long and ugly, you could use a bracketed link. ---- === Bracketed Links === Just enclose a URL with square brackets, like this: <nowiki>[http://www.yahoo.com/]</nowiki> Result: [http://www.yahoo.com/] The URL will be replaced with a number. Note that is often considered bad style to replace the name of something (book, author, paper, web site) with the reference in square brackets. ;Example: ''You can read more about this in [1]''. If you can't read it out loud, don't write it. Use the active voice, instead. ;Example: ''If you are interested in Free Software, check the Philosophy section on the GNU site [1].'' '''Bracketed Links with Custom Text''' Just follow the URL inside the square brackets with the text you want to act as the link, like this: <nowiki>[http://www.yahoo.com/ Yahoo Search Engine]</nowiki> Result: [http://www.yahoo.com/ Yahoo Search Engine] ---- === Inline images: === Write the URL to the image: <nowiki>http://www.usemod.com/wiki.gif</nowiki> Result: http://www.usemod.com/wiki.gif ---- === ISBN links === Just write the ISBN Number, like this: <nowiki>ISBN 0-471-25311-1</nowiki> Result: ISBN 0-471-25311-1 ---- === Avoiding links === If you want to avoid linking, enclose the text with nowiki tags, like this: <nowiki><nowiki>InterWiki</nowiki></nowiki> Result: <nowiki>InterWiki</nowiki> You can separate links from adjacent text with spaces or the special "" (two double-quotes) delimiter, like this: <nowiki>UseModWiki""s</nowiki> Result: UseModWiki""s The "" delimiter is <i>not</i> displayed -- it is useful for cases like plural forms of page links (such as UseModWiki""s). ---- === Lists: === '''Simple lists''': <pre> * Text for a bulleted list item. * Text for another bulleted list item. * Text for a third bulleted list item. ** Text for second-level list. *** Text for third level, etc. </pre> ...which looks like: * Text for a bulleted list item. * Text for another bulleted list item. * Text for a third bulleted list item. ** Text for second-level list. *** Text for third level, etc. '''Numbered lists''': <pre> # Text for a numbered list item. # Text for another numbered list item. # Text for a third numbered list item. ## Text for second-level list. ### Text for third level, etc. </pre> ...which looks like: # Text for a numbered list item. # Text for another numbered list item. # Text for a third numbered list item. ## Text for second-level list. ### Text for third level, etc. '''Definition lists''' Terms with indented definitions: [without a blank line between term and definition] <pre> ;Term One:Definition for One (indented) ;Term Two:Definition for Two (indented) ;Term Three:Definition for Three (indented) ;;Term (indented):Definition (indented two levels) ;;;Term (indented twice):Definition (indented to third level) </pre> ...which looks like: ;Term One:Definition for One (indented) ;Term Two:Definition for Two (indented) ;Term Three:Definition for Three (indented) ;;Term (indented):Definition (indented two levels) ;;;Term (indented twice):Definition (indented to third level) ---- === Indented Text: === Simple indented text: <pre> : Paragraph to be indented (quote-block) :: Paragraph indented more ::: Paragraph indented to third level </pre> ...which looks like: : Paragraph to be indented (quote-block) :: Paragraph indented more ::: Paragraph indented to third level ---- === Preformatted Text === Individual lines can be displayed as preformatted (fixed-width or "typewriter"-font) text by placing one or more spaces at the start of the line. Other Wiki formatting (like links) will be applied to this kind of preformatted text. <nowiki>Alternatively, multi-line sections can be marked as pre-formatted text with all other formatting suppressed by surrounding the text section with lines starting with <pre> (to start pre-formatted text), and </pre> (to end preformatted text). The <pre> and </pre> tags are not displayed. Wiki links and other formatting is not done within a <pre> formatted section. (If you want wiki formatting, use spaces at the start of the line instead of the <pre> and </pre> tags.)</nowiki> For instance: <pre> Pre-formatted section here. No other link or format processing is done on pre-formatted sections. For instance, PalmGrantWiki is not a link here, and '''this is not bold'''. </pre> and: This is the starting-spaces version of preformatted text. Note that links like PalmGrantWiki still work. ---- === Miscellaneous rules: === * A line which ends in a backslash character (\) will be joined with the next line before most formatting rules are applied. This can be useful for breaking up long sections of text in line-sensitive sections (like lists or indented text). * Most of the formatting rules are order-independent. On rare occasions the order of processing may be important.
View other revisions
ChemistryWiki
|
RecentChanges
|
Preferences