Menu
▾
▴
[Staticwiki-svn-commit] SF.net SVN: staticwiki: [34] trunk
|
From: <tri...@us...> - 2007-10-19 14:13:31
|
Revision: 34
http://staticwiki.svn.sourceforge.net/staticwiki/?rev=34&view=rev
Author: triathlon98
Date: 2007-10-19 07:13:28 -0700 (Fri, 19 Oct 2007)
Log Message:
-----------
documentation
Modified Paths:
--------------
trunk/src/site/site.xml
trunk/src/site/wiki/developers.wiki
trunk/src/site/wiki/index.wiki
trunk/src/site/wiki/markup.wiki
trunk/src/site/wiki/usage.wiki
Added Paths:
-----------
trunk/src/site/resources/images/smiley.gif
trunk/src/site/wiki/roadmap.wiki
trunk/staticwiki-renderer/src/main/macro/org/staticwiki/wiki/macro/panel.properties
trunk/staticwiki-renderer/src/main/macro/org/staticwiki/wiki/template/panel.vm
Added: trunk/src/site/resources/images/smiley.gif
===================================================================
(Binary files differ)
Property changes on: trunk/src/site/resources/images/smiley.gif
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Modified: trunk/src/site/site.xml
===================================================================
--- trunk/src/site/site.xml 2007-10-19 13:48:52 UTC (rev 33)
+++ trunk/src/site/site.xml 2007-10-19 14:13:28 UTC (rev 34)
@@ -24,6 +24,8 @@
<item name="Introduction" href="index.html"/>
<item name="Usage" href="usage.html"/>
<item name="Markup" href="markup.html"/>
+ <item name="Development" href="developers.html"/>
+ <item name="Roadmap" href="roadmap.html"/>
</menu>
<menu ref="modules"/>
Modified: trunk/src/site/wiki/developers.wiki
===================================================================
--- trunk/src/site/wiki/developers.wiki 2007-10-19 13:48:52 UTC (rev 33)
+++ trunk/src/site/wiki/developers.wiki 2007-10-19 14:13:28 UTC (rev 34)
@@ -10,4 +10,57 @@
{code}
The first (install) will build all modules, including the staticwiki-site-plugin.
-The second target disables the staticwiki-site-plugin as module, but enables it as library for the [maven-site-plugin|http://maven.apache.org/plugins/maven-site-plugin/]. This way, circular dependencies are avoided.
\ No newline at end of file
+The second target disables the staticwiki-site-plugin as module, but enables it as library for the [maven-site-plugin|http://maven.apache.org/plugins/maven-site-plugin/]. This way, circular dependencies are avoided.
+
+h2. Coding style
+
+In staticwiki we use a coding style which prefers easy reading above displaying a lot of information. Most of the features should be clear in the following piece of code.
+{code}
+@Annotation( param1 = "value1", param2 = "value2" )
+public class Foo
+{
+ int[] X = new int[] { 1, 3, 5, 6, 7, 87, 1213, 2 };
+
+ public void foo( int x, int y )
+ {
+ for ( int i = 0; i < x ; i++ )
+ {
+ y += ( y ^ 0x123 ) << 2;
+ }
+ do
+ {
+ try
+ {
+ if ( 0 < x && x < 10 )
+ {
+ while ( x != y )
+ {
+ x = f( x * 3 + 5 );
+ }
+ }
+ else
+ {
+ synchronized ( this )
+ {
+ switch ( e.getCode() )
+ {
+ //...
+ }
+ }
+ }
+ }
+ catch ( MyException e )
+ {}
+ finally
+ {
+ int[] arr = (int[]) g( y );
+ x = y >= 0 ? arr[ y ] : -1;
+ }
+ }
+ while ( true );
+ }
+}
+{code}
+The code is written with the right margin at 120 characters and lines should not be longer than that if possible.
+An indentation is 4 spaces, tabs should not be used.
+Class, method and variable names should follow the standard java naming convention.
Modified: trunk/src/site/wiki/index.wiki
===================================================================
--- trunk/src/site/wiki/index.wiki 2007-10-19 13:48:52 UTC (rev 33)
+++ trunk/src/site/wiki/index.wiki 2007-10-19 14:13:28 UTC (rev 34)
@@ -1,7 +1,3 @@
-----
-*warning* this is highly preliminary information, the project (and especially the documentation) is in a very preliminary fase and will be improved soon. So do have a browse around, but definitely come back later to see how things evolve.
-----
-
h1. staticwiki
staticwiki is a configurable java wiki renderer. he rendering is done in several passes to allow a lot of versatility.
Modified: trunk/src/site/wiki/markup.wiki
===================================================================
--- trunk/src/site/wiki/markup.wiki 2007-10-19 13:48:52 UTC (rev 33)
+++ trunk/src/site/wiki/markup.wiki 2007-10-19 14:13:28 UTC (rev 34)
@@ -1,3 +1,100 @@
h1. staticwiki default markup
-
\ No newline at end of file
+The basis is normal text can be displayed with simple markup. It should be really straightforward for the user to include simple markup.
+You can just type all the data you want to include, and the content will be split up in paragraphs automatically.
+The basic method for this, is that an empty line is used as paragraph seperator. A newline is interpreted as a line break.
+
+Some emphasis can be given to words to surrounding the words using certain characters.
+TO make this work, the begin and end markup should be on the same line, there should be a character or digit next to the begin and just before the end markup, and no character or digit before the begin markup and after the end markup.
+
+{code}
+Use _ to _put and excerpt_ in italics (emphasis).
+Use * to *make an excerpt* bold.
+Use ?? to ??make an excerpt?? a citation.
+Use - to -display an excerpt- with strikethrough.
+Use + to +make an excerpt+ underlined.
+Use ^ to ^display an excerpt^ in superscript.
+Use ~ to ~display an excerpt~ in subscript.
+Use % to *make an excerpt* bold.
+{code}
+
+Which should display as
+
+{panel}
+Use _ to _put and excerpt_ in italics (emphasis).
+Use * to *make an excerpt* bold.
+Use ?? to ??make an excerpt?? a citation.
+Use - to -display an excerpt- with strikethrough.
+Use + to +make an excerpt+ underlined.
+Use ^ to ^display an excerpt^ in superscript.
+Use ~ to ~display an excerpt~ in subscript.
+Use % to *make an excerpt* bold.
+{panel}
+
+Headers can easily be handled by adding the "h1. ", "h2. " etc (up to "h6. ") at the beginning of the line.
+
+{code}
+h1. Big header
+It is easy to add several header types
+h2. Smaller header
+Like the two above.
+{code}
+
+{panel}
+h1. Big header
+It is easy to add several header types
+h2. Smaller header
+Like the two above.
+{panel}
+
+You can also have lists of items, a quoted line or a rule.
+
+{code}
+List are also possible
+- Bulleted item
+-- with indentation
+- or not
+-----
+bq. And a quote below the rule
+{code}
+
+{panel}
+List are also possible
+- Bulleted item
+-- with indentation
+- or not
+-----
+bq. And a quote below the rule
+{panel}
+
+You can also include links and images, and of course the system assures you can not emit invalid html. To assure some character sequences are not interpreterd as markup, you can escape stuff.
+
+{code}
+Links need to be [enclosed in brackets|http://www.equanda.org/] to be clickable. You can also include media using exclamation marks !smiley.gif!, possibly with alternate description !flying smiley|smiley.gif!.
+You cannot include a <img src="images/smiley.gif"> directly, as this is \*not\* allowed in html.
+{code}
+
+{panel}
+Links need to be [enclosed in brackets|http://www.equanda.org/] to be clickable. You can also include media using exclamation marks !images/smiley.gif!, possibly with alternate description !flying smiley|images/smiley.gif!.
+You cannot include a <img src="images/smiley.gif"> directly, as this is \*not\* allowed in html.
+{panel}
+
+There is also a list of macro's which can be used. Macro's have a name and can include parameters. The use the \{name:par1=val1|par2=val2\} syntax.
+
+{code}
+The available macro's are
+{private}To hide some content from the output.{private}
+{nowiki}Have some stuff which is not wiki rendered{nowiki}
+{quote}Include some quoted text{quote}
+\{code}Include some code\{code}
+{panel}A simple panel{panel}
+{code}
+
+{panel}
+The available macro's are
+{private}To hide some content from the output.{private}
+{nowiki}Have some stuff which is not wiki rendered{nowiki}
+{quote}Include some quoted text{quote}
+{code}Include some code{code}
+{panel}A simple panel{panel}
+{panel}
Added: trunk/src/site/wiki/roadmap.wiki
===================================================================
--- trunk/src/site/wiki/roadmap.wiki (rev 0)
+++ trunk/src/site/wiki/roadmap.wiki 2007-10-19 14:13:28 UTC (rev 34)
@@ -0,0 +1,22 @@
+h1. Roadmap
+
+staticwiki is realeased at version 0.8 because we wanted to have a useable version easily available (without need to compile source code or dependecies on snapshots).
+However, we are still missing some things we need to add before we can call it version 1.0
+- Improve markup (make it more complete)
+-- headers should emit the content table at the end. This can then either be hiiden, or moved to the top in CSS.
+-- bullet handling is very bad, it is just a temporary solution and needs work
+-- need counted list bullets (using #) and star bullets (using *)
+-- table support (simple using "|" and full using macro's)
+-- improve panel macro to allow a title etc.
+-- add many more macro's, like color, panel, comment, font etc
+-- support for emoticons, simple arrows
+-- auto recognize some markup (like anything starting with "http://", "www.", "email:") and convert to better info.
+- Improve the site plugin
+-- The links handling should be improved, there should be no need to have explicit links in all cases.
+- Improve the editor
+-- allow load/save
+-- allow save as PDF
+-- maybe some project support to automatically handle the links
+
+Other features/improvements may also be included.
+For details and the current status, check the [staticwiki JIRA pages|http://jira.equanda.org/browse/SW/].
\ No newline at end of file
Modified: trunk/src/site/wiki/usage.wiki
===================================================================
--- trunk/src/site/wiki/usage.wiki 2007-10-19 13:48:52 UTC (rev 33)
+++ trunk/src/site/wiki/usage.wiki 2007-10-19 14:13:28 UTC (rev 34)
@@ -47,4 +47,8 @@
{code}
WikiRenderer wikiRenderer = WikiFactory.getWikiRenderer( new AllowAllResourceHandler() );
wikiRenderer.render( wikiText );
-{code}
\ No newline at end of file
+{code}
+
+In many cases, it is important to change how links and resources are handled. In that case you should get the wiki renderer with a proper {code}ResourceHandler{code} implementation.
+
+h2. Customizing the output
\ No newline at end of file
Added: trunk/staticwiki-renderer/src/main/macro/org/staticwiki/wiki/macro/panel.properties
===================================================================
--- trunk/staticwiki-renderer/src/main/macro/org/staticwiki/wiki/macro/panel.properties (rev 0)
+++ trunk/staticwiki-renderer/src/main/macro/org/staticwiki/wiki/macro/panel.properties 2007-10-19 14:13:28 UTC (rev 34)
@@ -0,0 +1,2 @@
+hasBody=true
+template=quote
Added: trunk/staticwiki-renderer/src/main/macro/org/staticwiki/wiki/template/panel.vm
===================================================================
--- trunk/staticwiki-renderer/src/main/macro/org/staticwiki/wiki/template/panel.vm (rev 0)
+++ trunk/staticwiki-renderer/src/main/macro/org/staticwiki/wiki/template/panel.vm 2007-10-19 14:13:28 UTC (rev 34)
@@ -0,0 +1 @@
+<div class="panel">$context.render($macro)</div>
\ No newline at end of file
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
