Recent changes to Wiki

Wiki modified by Dave Brondsema

Dave Brondsema — Tue, 05 Jun 2018 14:21:35 -0000

--- v21
+++ v22
@@ -12,9 +12,8 @@

 ### Set Home

-**Set Home** defines which page the wiki will redirect to when the base URL is used. By default, this is set to "Home".
+**Set Home** defines which page the wiki will redirect to when the base URL is used. By default, this is set to the page named "Home".

-For example, for the Allura project's wiki has "Allura wiki" set as its Home, so http://sourceforge.net/p/allura/wiki/ redirects to http://sourceforge.net/p/allura/wiki/Allura%20Wiki/

 ### Options

Wiki modified by Dave Brondsema

Dave Brondsema — Thu, 14 Jan 2016 20:58:17 -0000

--- v20
+++ v21
@@ -6,9 +6,9 @@

 ## Configuring the Wiki

-The wiki can be installed via **Admin -> Tools**
+The wiki can be installed via the "Add New..." link in the project menu bar.

-Once installed, for each wiki, there are a number of configuration options available. In addition to the common tool options of [permissions](/p/forge/community-docs/Project Permissions/), Label and Delete, there are also these options specific to the Wiki tool:
+Once installed, for each wiki, there are a number of configuration options available. In addition to the common tool options of [permissions](/p/forge/community-docs/Project Permissions/), Rename and Delete, there are also these options specific to the Wiki tool:

 ### Set Home

@@ -44,7 +44,7 @@

 #### Attachments

-To add an attachment to a page, first save the page content, as you may lose unsaved changes otherwise. Select **Add attachment** button at the bottom of the edit view, then follow the steps presented:
+To add an attachment to a page, select **Add attachment** button at the bottom of the edit view, then follow the steps presented:

 1. Select a file to upload
 2. Select **Attach file**

Wiki modified by

Wed, 09 Apr 2014 14:54:42 -0000

Wiki modified by

Thu, 18 Apr 2013 15:03:42 -0000

--- v18
+++ v19
@@ -8,7 +8,7 @@

 The wiki can be installed via **Admin -> Tools**

-Once installed, for each wiki, there are a number of configuration options available. In addition to the common tool options of [permissions](/p/forge/community-docs/Project Permissions/), Label and Delete, there are also these options specific to the Tickets tool:
+Once installed, for each wiki, there are a number of configuration options available. In addition to the common tool options of [permissions](/p/forge/community-docs/Project Permissions/), Label and Delete, there are also these options specific to the Wiki tool:

 ### Set Home

Wiki modified by

Fri, 12 Apr 2013 20:57:15 -0000

Wiki modified by

Fri, 12 Apr 2013 20:57:05 -0000

--- v16
+++ v17
@@ -1,122 +1,72 @@
-[[include ref=in-progress]]
-
-## Wiki Overview
+Wiki Overview

 The wiki is a collaborative document editor which is easily edited. By default any project developer can edit the project wiki. Like most modern wiki's all edits are non-destructive -- we keep a copy of every version.

-The wiki page itself has an edit button at the top right, and a discussion feature at the bottom of every page. The comment system is the same as all of the other tools in the new SourceForge system.
+[TOC]

-Like most wiki's there's a history page allows you to view the most recent edits to the wiki, and revert to any previous version.
+## Configuring the Wiki

-Advanced users can modify permissions at Permissions can be modified at: 
-http://sourceforge.net/p/PROJECTNAME/admin/wiki/permissions
+The wiki can be installed via **Admin -> Tools**

-Wikis by default have a left navigation/tool sidebar and a right metadata panel which shows authorship, tags, and attachments.  These can be optionally removed in the wiki's configuration options under "admin".
+Once installed, for each wiki, there are a number of configuration options available. In addition to the common tool options of [permissions](/p/forge/community-docs/Project Permissions/), Label and Delete, there are also these options specific to the Tickets tool:

-## Markdown syntax
+### Set Home

