Last updated November 07, 2012 19:12, by nvause
Feedicon  
[[Home|&raquo; Project Kenai Documentation and Training]] &nbsp;&nbsp; [[Howdoi|&raquo; How Do I ...]] <h1>About Wikis</h1> The project wiki is typically where a project and its processes are documented by project members who have permission to edit and add pages. Usually everyone, even nonmembers, can read a project's wiki pages and get some idea of what the project is about. A project administrator can add a wiki to the project and manage it as described at <a href="http://www.kenai.com/projects/help/pages/ManageProject#Wiki">Managing Projects: Wiki</a>.<br/><br/> __TOC__ == Using a Wiki == If you open a project's home page and click ''&raquo; Wiki'' on the right, you see the wiki's home page and can read it. [[image:wiki-clickwiki.png]] If you have permission as a project member, you can edit pages and add new ones. To edit pages, see all the pages, upload images, or create a new page, open a wiki page and click one of the links on the left in the blue navigation area under Wiki Controls. [[image:wiki-clickedit.png]] === Editing a Wiki Page === # If necessary, open the project's wiki home page as described [[#Using_a_Wiki|above]]. # To open an existing page, either select a page in the ''Jump to Page'' droplist or click ''List all Pages'' in the left blue navigation area. To create a new page, enter a new page name under ''Create New Page'' and press GO to open the editor for the new page.<br/><br/>[[image:wiki-clicklistpages.png]]<br/><br/> # If you opened an existing page, click the Edit Page link in the left blue navigation area. The wiki editing page opens.<br/><br/>[[image:wiki-editpage.png]]<br/><br/> # You can resize the space for the editing area in two ways:<span id="resize-controls"></span> #* Pull down the bar at the bottom of the edit window to get more vertical space.<br/>[[image:wiki-editwin-pulldown.png]]<br/><br/> #* Click anywhere in the border between the editing area and the left navbar to get more horizontal space.<br/><br/>[[image:left-navbar-hideshow.png]]<br/><br/> # Enter [[#Wiki_Formatting|MediaWiki]] or HTML code in the edit area. # For quick help, see the Wiki Syntax Quick Reference table at the bottom of the edit area, below the Save and Preview buttons. # Click the Preview button to see if your code works.<br/>'''Note:''' The Preview window also has a bar at the bottom that you can pull down for more vertical space. # Before saving, optionally enter a comment about the edit in the Revision Comment field. # Click the Save button to save your changes. === Renaming a Wiki Page === You can't directly rename a wiki page, but you can copy the current page's contents to a new page, and then delete the old one. Here's how you do it. # Open the existing page in the wiki editor, as described [[#Editing_a_Wiki_Page|above]], and copy all the contents. # In the right navbar click the Create New Page field, enter the name of the new page, and click GO.<br/>[[image:wiki-createnewpage.png]] # Paste the contents of the old page into the new one, then click Save. # Delete the old page, as described below. === Deleting a Wiki Page === # In the left navbar ([[#Renaming_a_Wiki_Page|see figure above]]), choose List All Pages. # Scroll through the alphabetical list of pages and find the wiki page you want to delete. If you have permission to delete pages, you'll see Delete Page to the right of the page name.<br/><br/>[[image:wiki-deletepage.png]] # Click Delete Page, then confirm the deletion in the dialog.<br/><br/>[[image:wiki-confirmdelete.png]] <br/> === Uploading a Graphics File for a Wiki === To upload an image to be used in a wiki page: # If necessary, open the project's wiki home page as described [[#Using_a_Wiki|above]]. # With a wiki page open, click ''Manage Images'' in the left navigation area to open the Manage Images page.<br/><br/>[[image:wiki-clickuploadimage.png]]<br/><br/> # In the Manage Images page, Click ''Add Image File''.<br/><br/>[[image:wiki-manageimagespage.png]]<br/><br/> # The Upload Image dialog box opens.<br/><br/>[[image:wiki-imageupload.png]]<br/><br/> # Click ''Browse'' and navigate to the image file, then optionally enter comments describing the file. # Click ''Upload Image'' to upload the file. # A message appears above the Image Upload area. If the upload succeeds, you see the message in the figure below. If it fails, you see an error message instead.<br/><br/>[[image:wiki-imageuploadmessage.png]]<br/><br/> == Managing a Wiki == If you are a project owner or administrator, you can add or delete a project wiki, change its display name, description, and default home page, and set who has access to it for reading, editing, and creating and deleting pages. See <a href="http://www.kenai.com/projects/help/pages/ManageProject#Wiki">Managing Projects: Wiki</a>. == Wiki Formatting == You can format your text using wiki markup, which uses normal characters like asterisks, single quotes, and equals signs that have a special function in the wiki, sometimes depending on their position. For example, to format a word in ''italic'', you surround it with two single quotes like <tt><nowiki>''this''</nowiki></tt>.<br /> {|- |- valign="top" |'''Note:''' |This site uses an implementation of MediaWiki, the wiki software used by Wikipedia. Not all features of MediaWiki are supported, which is why we supply our own help pages. There's a lot of information on how to use MediaWiki in the Wikipedia Help pages. For example, there's wiki text formatting help at [http://en.wikipedia.org/wiki/Help:Wikitext]. <br /><br /> Since WikiPedia has its own implementation of MediaWiki, not everything they suggest will work here. If you see something you really like and want to see here, let us know on the [http://www.kenai.com/projects/help/forums/43-Features Features help forum]! |} == Wiki Markup == In addition to using the wiki markup tags described below, you can use most HTML tags. If you do use HTML, you might want to Preview your pages to make sure the tags work. One HTML tag that does '''not''' work is the <tt>&lt;body&gt;</tt> tag. Anything enclosed in this tag will not display. '''Note:''' In addition to the examples in the wiki markup table below, there are wiki markup samples at [[MediaWikiSamples|MediaWiki Sampler]]. <table> <tr style="background-color:#d1d1d1;"> <td colspan="5" style="text-align:center" id="applyanywhere"> ====Apply Anywhere==== </td> </tr> <tr valign="top" style="background-color:#e1e1e1;"> <td>'''Description'''</td> <td>&nbsp;&nbsp;</td> <td>'''You type'''</td> <td>&nbsp;&nbsp;</td> <td>'''You get''' </td> </tr> <tr valign="top"> <td>Italic text</td> <td>&nbsp;&nbsp;</td> <td><tt><nowiki>''italic''</nowiki></tt></td> <td>&nbsp;&nbsp;</td> <td>''italic'' </td> </tr> <tr valign="top" style="background-color:#f1f1f1;"> <td> Bold text</td> <td>&nbsp;&nbsp;</td> <td><tt><nowiki>'''bold'''</nowiki></tt></td> <td>&nbsp;&nbsp;</td> <td>'''bold''' </td> </tr> <tr valign="top"> <td> Bold and italic</td> <td>&nbsp;&nbsp;</td> <td><tt><nowiki>'''''bold & italic'''''</nowiki></tt></td> <td>&nbsp;&nbsp;</td> <td>'''''bold & italic''''' </td> </tr> <tr valign="top" style="background-color:#f1f1f1;"> <td>Hyperlink to wiki page <br/></td> <td>&nbsp;&nbsp;</td> <td><tt><nowiki>[[Home]</nowiki></tt> <br/></td> <td>&nbsp;&nbsp;</td> <td>[[Home]] </td> </tr> <tr valign="top"> <td>Hyperlink to wiki page with different link text&mdash;use <tt>|</tt> to separate text</td> <td>&nbsp;&nbsp;</td> <td><tt><nowiki>[[Home|Main doc page]]</nowiki></tt></td> <td>&nbsp;&nbsp;</td> <td>[[Home|Main doc page]] </td> </tr> <tr valign="top" style="background-color:#f1f1f1;"> <td>Hyperlink to external web page</td> <td>&nbsp;&nbsp;</td> <td><tt><nowiki>[http://www.oracle.com]</nowiki></tt></td> <td>&nbsp;&nbsp;</td> <td>[http://www.oracle.com] </td> </tr> <tr valign="top"> <td>Hyperlink to external web page with different link text&mdash;''space'' separates text</td> <td>&nbsp;&nbsp;</td> <td><tt><nowiki>[http://www.oracle.com Oracle]</nowiki></tt></td> <td>&nbsp;&nbsp;</td> <td>[http://www.oracle.com Oracle]</td> </tr> <tr valign="top" style="background-color:#f1f1f1;"> <td>Parameterized link to this project's project page</td> <td>&nbsp;&nbsp;</td> <td><tt><nowiki><a href="{{project}}">this project's project page</a></nowiki></tt></td> <td>&nbsp;&nbsp;</td> <td><a href="{{project}}">this project's project page</a></td> </tr> <tr valign="top"> <td>Parameterized link to this project's forums</td> <td>&nbsp;&nbsp;</td> <td><tt><nowiki><a href="{{forums}}">this project's forums</a></nowiki></tt></td> <td>&nbsp;&nbsp;</td> <td><a href="{{forums}}">this project's forums</a></td> </tr> <tr valign="top" style="background-color:#f1f1f1;"> <td>Parameterized link to the list of all projects</td> <td>&nbsp;&nbsp;</td> <td><tt><nowiki><a href="{{projects}}">all projects</a></nowiki></tt></td> <td>&nbsp;&nbsp;</td> <td><a href="{{projects}}">all projects</a></td> </tr> <tr valign="top"> <td>Parameterized link to project Help</td> <td>&nbsp;&nbsp;</td> <td><tt><nowiki><a href="{{project help}}">Help project</a></nowiki></tt></td> <td>&nbsp;&nbsp;</td> <td><a href="{{project help}}">Help project</a></td> </tr> <tr valign="top" style="background-color:#f1f1f1;"> <td>Parameterized link to project Help's wiki home page</td> <td>&nbsp;&nbsp;</td> <td><tt><nowiki><a href="{{project help page Home}}">Project Help's wiki home page</a></nowiki></tt></td> <td>&nbsp;&nbsp;</td> <td><a href="{{project help page Home}}">Project Help's wiki home page</a></td> </tr> <tr valign="top"> <td>Anchor definition. Use the id attribute with an HTML tag that takes this attribute, such as <tt>&lt;span&gt;</tt> or <tt>&lt;div&gt;</tt>.</td> <td>&nbsp;&nbsp;</td> <td><tt>&lt;span id="anchor_to_link_to"&gt;optional text&lt;/span&gt;</tt></td> <td>&nbsp;&nbsp;</td> <td><span id="anchor_to_link_to">optional text</span></td> </tr> <tr valign="top" style="background-color:#f1f1f1;"> <td>Hyperlink to anchor<br/></td> <td>&nbsp;&nbsp;</td> <td><tt><nowiki>[[#anchor_to_link_to|go to anchor]]</nowiki></tt> <br/></td> <td>&nbsp;&nbsp;</td> <td>[[#anchor_to_link_to|go to anchor]]</td> </tr> <tr valign="top"> <td>Inline image. Use <tt>|</tt> to separate options, which include: * <tt>thumb</tt> for an 80x80 pixel thumbnail * <tt>99px</tt> to size the image to 99 by 99 pixels square * <tt>66x99px</tt> to size the image to 66px wide by 99px high * <tt>left</tt> or <tt>right</tt> to float the image left or right * <tt>block</tt> to use a horizontal scrollbar with an image that is wider than the screen<br/> For more sample code, see [[MediaWikiSamples#Images|Images]] in the MediaWiki Sampler page.</td> <td>&nbsp;&nbsp;</td> <td><tt><nowiki>[[image:aracari-sm.png]]</nowiki></tt></td> <td>&nbsp;&nbsp;</td> <td>[[image:aracari-sm.png]]</td> </tr> <tr valign="top" style="background-color:#f1f1f1;"> <td>Inline image with <tt>thumb</tt>, and <tt>right</tt> parameters. </td> <td>&nbsp;&nbsp;</td> <td><tt><nowiki>[[image:aracari.png|thumb|right]]</nowiki></tt></td> <td>&nbsp;&nbsp;</td> <td>[[image:aracari.png|thumb|right]]</td> </tr> <tr valign="top" > <td>Escape wiki markup</td> <td>&nbsp;&nbsp;</td> <td><tt>&lt;nowiki&gt;<nowiki>no ''markup''</nowiki>&lt;/nowiki&gt;</tt> </td> <td>&nbsp;&nbsp;</td> <td><nowiki>no ''markup''</nowiki> </td> </tr> <tr valign="top" style="background-color:#f1f1f1;"> <td>Table of Contents: Use two underscores before <tt>TOC</tt> and two after. The table of contents is inserted at the location of this identifier and lists all headings defined with wiki heading tags (<nowiki>=, ==, ===</nowiki>, and so on). If you want to exclude a heading, such as the main heading, use HTML tags instead of wiki tags. For example, <tt>&lt;h1&gt;Main Heading&lt;/h1&gt;</tt>.</td> <td>&nbsp;&nbsp;</td> <td><tt><nowiki>__TOC__</nowiki></tt></td> <td>&nbsp;&nbsp;</td> <td>__TOC__</td> </tr> <tr valign="top"> <td colpsan="5">&nbsp;</td> </tr> <tr valign="top" style="background-color:#d1d1d1;"> <td colspan="5" style="text-align:center" id="beginning"> ====Apply Only at Beginning of Line====</td> </tr> <tr valign="top" style="background-color:#e1e1e1;"> <td>'''Description'''</td> <td>&nbsp;&nbsp;</td> <td>'''You type'''</td> <td>&nbsp;&nbsp;</td> <td>'''You get''' </td> </tr> <tr valign="top"> <td> Indented text</td> <td>&nbsp;&nbsp;</td> <td><tt><nowiki>:Indented text</nowiki></tt></td> <td>&nbsp;&nbsp;</td> <td>&nbsp;&nbsp;&nbsp;&nbsp;Indented text</td> </tr> <tr style="background-color:#f1f1f1;"> <td>Headings of various levels</td> <td>&nbsp;&nbsp;</td> <td><tt><nowiki>=level 1=</nowiki></tt></td> <td>&nbsp;&nbsp;</td> <td><h1>Level 1</h1></td> </tr> <tr> <td>&nbsp; </td> <td>&nbsp;&nbsp;</td> <td><tt><nowiki>==level 2==</nowiki></tt></td> <td>&nbsp;&nbsp;</td> <td><h2>Level 2</h2></td> </tr> <tr style="background-color:#f1f1f1;"> <td>&nbsp;</td> <td>&nbsp;&nbsp;</td> <td><tt><nowiki>===level 3===</nowiki></tt></td> <td>&nbsp;&nbsp;</td> <td><h3>Level 3</h3></td> </tr> <tr> <td>&nbsp;</td> <td>&nbsp;&nbsp;</td> <td><tt><nowiki>====level 4====</nowiki></tt><br /></td> <td>&nbsp;&nbsp;</td> <td><h4>Level 4</h4> <br /></td> </tr> <tr style="background-color:#f1f1f1;"> <td>Horizontal rule <br /></td> <td>&nbsp;&nbsp;</td> <td><tt><nowiki>----</nowiki></tt> &nbsp;</td> <td>&nbsp;&nbsp;</td> <td> <hr /></td> </tr> <tr valign="top"> <td>Bulleted list</td> <td>&nbsp;&nbsp;</td> <td><tt><nowiki>*</nowiki> first item</tt><br /> <tt><nowiki>*</nowiki> second item</tt><br /> <tt><nowiki>**</nowiki> first sub-item</tt><br /> <tt><nowiki>**</nowiki> second sub-item</tt><br /> <tt><nowiki>***</nowiki> first sub-sub-item</tt><br /> <tt><nowiki>***</nowiki> second sub-sub-item</tt></td> <td>&nbsp;&nbsp;</td> <td> * first item * second item ** first sub-item ** second sub-item *** first sub-sub-item *** second sub-sub-item</td> </tr> <tr valign="top" style="background-color:#f1f1f1;"> <td>Numbered list</td> <td>&nbsp;&nbsp;</td> <td><tt><nowiki>#</nowiki> Step 1</tt><br /> <tt><nowiki>#</nowiki> Step 2<nowiki><br /></nowiki></tt> <tt>more on two<nowiki><br /></nowiki></tt> <tt>yet more on two</tt><br /> <tt><nowiki>#</nowiki> Step 3</tt><br /> <tt><nowiki>##</nowiki> Sub-step 1</tt><br /> <tt><nowiki>##</nowiki> Sub-step 2</tt></td> <td>&nbsp;&nbsp;</td> <td> # Step 1 # Step 2<br />more on two<br />yet more on two # Step 3 ## Sub-step 1 ## Sub-step 2</td> </tr> <tr valign="top"> <td> Mixture of bulleted<br /> and numbered lists<br /><br /><br /><br /></td> <td>&nbsp;&nbsp;</td> <td><tt><nowiki>#</nowiki> Step 1</tt><br /> <tt><nowiki>#</nowiki> Step 2</tt><br /> <tt><nowiki>#*</nowiki> Sub-item</tt><br /> <tt><nowiki>#*</nowiki> Sub-item</tt> <br/><br/> <tt><nowiki>*</nowiki> Bullet 1</tt><br /> <tt><nowiki>*</nowiki> Bullet 2</tt><br /> <tt><nowiki>*#</nowiki> Sub-step 1</tt><br /> <tt><nowiki>*#</nowiki> Sub-step 2</tt></td> <td>&nbsp;&nbsp;</td> <td> # Step 1 # Step 2 #* Sub-item #* Sub-item * Bullet 1 * Bullet 2 *# Sub-step 1 *# Sub-step 2</td> </tr> <tr valign="top" style="background-color:#f1f1f1;"> <td>Definition list</td> <td>&nbsp;&nbsp;</td> <td><tt><nowiki>;</nowiki>Term</tt><br /> <tt><nowiki>:</nowiki>Definition 1</tt><br /> <tt><nowiki>:</nowiki>Definition 2</tt></td> <td>&nbsp;&nbsp;</td> <td> <dl> <dt>Term</dt> <dd>Definition 1</dd> <dd>Definition 2</dd> </dl></td> </tr> <tr valign="top"> <td>Preformatted text<br/><br/> For information on code formattting using the <nowiki><pre name="language-name"></nowiki> syntax to format php, Java, CSS, and Ruby code samples, see [[MediaWikiSamples#Source_Code_Formatting|Source Code Formatting]].</td> <td>&nbsp;&nbsp;</td> <td><br /> <tt>&nbsp;preformatted text re-</tt><br /> <tt>&nbsp;quires a space at the</tt><br /> <tt>&nbsp;beginning of each line</tt></td> <td>&nbsp;&nbsp;</td> <td><br /> <pre>preformatted text re- quires a space at the beginning of each line</pre></td> </tr> <tr valign="top" style="background-color:#f1f1f1;"> <td> A table with borders, a header row, a simple row, and a row with the valign attribute defined.</td> <td>&nbsp;&nbsp;</td> <td><br /> <tt><nowiki>{|- border="1"</nowiki></tt><br /> <tt><nowiki>! Heading 1</nowiki></tt><br /> <tt><nowiki>! Heading 2</nowiki></tt><br /> <tt><nowiki>|-</nowiki></tt><br /> <tt><nowiki>| cell 1</nowiki></tt><br /> <tt><nowiki>| cell 2</nowiki></tt><br /> <tt><nowiki>|- valign="top"</nowiki></tt><br /> <tt><nowiki>| single line</nowiki></tt><br /> <tt><nowiki>| two lines<br />of content</nowiki></tt><br /> <tt><nowiki>|}</nowiki></tt></td> <td>&nbsp;&nbsp;</td> <td><br /> {|- border="1" ! Heading 1 ! Heading 2 |- | cell 1 | cell 2 |- valign="top" | single line | two lines<br />of content |}</td> </tr> </table>

Project Features

Wiki Controls

About this Project

Help for netbeans.org Site Tools was started in November 2009, is owned by kenaiadmin, and has 17 members.
By use of this website, you agree to the NetBeans Policies and Terms of Use (revision 20131025.e7cbc9d). © 2013, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo
 
 
Close
loading
Please Confirm
Close