Sphene Community Tools

Community

Copyright © 2007-2009 by Herbert Poul
You are not logged in.
Login
Register

Change Language:



AddThis Social Bookmark Button

A Django site.

Powered by Sphene Community Tools

Wiki

Wiki

Back to Snip <-- Previous Change | Next Change -->

Diff Summary
Title
Date 2007-04-14 19:19:46 2007-04-14 21:39:03
Editor Herbert Poul Herbert Poul
Tags

2007-04-14 19:19:46 by Herbert Poul
2007-04-14 21:39:03 by Herbert Poul
n1Most things you see on this website is powered by n1Most things you see on this website is powered by 
>this "Wiki" >this [Wiki] - See WikiDocumentation on how to use 
 >it.
22
n3Actually, it has not the full functionality of a wn
>iki yet - much is missing, like versioning.  
43
5# Features4# Features
65
7- Edit posts on the fly - Permission who can edit 6- Edit posts on the fly - Permission who can edit 
>posts can be customized on a per-snip basis which >posts can be customized on a per-snip basis which 
>are inherited by all snips below it (e.g. a snip W>are inherited by all snips below it (e.g. a snip W
>iki/Documentation will inherit the permissions fro>iki/Documentation will inherit the permissions fro
>m Wiki if it doesn't have any permission settings >m Wiki if it doesn't have any permission settings 
>on it's own.)>on it's own.)
8- Use [Markdown](http://daringfireball.net/project7- Use [Markdown](http://daringfireball.net/project
>s/markdown/) in your code - Powered by [John Grube>s/markdown/) in your code - Powered by [John Grube
>r's Markdown implementation](http://www.freewisdom>r's Markdown implementation](http://www.freewisdom
>.org/projects/python-markdown/)>.org/projects/python-markdown/)
15- [Community] - and all it's dependencies14- [Community] - and all it's dependencies
1615
17# Documentation16# Documentation
1817
19- Learn Wiki markup by playing in the [Sandbox]18- Learn Wiki markup by playing in the [Sandbox]
t20 t19- See WikiDocumentation for more information
21## Syntax
22
23The Wiki uses Markdown as it's markup language. Pl
>ease see http://daringfireball.net/projects/markdo 
>wn/ for information about the syntax.  
24
25## Wiki Links
26
27To link to other wiki pages you can use one of two
> linking techniques:  
28
29- CamelCase - simply write two ore more uppercase 
>letters in a word and it will transform into a lin 
>k. - If you don't want that to happen you can esca 
>pe it with \ .. like: \\CamelCase (the \ will of c 
>ourse not appear in the output: \CamelCase)  
30- enclose any word in [ ] brackets. e.g.: [link ] 
>(without any spaces in it) and it will transform i 
>nto a link.  
31
32## Macros
33
34Macros are a SCT extension to the Markdown languag
>e. Their basic syntax is:   
35
36    {macroname parameter=value}
37
38There is currently no public interface to add 3rd 
>party macros.. but i'm planning on implementing on 
>e.  
39
40The currently available macros are documented here
>:  
41
42### News Macro
43
44The news macro allows you to display threads of a 
>given board category. A simple usage looks like th 
>is:  
45
46    {news category=7 baseURL=/board limit=5} 
47
48This would display the latest 5 threads in the boa
>rd category of the id '7'.  
49
50#### Parameters
51
52The news macro supports the following parameters:
53
54- Category (required): The Id of the Board categor
>y (as displayed in the URL to this board category) 
>  
55- baseURL (required): The URL at which the board i
>s located. (This parameter might get obsolete pret 
>ty soon since there is now a way to automatically  
>resolve a configured URL)  
56- limit: The number of threads to list (default: 5
>)  
57- templateName: The name of a django template to b
>e used for rendering. (default: wiki/news.html  
58
59#### Template
60
61The News Macro requires a simple template (given b
>y the parameter 'templateName' which is by default 
> wiki/news.html)  
62
63An example template might look like this:
64
65    {% load sph_extras %}
66    
67    <ul class="news">
68      {% for thread in threads %}
69        <li>
70          <div class="subject">{{ thread.postdate|
>sph_date }}: {{ thread.subject }}</div>  
71          <div class="body">{{ thread.body_escaped
> }}</div>  
72          {% if baseURL %}
73            <div class="comments"><a href="{{ base
>URL }}/thread/{{ thread.id }}/">{{ thread.replyCou 
>nt }} Comments</a></div>  
74          {% endif %}
75        </li>
76      {% endfor %}
77    </ul>
78
79### Include Macro
80
81Allows the inclusion of an external URL into a wik
>i snip. The file included is also rendered using M 
>arkdown !  
82
83Example Usage:
84
85    {include url=http://yourhell.com/svn/root/djan
>go/communitytools/trunk/README start=Directories e 
>nd=Examples}  
86
87The example would include content from the file fr
>om the given url starting with a line containing ' 
>Directories' until a line containing the content ' 
>Examples'.  
88
89#### Parameters
90
91- url (required): The URL to the file to include
92- start (optional): Some value which is used to de
>termine at which position in the file to start the 
> inclusion. (The line containing the given word wi 
>ll not be included)  
93- end (optional): Some value which is used to dete
>rmine at which position to stop the inclusion.  
94
95
96### Image Macro
97
98Administrators can add attachments to wiki snips. 
>The Image macro allows to add such attachments as  
>images into the wiki snip.  
99
100Example Usage:
101
102    {image: id=123}
103
104The example would include the image with the attac
>hment Id 123. (The attachment Id is displayed in t 
>he list of attachments)  
105
106#### Parameters
107
108- id (required): Id of the attachment
109- img tag parameters: width, height, alt, align wh
>ich are taken 1:1 as HTML parameters.  
110


Powered by Sphene Community Tools