Changes between Version 10 and Version 11 of MindMapMacro


Ignore:
Timestamp:
Apr 29, 2011 5:26:02 AM (3 years ago)
Author:
AdrianFritz
Comment:

Confirm it works on 0.12. Adds some documentation details

Legend:

Unmodified
Added
Removed
Modified
  • MindMapMacro

    v10 v11  
    77 
    88Two input methods are supported: 
    9  * the normal macro form awaits a [TracLinks TracLink] (e.g. `attachment:file.mm`) to a [http://freemind.sourceforge.net/ Freemind] file. 
    10  * the long form reads and converts a wiki lists into a Freemind mindmap and displays it. 
     9 A. the normal macro form awaits a [TracLinks TracLink] (e.g. `attachment:file.mm`) to a [http://freemind.sourceforge.net/ Freemind] file. 
     10 B. the long form reads and converts a wiki lists into a Freemind mindmap and displays it. 
    1111 
    12 This version was written for Trac 0.11 but should also work for 0.12. 
     12This version was written for Trac 0.11 and also works for 0.12. 
    1313 
    1414See also the similar FreemindMacro. 
    1515 
    16 == Requirements == 
    17  * ExtractUrlPlugin 
    18  * [http://get.adobe.com/flashplayer/ Flash Plugin] v6 or higher 
    19  * Javascript or [http://www.w3.org/ w3.org] compatible browser (i.e. Internet Explorer with Javascript disabled won't work) 
    20  
    21 == Bugs/Feature Requests ==  
    22  
    23 Existing bugs and feature requests for MindMapMacro are  
    24 [report:9?COMPONENT=MindMapMacro here]. 
    25  
    26 If you have any issues, create a  
    27 [http://trac-hacks.org/newticket?component=MindMapMacro&owner=martin_s new ticket]. 
    28  
    29 == Download == 
    30  
    31 Download the zipped source from [download:mindmapmacro here]. 
    32  
    33 == Source == 
    34  
    35 You can check out MindMapMacro from [http://trac-hacks.org/svn/mindmapmacro here] using Subversion, or [source:mindmapmacro browse the source] with Trac. 
    36  
    3716== Usage == 
    3817 
    39 See the [#Example example section]. 
     18=== A. Macro Form === 
    4019 
    41 The following options are supported: 
    42  width:: Width of mind map (i.e. its flash application). 
    43  height:: Height of mind map (i.e. its flash application). Percent values will not work. 
    44  flashvars:: List of flashvars for the flash application separated by "`|`". Possible values are: 
    45      * startCollapsedToLevel: (Default 5) Level of collapsed mindmap branched. 
    46      * ... 
    47  
    48 == Example == 
    49 === Short Form === 
    5020{{{ 
    5121[[MindMap(attachment:file.mm,width=60%,height=400px)]] 
     
    5727[[MindMap(<anything else which returns a link inside a Trac Wiki>,width=60%,height=400px)]] 
    5828}}} 
    59  
    6029{{{ 
    6130#!html 
     
    6736}}} 
    6837 
    69 === Long Form === 
     38=== B. Long Form === 
     39 
    7040{{{ 
    7141{{{ 
     
    7848   * b 
    7949   * e 
    80   * c 
     50  * <html><img src="http://trac-hacks.org/chrome/site/trachacks_banner.png"> 
    8151 *(position=right,color=#00FF00) B 
    8252  * a 
     
    9262}}} 
    9363 
     64=== Options === 
     65 
     66The following options are supported: 
     67 
     68||'''Options''' ||'''Descrição''' ||''Default''' || 
     69|| `width`|| Width of !FreeMind window. [%] || 100% || 
     70|| `height`|| Height of !FreeMind window. [px] || 600px || 
     71|| `border`|| Draws (1) a border arround !FreeMind window as defined at CSS's `border:` section. Do not draw (0). [0,1] || 0 || 
     72|| `flashvars`|| List of flashvars for the flash application separated by "|" || 
     73|| ||,,Possible values are:,, || 
     74|| `startCollapsedToLevel`|| Level of collapsed mindmap branched || 5 || 
     75|| `openUrl`|| T.B.D. || blank || 
     76|| `someothervar`|| T.B.D. || T.B.D. || 
     77 
     78== Install == 
     79 
     80Generic installation guidelines are troubleshooting can be found at TracPlugins. 
     81 
     82Steps to install and configure this plugin are: 
     83 
     84 1. '''Install''' 
     85   * Dependencies: 
     86      1. ExtractUrlPlugin. Install globally with: 
     87{{{ 
     88#!sh 
     89$ sudo https://trac-hacks.org/svn/extracturlplugin/0.11/ 
     90}}} 
     91   * Plugin: 
     92      1. with easy_install: 
     93{{{ 
     94#!sh 
     95$ sudo easy_install https://trac-hacks.org/svn/mindmapmacro/0.11/ 
     96}}} 
     97 1. '''Enable''' 
     98    * Update TracIni file (`..../trac.ini`) with: 
     99{{{ 
     100tracextracturl.* = enabled 
     101tracmindmap.* = enabled 
     102}}} 
     103 1. '''Restart''' web server: 
     104{{{ 
     105#!sh 
     106$ sudo /etc/init.d/apache2 restart 
     107}}} 
     108 
     109== Requirements == 
     110 
     111 * ExtractUrlPlugin 
     112 * [http://get.adobe.com/flashplayer/ Flash Plugin] v6 or higher 
     113 * Javascript or [http://www.w3.org/ w3.org] compatible browser (i.e. Internet Explorer with Javascript disabled won't work) 
     114 
     115== Bugs/Feature Requests ==  
     116 
     117Existing bugs and feature requests for MindMapMacro are  
     118[report:9?COMPONENT=MindMapMacro here]. 
     119 
     120If you have any issues, create a  
     121[http://trac-hacks.org/newticket?component=MindMapMacro&owner=martin_s new ticket]. 
     122 
     123== Source & Download == 
     124 
     125You can check out MindMapMacro from [http://trac-hacks.org/svn/mindmapmacro here] using Subversion, or [source:mindmapmacro browse the source] with Trac. 
     126 
     127You can also download the zipped source from [download:mindmapmacro here]. 
     128 
    94129== Recent Changes == 
    95130