ForgeWiki

wiki overview

The wiki is a collaborative document editor which is non-destructive, keeping versions of all changes. The history page allows you to view the most recent edits to the wiki, and revert to any previous version.

Wikis by default can be edited by any logged in user, but your (adobe) wikis have all been set so that they are developer editable only. Permissions can be modified at: http://sourceforge.net/adobe/PROJECTNAME/admin/wiki/permissions

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".

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

• any page 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 separate instances. Pages from the tickets or discussion tools can similarly be used

• macros can be used to call functions in the wiki, currently we have two:
  [-include ref=PAGENAME ATTRIBUTE=VALUE ATTRIBUTE2=VALUE etc: missing =-]

  • this includes another wiki page in a div. The attribute fields are passed on to the div, so it can be given id, class, etc definitions for layout
    
  • this embeds an attached image, or url in the page

Note that the confluence-style "|" delimited tables are not currently supported, but we expect to add that to our wiki early in next sprint.

Free-form HTML

The adobe wikis can also accept unrestricted HTML, so inline style sheets, rich media, javascript, etc can be incorporated into the sites. Gor this reason we suggest you not make your wiki pages globally editable, or we should disable this feature.

Attachments

Wiki pages can store attachments for files up to ~10M, including images.

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