Page Editing

Editing a Wiki Page in ScrewTurn Wiki is really simple. You can insert WikiMarkup, standard XHTML or use the integrated Format Helper Toolbar. In all the cases, you can format the text and insert links, images and many other items in a simple and quick fashion.

{toc}

== WikiMarkup ==
The WikiMarkup is a particular set of prefixes and suffixes that allow to format the text and insert items, such as links and images. In this section you'll learn how to use the WikiMarkup.

=== Basic Text Formatting ===
* Writing <nowiki>'''bold'''</nowiki> produces '''bold'''.
* Writing <nowiki>''italic''</nowiki> produces ''italic''.
* Writing <nowiki>__underlined__</nowiki> produces __underlined__.
* Writing <nowiki>--striked--</nowiki> produces --striked--.
* You can use any combination, for example <nowiki>--striked '' '''bold''' and italic''--</nowiki> produces --striked '' '''bold''' and italic''--.

=== Links ===
Links are identified with <nowiki>[</nowiki> and <nowiki>]</nowiki>.
'''Note''': since version 1.0.10, links also work with 2 brackets, for example <nowiki>[[Link]]</nowiki>.
* To insert a link to an internal page just write <nowiki>[PageName]</nowiki>, that produces [Help.Page Editing|PageName] (if the linked Page doesn't exist, the link will have a different color).
* You can add a title to the link: <nowiki>[PageName|This is a Link]</nowiki> produces [Help.Page Editing|This is a Link].
* Email links are detected automatically, for example <nowiki>[mail@server.com]</nowiki> produces [mail@server.com].
* Obviously you can add a title: <nowiki>[mail@server.com|Contact us]</nowiki> becomes [mail@server.com|Contact us].
* External links are marked with a special icon: <nowiki>[http://www.screwturn.eu]</nowiki> produces [http://www.screwturn.eu].
* You can link to an internal file or subdirectory: <nowiki>[blog/|Blog]</nowiki> produces [blog/|Blog] and <nowiki>[GPL.txt|GPL]</nowiki> produces [GPL.txt|GPL].
* You can link to a Windows Share Drive: <nowiki>[file://///server_name/shared_directory/shared_file.txt|This links to shared directory]</nowiki> produces: [file://///server_name/shared_directory/shared_file.txt|This links to shared directory].
* If you add a ^ sign to the URL, the link will open in a new browser window, for example <nowiki>[^MyPage]</nowiki>.
* You can use Anchors in your page links: <nowiki>[PageName#Anchor|This is a Link with an anchor]</nowiki> produces [Help.Page Editing#Anchor|This is a Link with an anchor].
: Another example is <nowiki>[PageEditing.ashx#BC_-_Links_7|PageEditing/1.2 - Links]</nowiki> [PageEditing.ashx#BC_-_Links_7|PageEditing/1.2 - Links].
* You can upload files using the [++Upload.aspx|File Management] interface.

==== Notes ====
Links and Images share the same general syntax, but the number of fields changes.

==== Categories ====
You can link a Category by using the following syntax:
@@ <nowiki>[c:CategoryName]</nowiki> @@

For example, you can link the Help category or all the uncategorized Pages (<nowiki>[c:-|uncategorized Pages]</nowiki>).

==== Page Attachments ====
You can <i>attach</i> a file to a Page using the following syntax:<br/>

@@[attachment:File.jpg]@@<br/>
Attachment are listed at the bottom of the Page. Please note that this function is still quite "raw", and the attached files are not real attachments, but just links to some <a class="unknownlink" href="Upload.aspx" title="FileManagement"> uploaded files</a>.<br/>

<a href="Edit.aspx?Page=ScrewTurn-Wiki-Page-Editing&amp;Section=8" class="editsectionlink"/>
=== Headings ===
You can create headings using a sequence of equal (<nowiki>=</nowiki>) signs:

* <nowiki>==Biggest Heading (H1)==</nowiki>
* <nowiki>===Big Heading (H2)===</nowiki>
* <nowiki>====Small Heading (H3)====</nowiki>
* <nowiki>=====Smallest Heading (H4)=====</nowiki>
* The first 3 Headings work as separators, the latter is only a small heading (use it sparingly)
* H1 is not recommended because it's used for the Page Title and therefore may cause confusion

<b>Note</b>: headings must be placed at the beginning of lines.

==== Horizontal Line ====
You can place a horizontal line using four hyphens <nowiki>----</nowiki>.

=== Images ===
Images use <nowiki>[</nowiki>and<nowiki>]</nowiki> as delimiters.

<b>Note</b>: since version 1.0.10, images also work with 2 brackets, for example <nowiki>[[image|Title|Url]]</nowiki>.

There are several types of images:
* <nowiki>[image|Title|Url|Big Url/Link Url (optional)]</nowiki>inserts an inline image, without borders nor legend
* <nowiki>[imageleft|Title|Url|Big Url/Link Url (optional)]</nowiki>and<nowiki>[imageright|Title|Url|Big Url (optional)]</nowiki>insert images aligned respectively on the left and on the right, displaying borders and a description
* <nowiki>[imageauto|Title|Url|Big Url/Link Url (optional)]</nowiki>inserts an image with automatic alignment, displaying borders and description
* In all the cases, <i>Big Url/Link Url</i> is optional; when specified, it links the image with its big version or with any another document

<b>Note</b>: if the <i>Title</i> field starts with <nowiki>#</nowiki>, the title is not shown in the page but it is still used to populate the <i>alt</i> attribute of the image.

You can upload images and files using the <a class="unknownlink" href="Upload.aspx" title="FileManagement">File Management</a>interface.

==== Notes ====

Links and Images share the same general syntax, but the number of fields changes. 

<a href="Edit.aspx?Page=ScrewTurn-Wiki-Page-Editing&amp;Section=10" class="editsectionlink" />

=== Lists ===
A list is made by a sequence of lines starting with one or more asterisks (<nowiki>*</nowiki>) and/or diesis (<nowiki>#</nowiki>). You can create nested list using more than one asterisk or diesis.

<table cellpadding="0"
       cellspacing="0">
	<tbody>
		<tr>
			<td valign="top">
				<div class="box">
					<code>* Element 1<br/>* Element 2</code>
					<br/>
					<br/>
					<i>produces</i>
					<br/>
					<br/>
					<ul>
						<li>Element 1</li>
						<li>Element 2<br/>
						</ul>
					</div>
					<br/>
					<td valign="top">
						<br/>
						<div class="box">
							<br/>
							<code># Element 1<br/># Element 2</code>
							<br/>
							<br/>
							<i>produces</i>
							<br/>
							<br/>
							<ol>
								<li>Element 1</li>
								<li>Element 2<br/>
								</ol>
							</div>
							<br/>
							<td valign="top">
								<br/>
								<div class="box">
									<br/>
									<code># Element 1<br/># Element 2<br/>#* Element 2.1<br/>#* Element 2.2<br/># Element 3</code>
									<br/>
									<br/>
									<i>produces</i>
									<br/>
									<br/>
									<ol>
										<li>Element 1</li>
										<li>Element 2<ul>
												<li>Element 2.1</li>
												<li>Element 2.2</li>
											</ul>
										</li>
										<li>Element 3<br/>
										</ol>
									</div>
									<br/>
									<td valign="top">
										<br/>
										<div class="box">
											<br/>
											<code># Element 1<br/># Element 2<br/>#* Element 2.1<br/>#*# Element 2.1.1<br/>#*#* Element 2.1.1.1<br/># Element 3</code>
											<br/>
											<br/>
											<i>produces</i>
											<br/>
											<br/>
											<ol>
												<li>Element 1</li>
												<li>Element 2<ul>
														<li>Element 2.1<ol>
																<li>Element 2.1.1<ul>
																		<li>Element 2.1.1.1</li>
																	</ul>
																</li>
															</ol>
														</li>
													</ul>
												</li>
												<li>Element 3<br/>
												</ol>
											</div>
											<br/>
										</tr>
									</tbody>
								</table>
								<a href="Edit.aspx?Page=ScrewTurn-Wiki-Page-Editing&amp;Section=11"
								   class="editsectionlink"/>
=== Code and the NoWiki Tag ===
If you want to insert an inline piece of code, wrap it with <nowiki>{{</nowiki>and<nowiki>}}</nowiki>; for example <nowiki>{{This is code}}</nowiki> produces <nowiki>This is code</nowiki>.
If you want to insert a block of code, for example a C# class, wrap it with <nowiki>{{{{</nowiki>and<nowiki>}}}}</nowiki>, as in

<pre>using System;

namespace MyNamespace {
   public class HelloWorld {
      public static void Main(string[] args) {
         Console.WriteLine("Hello World");
      }
   }
}
</pre>

If you want to exclude a block of text from the WikiMarkup formatting, wrap it with <nowiki>&lt;nowiki&gt;</nowiki> and <nowiki>&lt;/nowiki&gt;</nowiki>, for example <nowiki>&lt;nowiki&gt;[MyPage]&lt;/nowiki&gt;</nowiki> produces [Page Editing|MyPage].

==== The Tag ====
If you need to place some code that contains, for example, XML and even WikiMarkup and you want it to be displayed exactly as is, wrap it with two<b>@</b>:
<pre>@ @
&lt;xml&gt;
   '''Bold'''
   &lt;bla z="b" /&gt;
&lt;/xml&gt;
@ @
</pre>

Removing the space between the<b>@</b>signs, the result is:

<pre>&lt;xml&gt;
   '''Bold'''
   &lt;bla z="b" /&gt;
&lt;/xml&gt;
</pre>

<a href="Edit.aspx?Page=ScrewTurn-Wiki-Page-Editing&amp;Section=12" class="editsectionlink"/>
=== Line Breaks ===
Two line breaks are treated as they are. A single line break is ignored. If you want to insert a single line break, you can use the standard XHTML tag <nowiki>&lt;br /&gt;</nowiki> or its <i>WikiMarkup</i> alias <nowiki>{BR}</nowiki> (letter casing is ignored). It's not recommended to abuse single line breaks because they tend to create confusion in the page.

Alternatively, you might want to enable the <i>Process Single Line Breaks</i> options in the <a class="unknownlink" href="Configuration.ashx" title="Configuration">Configuration</a> page.

=== Special Tags ===
The ScrewTurn Wiki engine provides a few special markers that are replaced automatically with specific content. All these tags ignore the letter casing.
* <nowiki>{wikititle}</nowiki>produces Jasinski Technical Wiki (the title of the Wiki)
* <nowiki>{up}</nowiki>produces GetFile.aspx?File= (the file upload path)
* <nowiki>{top}</nowiki>produces<a href="#PageTop">Top</a>(link to the top of the current Page)
* <nowiki>{toc}</nowiki>produces the Table of Contents of the Page, using Hx headers as titles
* <nowiki>{themepath}</nowiki>produces Themes/Jasinski/ (the current theme path)
* <nowiki>{rsspage}</nowiki>produces<a href="RSS.aspx?Page=ScrewTurn-Wiki-Page-Editing" title="Update notifications for this Page (RSS 2.0)"><img src="Themes/Jasinski/Images/RSS.png" alt="RSS"/>(the link to the current Page's RSS feed, available only in Pages) 
* <nowiki>{wikiversion}</nowiki>produces 3.0.1.400 (the version of the Wiki engine)
* <nowiki>{mainurl}</nowiki>produces http://www.jasinskionline.com/TechnicalWiki/ (the Main URL of the Wiki)
* <nowiki>{pagecount}</nowiki>produces 806 (the # of Pages in the Wiki)</li>
* <nowiki><a href="Language.aspx" class="systemlink" title="Select your language">Guest</a></nowiki> inserts the Username of the current user
* <nowiki>{cloud}</nowiki>inserts a Categories Cloud
* <nowiki>{searchbox}</nowiki>inserts a Search Box, with full-text search disabled by default (only one Search Box can be used at a time)
* <nowiki>{ftsearchbox}</nowiki>inserts a Search Box, with full-text search enabled by default
* <nowiki>{clear}</nowiki>to use when inserting images at the bottom of a Page

=== Boxes ===

=== Text Indentation ===

=== Tables ===

=== User Signature ===

=== Snippets and Page Transclusion ===

=== Page Redirection ===

=== XHTML Support and Escaping ===

== Format Toolbar ==
Meta Keywords:
Meta Description:
Change Comment:
Modified on 2024/04/17 22:35 by Administrator Categorized as Uncategorized