Changes between Version 7 and Version 8 of FlexibleWikiPlugin

Timestamp:

May 2, 2009, 7:37:59 AM (15 years ago)

Author:

Alexey Kinyov

Comment:

more detailed description and examples

FlexibleWikiPlugin

@@ -23 +23 @@
 == Example ==
 
+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:
+ * !DevGuide
+   * !DevGuide/Resources
+   * !DevGuide/Plugins
+ * etc.
+
+So, page name is 'coupled' with structure - if you want to change structure, you should change page name or even name of many pages.
+
+This plugin allows to structure pages idependent on their names. So, structure could be:
+
+ * !DevGuide
+   * !AddingResources
+   * !AddingPlugins
+ * etc.
+
+In this example pages !AddingResources and !AddingPlugins has parent !DevGuide. So, if you want restructure pages, you should change 'parent' for page or some pages, and their address remain unchanged.
+
+When this plugin installed horozontal navigation bar on top of each wiki page is displayed. So, when you watch page !AddingPlugins, navigation bar will be: {{{ WikiStart / DevGuide / AddingPlugins }}}. !WikiStart is always at start of navitation bar.
+
+For displaying navigation in 'tree' manner, special macro is provided, see details below.
+
 After installing plugin you will need to '''upgrade''' your environment.
 
-You will get an extra item ''New page'' in mainnav, which opens page creation dialog. You can set up ''title'' and ''name'', and ''parent'' is set up automatically by current page. Thus, you can create 'sub-pages' for any page.
+'''Note changes:''' 
 
-Each page now has extra properties:
+ * 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:'''
   
- * '''title''': string, just page title, appears in menu and on each of pages
+ * '''title''': string, just page title, automatically displayed on top of page and in navigation
  * '''parent''': name of parent wiki page or empty if none
  * '''weight''': number, defines page ordering in menu
  * '''hide''': flag, if set, page won't appear in menu generated by ![[TracFlexWikiTree]]
-
-They can be changed in page edit dialog.
 
 === Additional macros ===
@@ -50 +72 @@
 [[TracFlexWikiTree(class=flex-menu)]]
 }}}
+
+For now, plugin does not generate initial structure data. So, for existring pages structure data is not provided. That means, they are not displayed in {{{TracFlexWikiTree}}} until you edit and save them.
 
 === Screenshot ===