Line 1: |
Line 1: |
− | For a quick overview of wiki markup see the [[Help:Wiki quickie|Wiki Quickie]]! | + | <noinclude>[[Category:General public]] |
| + | [[Category:HowTo]] |
| + | </noinclude> |
| + | For a quick overview of wiki markup see the [[Wiki Team/Guide/Overview]]! |
| | | |
| Text will show up just as you type it (provided you begin it in the first column). Multiple spaces are compressed, and line endings are ignored (except blank lines). | | Text will show up just as you type it (provided you begin it in the first column). Multiple spaces are compressed, and line endings are ignored (except blank lines). |
Line 11: |
Line 14: |
| Use these to change fonts: | | Use these to change fonts: |
| <center> | | <center> |
− | {| {{Prettytable}} | + | {| |
| |- | | |- |
| |bgcolor="#A7C1F2"|'''Description''' | | |bgcolor="#A7C1F2"|'''Description''' |
Line 42: |
Line 45: |
| It is often useful to divide articles into sections and subsections. The following markup can be used. You must begin these on a new line. | | It is often useful to divide articles into sections and subsections. The following markup can be used. You must begin these on a new line. |
| <center> | | <center> |
− | {| {{Prettytable}} | + | {| |
| |- | | |- |
| |bgcolor="#A7C1F2"|'''Heading''' | | |bgcolor="#A7C1F2"|'''Heading''' |
Line 79: |
Line 82: |
| Wiki markup makes lists fairly easy: | | Wiki markup makes lists fairly easy: |
| <center> | | <center> |
− | {| {{Prettytable}} | + | {| |
| |- | | |- |
| |bgcolor="#A7C1F2"|'''List type''' | | |bgcolor="#A7C1F2"|'''List type''' |
Line 136: |
Line 139: |
| |} | | |} |
| </center> | | </center> |
| + | * See also [[Template:Definition table]] |
| * HTML lists are also allowed | | * HTML lists are also allowed |
| * Blank lines should be avoided, they break list numbering and sub-list. Use <nowiki><br></nowiki> instead. | | * Blank lines should be avoided, they break list numbering and sub-list. Use <nowiki><br></nowiki> instead. |
| | | |
| + | == Linking == |
| + | Linking is covered in a separate page: [[Wiki Team/Guide/Links]] |
| + | |
| + | == Preformatted text== |
| + | |
| + | Text which does not begin in the first column of the wiki editing box will be shown indented, in a fixed width font. |
| + | For example, this line was preceded by a single space. It preserves whitespace formatting: A B C D E F G H I |
| + | |
| + | A single paragraph of text can be entered with a space in column 1 (the first character position in the wiki editing box) of every line to preserve the raw text format of the entry. |
| + | For example, this block of lines was |
| + | entered with 4 spaces before each line. |
| + | A B C D E F G H I |
| | | |
− | == Linking == | + | The parser tags {{Code|<nowiki><pre> and </pre></nowiki>}} may be entered before and after blocks of preformatted text to preserve the raw format of the text. This is suitable for chat transcripts such as [[Design_Team/Meetings/2009-03-01]]. |
− | Linking is covered in a separate page: [[Help:Links]]
| + | === Line wrapping === |
| + | Line wrapping can be adjusted with the style property '''white-space''' (See http://www.w3schools.com/cssref/pr_text_white-space.asp) |
| + | * With this tag and style, {{Code|<nowiki><pre style="white-space:pre-wrap"></nowiki>}}, whitespace is preserved by the browser. Text will wrap when necessary, and on line breaks. |
| | | |
− | == Code Examples == | + | === Code Examples === |
− | Text which does not begin in the first column will be shown indented, in a fixed width font. This is appropriate for showing computer code or command examples, such as this famous little program:
| + | Raw text is appropriate for showing computer code or command examples, such as this famous little program: |
| | | |
| main(){ | | main(){ |
Line 150: |
Line 168: |
| } | | } |
| | | |
| + | * Coding format may be embedded in a line of regular text with the <nowiki><code></nowiki><code>code text</code><nowiki></code></nowiki> wiki syntax. |
| + | |
| + | * Blocks of pre-existing code (often with structured linebreaks) may be preserved by entering a space before <code> <nowiki><nowiki></nowiki></code> in the first wiki page column as in this example: |
| + | <nowiki><nowiki>class DatastoreResultSet(BaseResultSet): |
| + | """Encapsulates the result of a query on the datastore |
| + | """ |
| + | def __init__(self, query, page_size): |
| + | |
| + | if query.get('query', '') and not query['query'].startswith('"'): |
| + | query_text = '' |
| + | words = query['query'].split(' ') |
| + | for word in words: |
| + | if word: |
| + | if query_text: |
| + | query_text += ' ' |
| + | query_text += word + '*' |
| + | |
| + | query['query'] = query_text |
| + | |
| + | BaseResultSet.__init__(self, query, page_size) |
| + | |
| + | def find(self, query): |
| + | entries, total_count = _get_datastore().find(query, PROPERTIES, |
| + | byte_arrays=True) |
| + | |
| + | for entry in entries: |
| + | entry['mountpoint'] = '/' |
| + | |
| + | return entries, total_count</nowiki></nowiki> |
| + | The result looks like the following: |
| + | <nowiki>class DatastoreResultSet(BaseResultSet): |
| + | """Encapsulates the result of a query on the datastore |
| + | """ |
| + | def __init__(self, query, page_size): |
| + | |
| + | if query.get('query', '') and not query['query'].startswith('"'): |
| + | query_text = '' |
| + | words = query['query'].split(' ') |
| + | for word in words: |
| + | if word: |
| + | if query_text: |
| + | query_text += ' ' |
| + | query_text += word + '*' |
| + | |
| + | query['query'] = query_text |
| + | |
| + | BaseResultSet.__init__(self, query, page_size) |
| | | |
| + | def find(self, query): |
| + | entries, total_count = _get_datastore().find(query, PROPERTIES, |
| + | byte_arrays=True) |
| + | |
| + | for entry in entries: |
| + | entry['mountpoint'] = '/' |
| + | |
| + | return entries, total_count</nowiki> |
| + | == Stopping Text flow == |
| + | See [[mediawikiwiki:Help:Images#Stopping_the_text_flow]]. |
| == Tables == | | == Tables == |
| Tables are covered in a separate page: [[Help:Tables]] | | Tables are covered in a separate page: [[Help:Tables]] |
| + | |
| + | == nowiki == |
| + | Use <nowiki><nowiki></nowiki> to insert text that is not parsed by the wiki, e.g., |
| + | |
| + | :<nowiki>====Heading 4====</nowiki> |
| + | will result in <nowiki>====Heading 4====</nowiki>, rather than the creation of an actual heading, '''Heading 4''' |
| + | |
| + | == Categories == |
| + | An important navigational tool in the wiki is the use of [[Special:Categories|categories]]. It is customary to include one or more category tags to the end of a page to indicate in what topical area the page belongs. For example, this page should be listed under the <nowiki>[[Category:General public]]</nowiki> and <nowiki>[[Category:HowTo]]</nowiki> categories. You can create a new category, if really necessary, simply by including a new category tag, e.g., <nowiki>[[Category:My new category]]</nowiki>. |
| + | |
| + | == Templates == |
| + | Another tool that helps make the wiki more readily navigable is the use of templates (Please select the Template namespace in the pull-down menu on the [[Special:Allpages]] page to view the current list of available templates). Templates provide a consistent look to pages as well as a shorthand for communicating things like <nowiki>{{Stub}}</nowiki> and <nowiki>{{Requesttranslation}}</nowiki>. Feel free to ask for help ([[Talk:Wiki Team/Guide/Formatting|here]]) regarding creating new templates you may need. |
| + | |
| + | == Translation == |
| + | We have a mechanism for maintaining multilingual versions of pages in the wiki. Please see [[Translation Team/Wiki Translation]] for more information about translations. We also recommend the use of the Google machine translation for pages that have yet to be translated by a human expert. To see a [http://translate.google.com/about/ Google translation], simply use the dropdown selector in the sidebar. |
| + | |
| | | |
| | | |
| == See Also == | | == See Also == |
− | * [[Help:Wiki quickie]] | + | * [http://meta.wikimedia.org/wiki/Help:Contents Meta-Wiki Help:Contents] |
| + | * [[Wiki Team/Guide/Overview]] |
| * [http://www.mediawiki.org/wiki/Help:Formatting MediaWiki Manual: Formatting] | | * [http://www.mediawiki.org/wiki/Help:Formatting MediaWiki Manual: Formatting] |