-The wiki uses the [Markdown Syntax](http://daringfireball.net/projects/markdown/syntax) with a few notable extensions.
+**Set Home** defines which page the wiki will redirect to when the base URL is used. By default, this is set to "Home".

-### Artifact Links
+For example, for the Allura project's wiki has "Allura wiki" set as its Home, so http://sourceforge.net/p/allura/wiki/ redirects to http://sourceforge.net/p/allura/wiki/Allura%20Wiki/

-Any page existing forge resource can be linked with surrounding square brackets ie [mypage].   
+### Options

-Links to resources in other tools can be explicitly referenced by adding a tool identifier prefix to the link.  So for instance `[developerwiki:MyTechnicalPage]` and `[userwiki:MySimplePage]` can refer to wiki pages in a `developerwiki` instance.  You can also link to tickets with `[tickets:123]` assuming there's a 123 ticket in a ForgeTracker instance mounted at `tickets`. The same is true for forums, or any of the other tools you have installed. You can even link to tickets in a subproject with `[subproject.tickets:123]`.
+The **Options** page in admin provides you with the ability to remove three different pieces of the wiki functionality.

-### Code Highlighting
+* **Show discussion**: The comments section on each wiki page
+* **Show left bar**: Links to page creation, browse pages/labels, and formatting help. All these pages will still be available if this is disabled, but you may need to use direct links.
+* **Show metadata**: The author, label, and attachment display near the top of each page

-The Code highlighting used is based on [CodeHilite](http://www.freewisdom.org/projects/python-markdown/CodeHilite). It follows the same syntax as regular Markdown code blocks, except that there are two ways to tell the highlighter what language to use for the code block. 
+If you want to maximize the screen real estate of the wiki, or treat it more as a CMS, you may want to remove all three of these options.

-SheBang (with path)
+## Using the Wiki

-If the first line of the codeblock contains a shebang, the language is derived from that and line numbers are used.
+Wiki content itself, like the rest of Allura tools, uses [Markdown formatting](/p/forge/documentation/markdown_syntax/), along with some additional handling for Artifact Links and some custom macros.

-~~~~
-:::text
-    #!/usr/bin/python
-    # Code goes here ...
-~~~~
+### Creating and Editing Pages

-Will result in:
+Creating a page can be done a few different ways, assuming you have the appropriate permissions:

-    #!/usr/bin/python
-    # Code goes here ...
+ * From the left sidebar, select **Create Page** and enter the desired name
+ * On an existing page, create a reference to a new page by putting the new page name in brackets (eg. `[New page]`), then click on that link.
+ * Enter the URL where you want the page to reside, if it does not already exist you'll be presented with an edit link.

+To edit an existing page, simply use the **Edit** link in the upper right of a page (the pencil icon).

-####SheBang (no path) and triple Colon
+Wiki pages may also be created and edited using the [Allura API]

-If the first line contains a shebang, but the shebang line does not contain a path (a single / or even a space) or If the first line begins with three or more colons, the text following the colons identifies the language. In both cases, the first line is removed from the code block before processing.
+#### Attachments

-So, for example: 
+To add an attachment to a page, first save the page content, as you may lose unsaved changes otherwise. Select **Add attachment** button at the bottom of the edit view, then follow the steps presented:

-~~~~
-:::text
-    :::python
-    # Code goes here ...
-~~~~
+1. Select a file to upload
+2. Select **Attach file**

-Will result in just:
+Repeat as necessary for multiple files.

-    :::python
-    # Code goes here ...
+### Moving pages

-### Macros 
+To move a page, first enter the edit view, then change the name of the page. Moving a page in this way will preserve the wiki page history.

-macros can be used to call functions in the wiki, currently we have a number of custom macros `include` and `img`: 
+### Deleting pages

-- The `include` macro looks like this:  `[[include ref=PAGENAME ATTRIBUTE=VALUE ATTRIBUTE2=VALUE etc]]` which pulls in another wiki page into a div on the current page. The attribute fields are passed on to the div, so it can be given id, class, etc definitions for layout.   This is useful where you want an announcement on every wiki page, or where you want to include some consistent navigation element in on every wiki page. 
+To delete a page, enter the edit view, then select the **Trash** icon in the upper right.

-- `img src=IMAGENAME`  surrounded by double square brackets `[[ ]]` -- this embeds an attached image, or image by url into the page
+Deleting a page will remove it from view, however the page may still be undeleted if necessary. To do so, select the **+** icon when viewing the deleted page. You will then enter the edit view, and you may rename the page name as appropriate.

-###Tables
+Deleted pages can be found view the **Browse Pages** view by selecting the **Show deleted pages** link at the bottom of the list.

-Everywhere you can use markdown on the newforge you can use confluence-style "|" delimited tables.
+### Viewing Page History and Reverting

+To view the history of a page, select the **Newspaper** icon.

-## Free-form HTML
+From that page, view a specific revision by selecting the **Magnifying glass** icon. The other icon will revert the page to that revision.

-The adobe wikis can also accept a restricted subset of HTML. 
-
-## Attachments
-
-Wiki pages can store attachments for files up to ~10M, including images.  Attachments are added or removed on the bottom of the edit page, and will automatically show up in links on the right hand navigation bar.  Images will be automatically thumbnailed. 
-
-## Administrative options
-
-In the **Admin** tab there are a couple of options that you can set to customize your wiki.
-
-The first page just lets you select the "home page" for you wiki.   This is the page that you'll be sent to if you link directly to the root of the wiki.   You can change this page at any time, just by entering the name of the new page in the text box. 
-
-The options page in admin provides you with the ability to remove three different pieces of the wiki functionality.  
-
-* Show discussion
-* Show left bar
-* Show right bar
-
-If you want to maximize the screen realestate of the wiki, or treat it more as a CMS, you may want to remove all three of these options. 
-
-## REST API
-
-All wiki pages are read/writable via the REST API, which has 3 main functions:
-
- - View page
-
-Adding "/rest" as the top level directory allows you to fetch the wiki pages in JSON format ie:   https://sourceforge.net/adobe/cairngorm/wiki/CairngormTools/
-becomes
-https://sourceforge.net/rest/adobe/cairngorm/wiki/CairngormTools/
-
- - List pages
-
-Similarly, prefixing the wiki tool path with "/rest" lets you see a JSON list of pages in the wiki:  https://sourceforge.net/rest/adobe/cairngorm/wiki/
-
- - Update page
-
-Updating the wiki is done by calling the view page with additional parameters, including signed API keys.  I have attached a python script which demos the basic functionality by allowing a wiki page to be created out of a markdown or HTML file, but it requires that the user create a .forge-api.ini file with the parameters:
-
-     [keys]
-     api-key=XXXXXX
-     secret-key=XXXXX
-
-These keys can be generated for your account by going to the https://sourceforge.net/auth/prefs/ page.   Usage is then:
-
-     wiki-post.py --url=WIKI_REST_PATH PAGENAME FILENAME
+You can also compare revisions by using the radio buttons to select the ones to compare, then select **Compare revisions**

Wiki modified by

Fri, 12 Apr 2013 17:58:47 -0000

--- v15
+++ v16
@@ -2,7 +2,7 @@

 ## Wiki Overview

-The wiki is a collaborative document editor which is easily edited. By default any logged in user can edit your project wiki. But like most modern wiki's all edits are non-destructive -- we keep a copy of every version.
+The wiki is a collaborative document editor which is easily edited. By default any project developer can edit the project wiki. Like most modern wiki's all edits are non-destructive -- we keep a copy of every version.

 The wiki page itself has an edit button at the top right, and a discussion feature at the bottom of every page. The comment system is the same as all of the other tools in the new SourceForge system.

@@ -16,9 +16,6 @@
 ## Markdown syntax

 The wiki uses the [Markdown Syntax](http://daringfireball.net/projects/markdown/syntax) with a few notable extensions.
-
-### WikiWords 
-Words with internal capitalization automatically create page links to wiki pages. 

 ### Artifact Links

@@ -65,7 +62,7 @@

 ### Macros 

-macros can be used to call functions in the wiki, currently we have two macros `include` and `img`: 
+macros can be used to call functions in the wiki, currently we have a number of custom macros `include` and `img`: 

 - The `include` macro looks like this:  `[[include ref=PAGENAME ATTRIBUTE=VALUE ATTRIBUTE2=VALUE etc]]` which pulls in another wiki page into a div on the current page. The attribute fields are passed on to the div, so it can be given id, class, etc definitions for layout.   This is useful where you want an announcement on every wiki page, or where you want to include some consistent navigation element in on every wiki page.

WikiPage Wiki modified by

Thu, 13 Dec 2012 20:06:56 -0000

--- v14
+++ v15
@@ -1,10 +1,10 @@
 [[include ref=in-progress]]

-## wiki overview
+## Wiki Overview

-The wiki is a collaborative document editor which is easily edited.   By default any logged in user can edit your project wiki.  But like most modern wiki's all edits are non-destructive -- we keep a copy of every version.  
+The wiki is a collaborative document editor which is easily edited. By default any logged in user can edit your project wiki. But like most modern wiki's all edits are non-destructive -- we keep a copy of every version.

-The wiki page itself has an edit button at the top right, and a discussion feature at the bottom of every page.  The comment system is the same as all of the other tools in the new forge. 
+The wiki page itself has an edit button at the top right, and a discussion feature at the bottom of every page. The comment system is the same as all of the other tools in the new SourceForge system.

 Like most wiki's there's a history page allows you to view the most recent edits to the wiki, and revert to any previous version.

@@ -15,7 +15,7 @@

 ## Markdown syntax

-The wiki uses the markdown syntax (http://daringfireball.net/projects/markdown/syntax) with a few notable extensions.
+The wiki uses the [Markdown Syntax](http://daringfireball.net/projects/markdown/syntax) with a few notable extensions.

 ### WikiWords 
 Words with internal capitalization automatically create page links to wiki pages. 
@@ -24,36 +24,40 @@

 Any page existing forge resource can be linked with surrounding square brackets ie [mypage].   

-Links to resources in other tools can be explicitly referenced by adding a tool identifier prefix to the link.  So for instance `[developerwiki:MyTechnicalPage]` and `[userwiki:MySimplePage]` can refer to wiki pages in a `developerwiki` instance.  You can also link to tickets with `[tickets:123]` assuming there's a 123 ticket in a ForgeTracker instance mounted at `tickets`.   The same is true for forums, or any of the other tools you have installed.   You can even link to tickets in a subproject with `[subproject.tickets:123]`.
+Links to resources in other tools can be explicitly referenced by adding a tool identifier prefix to the link.  So for instance `[developerwiki:MyTechnicalPage]` and `[userwiki:MySimplePage]` can refer to wiki pages in a `developerwiki` instance.  You can also link to tickets with `[tickets:123]` assuming there's a 123 ticket in a ForgeTracker instance mounted at `tickets`. The same is true for forums, or any of the other tools you have installed. You can even link to tickets in a subproject with `[subproject.tickets:123]`.

 ### Code Highlighting

-The Code highlighting used in the newforge is based on (http://www.freewisdom.org/projects/python-markdown/CodeHilite). It  follows the same syntax as regular Markdown code blocks, except that there are two ways to tell the highlighter what language to use for the code block. 
+The Code highlighting used is based on [CodeHilite](http://www.freewisdom.org/projects/python-markdown/CodeHilite). It follows the same syntax as regular Markdown code blocks, except that there are two ways to tell the highlighter what language to use for the code block. 

 SheBang (with path)

 If the first line of the codeblock contains a shebang, the language is derived from that and line numbers are used.

-+~~~~
+:::text
     #!/usr/bin/python
     # Code goes here ...
-
+~~~~

 Will result in:
-- #!/usr/bin/python
- # Code goes here ...
-
+
+    #!/usr/bin/python
+    # Code goes here ...
+

 ####SheBang (no path) and triple Colon

 If the first line contains a shebang, but the shebang line does not contain a path (a single / or even a space) or If the first line begins with three or more colons, the text following the colons identifies the language. In both cases, the first line is removed from the code block before processing.

 So, for example: 
-+
+~~~~
+:::text
     :::python
     # Code goes here ...
-
+~~~~
+
 Will result in just:

     :::python

WikiPage Wiki modified by

Tue, 11 Dec 2012 21:22:35 -0000

--- v13
+++ v14
@@ -1,3 +1,5 @@
+[[include ref=in-progress]]
+
 ## wiki overview
 
 The wiki is a collaborative document editor which is easily edited.   By default any logged in user can edit your project wiki.  But like most modern wiki's all edits are non-destructive -- we keep a copy of every version.