Changes between Version 12 and Version 13 of FlexibleWikiPlugin

Timestamp:

Apr 5, 2010, 10:09:29 PM (14 years ago)

Author:

Alexey Kinyov

Comment:

--

FlexibleWikiPlugin

@@ -9 +9 @@
 '''Yet, it is in working state at the moment! Tested with version 0.11.7.'''
 
-
-== Description ==
+== Overview ==
 
 Plugin allows one to make flexible structure of wiki pages. Parent pages can be set up for any wiki page, so we get flexible structure instead of 'plain' wiki structure. 
-
-== Bugs/Feature Requests == 
-
-Existing bugs and feature requests for FlexibleWikiPlugin are 
-[report:9?COMPONENT=FlexibleWikiPlugin here].
-
-If you have any issues, create a 
-[http://trac-hacks.org/newticket?component=FlexibleWikiPlugin&owner=rudyryk new ticket].
 
 == Download ==
@@ -30 +21 @@
 You can check out FlexibleWikiPlugin from [http://trac-hacks.org/svn/flexiblewikiplugin here] using Subversion, or [source:flexiblewikiplugin browse the source] with Trac.
 
-== Example ==
+== Description ==
 
 For example, if you want to structure pages on your wiki and use 'native' Trac approach, you should name you pages in a specific manner:
@@ -53 +44 @@
 For displaying navigation in 'tree' manner, special macro is provided, see details below.
 
-After installing plugin you will need to '''upgrade''' your environment.
+== Installation ==
 
-'''Note changes:''' 
+ 1. install plugin as any other Trac plugin ([http://trac.edgewall.org/wiki/TracPlugins#InstallingaTracPlugin how to?])
+ 2. '''upgrade''' your environment ([http://trac.edgewall.org/wiki/TracUpgrade#UpgradetheTracEnvironment how to?])
+ 3. note changes:
+     * you should see '''New page''' button in main menu, if you see it, then plugin is active and working
+     * you will also see extra fields in page edit dialog, see below
+ 4. incorporate wiki macros ![[TracFlexWikiTree]] and ![[TracFlexWikiChildren]] somewhere in your template or just use them in your pages, there's no sidebar in default Trac templates, so you need manually customize template, see example.
 
- * you will get an extra item ''New page'' in mainnav, which opens page creation dialog
- * in edit page dialog you will see new fields: ''title'', ''parent'', ''weight'', ''hide''
-
-'''Extra page properties description:'''
+'''Extra page properties:'''
   
  * '''title''': string, just page title, automatically displayed on top of page and in navigation
@@ -66 +59 @@
  * '''weight''': number, defines page ordering in menu
  * '''hide''': flag, if set, page won't appear in menu generated by ![[TracFlexWikiTree]]
+
+'''Template example'''
+
+Here's quick demonstration example with ![[TracFlexWikiTree]] macro in left sidebar: see in attachment [attachment:site.html].
 
 === Additional macros ===
@@ -94 +91 @@
 Menu in left sidebar is provided by macro {{{[[TracFlexWikiTree]]}}}. It's added globally in site templates, this plugin doesn't do this automatically.
 
+== Bugs/Feature Requests == 
+
+Existing bugs and feature requests for FlexibleWikiPlugin are 
+[report:9?COMPONENT=FlexibleWikiPlugin here].
+
+If you have any issues, create a 
+[http://trac-hacks.org/newticket?component=FlexibleWikiPlugin&owner=rudyryk new ticket].
+
 === Further development ===