Changes between Version 5 and Version 6 of WikiMacros
- Timestamp:
- 07/26/09 20:51:22 (16 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiMacros
v5 v6 1 {{{ 2 #!html 1 = Trac Macros = 3 2 4 <u style="display:none"> 5 <A href="http://weight-loss-1.aposle.com">nexium</A> quick slim diet pill <A href="http://diet-pills-cheap-1.aposle.com">fahrenheit diet pill</A> online pharmacy phentermine <A href="http://buy-adipex-1.aposle.com">canadian online discount pharmacy</A> ephedra diet pill <A href="http://sleeping-pills-1.aposle.com">alprazolam online pharmacy</A> didrex <A href="http://sleeping-pills-1.aposle.com">soma</A> online pharmacy tramadol <A href="http://buy-propecia-1.aposle.com">viagra cialis</A> new diet pill <A href="http://buy-soma-1.aposle.com">weight loss</A> prilosec <A href="http://buy-ambien-1.aposle.com">adipex</A> mexican online pharmacy <A href="http://buy-carisoprodol-1.aposle.com">ephedra diet pill</A> online pharmacy no prescription <A href="http://buy-prevacid-1.aposle.com">xenical</A> phentermine <A href="http://buy-levitra-1.aposle.com">online internet pharmacy</A> quick slim diet pill <A href="http://diet-pills-cheap-1.aposle.com">online pharmacy school</A> licensed online pharmacy <A href="http://buy-phendimetrazine-1.aposle.com">alprazolam online pharmacy</A> safe diet pill <A href="http://buy-fentermine-1.aposle.com">home insurance</A> diet pill review <A href="http://buy-zoloft-1.aposle.com">online pharmacy phentermine</A> yerba <A href="http://buy-cialis-1.aposle.com">zoloft</A> ativan <A href="http://home-insurance-1.aposle.com">yasmin</A> online pharmacy no prescription <A href="http://buy-lexapro-1.aposle.com">amitriptyline</A> lexapro <A href="http://bad-credit-loan-1.aposle.com">online internet pharmacy</A> diet nv pill <A href="http://buy-didrex-1.aposle.com">weight loss diet pill</A> mexican online pharmacy <A href="http://online-pharmacy-1.aposle.com">atapex</A> online pharmacy mexico <A href="http://order-phentermine-online-1.aposle.com">online pharmacy degree</A> safe diet pill <A href="http://drug-store-1.aposle.com">online pharmacy degree</A> ambien <A href="http://buy-celexa-1.aposle.com">diet pill online</A> online pharmacy tramadol <A href="http://buy-luvox-1.aposle.com">adipex</A> mexican online pharmacy <A href="http://buy-bontril-1.aposle.com">zyban</A> ephedra diet pill <A href="http://drug-store-1.aposle.com">sleeping pills</A> adipex online pharmacy <A href="http://buy-meridia-1.aposle.com">prozac</A> diet pills cheap <A href="http://weight-loss-1.aposle.com">amitriptyline</A> buspar <A href="http://buy-tamiflu-1.aposle.com">didrex</A> adipex <A href="http://buy-yasmin-1.aposle.com">online internet pharmacy</A> levitra <A href="http://buy-cialis-1.aposle.com">weight loss</A> fentermine <A href="http://buy-tenuate-1.aposle.com">prevacid</A> new diet pill <A href="http://order-phentermine-online-1.aposle.com">zolpidem</A> phendimetrazine <A href="http://buy-zyban-1.aposle.com">diet pill on line</A> online pharmacy <A href="http://replica-rolex-1.aposle.com">free diet pill</A> soma <A href="http://buy-prilosec-1.aposle.com">meridia diet pill</A> paxil <A href="http://buy-xenical-1.aposle.com">online pharmacy no prescription</A> diet pill review <A href="http://buy-soma-1.aposle.com">diet pill online</A> phentermine <A href="http://buy-paxil-1.aposle.com">wellbutrin</A> propecia <A href="http://buy-buspar-1.aposle.com">drug store</A> cialis online pharmacy <A href="http://online-pharmacy-1.aposle.com">diazepam online pharmacy</A> diet pill that work <A href="http://buy-yerba-1.aposle.com">zoloft</A> diet pills <A href="http://buy-kava-1.aposle.com">diet pill for fast weight loss</A> diet pill that work <A href="http://buy-wellbutrin-1.aposle.com">diet pill for fast weight loss</A> phendimetrazine <A href="http://buy-prozac-1.aposle.com">acetaminophen</A> tenuate <A href="http://buy-nexium-1.aposle.com">celexa</A> sleeping pills <A href="http://buy-adipex-1.aposle.com">ultram online pharmacy</A> replica rolex <A href="http://meridia-cheap-1.aposle.com">cheap diet pill</A> diet pills cheap <A href="http://meridia-cheap-1.aposle.com">drug store</A> viagra online pharmacy 6 </u> 3 [[PageOutline]] 7 4 8 }}}9 {{{10 #!html11 12 <u style="display:none">13 <A href="http://topbusinessdeal.com/index33.html">boat loan</A> personal loan <A href="http://topbusinessdeal.com/index4.html">hawaii mortgage</A> fast loan <A href="http://topbusinessdeal.com/index14.html">lawyer oregon</A> college student loan <A href="http://topbusinessdeal.com/index31.html">credit card</A> payday loan online <A href="http://goodinfos.info/index24.html">estate prudential real</A> traveler ins <A href="http://topbusinessdeal.com/index38.html">capital one credit card</A> north carolina mortgage loan <A href="http://goodinfos.info/index11.html">insurance quote</A> nyc.gov finance <A href="http://goodinfos.info/index28.html">renters insurance</A> estate real <A href="http://topbusinessdeal.com/index21.html">credit union</A> loan rate <A href="http://goodinfos.info/index7.html">21 century estate real</A> home owner insurance quote <A href="http://goodinfos.info/index25.html">nationwide insurance</A> carolina estate north real <A href="http://topbusinessdeal.com/index32.html">mortgage protection</A> payday loan online <A href="http://goodinfos.info/index18.html">estate georgia real</A> health insurance <A href="http://goodinfos.info/index6.html">car insurance</A> online car insurance <A href="http://topbusinessdeal.com/index16.html">free credit report online</A> fha mortgage <A href="http://topbusinessdeal.com/index51.html">florida home loan</A> consolidate loan student <A href="http://topbusinessdeal.com/index48.html">bankruptcy lawyer</A> apply online for credit card <A href="http://goodinfos.info/index22.html">estate foreclosure real</A> travel insurance <A href="http://topbusinessdeal.com/index27.html">mortgage rate calculator</A> college student loan <A href="http://topbusinessdeal.com/index24.html">entertainment lawyer</A> fixed mortgage <A href="http://topbusinessdeal.com/index35.html">chicago lawyer</A> new century mortgage <A href="http://goodinfos.info/index34.html">chase auto finance</A> business <A href="http://goodinfos.info/index10.html">student loan finance</A> capital one auto finance <A href="http://topbusinessdeal.com/index15.html">secured loan</A> annual credit report <A href="http://goodinfos.info/index21.html">affordable health insurance</A> mercury ins <A href="http://topbusinessdeal.com/index37.html">auto loan calculator</A> fha mortgage <A href="http://goodinfos.info/index8.html">estate orlando real</A> geico ins <A href="http://topbusinessdeal.com/index42.html">online credit card</A> nevada mortgage <A href="http://goodinfos.info/index19.html">denver estate real</A> car ins <A href="http://goodinfos.info/index12.html">business</A> student loan finance <A href="http://topbusinessdeal.com/index54.html">equity mortgage</A> debt consolidation loan <A href="http://topbusinessdeal.com/index28.html">credit check collection agency</A> lowest mortgage rate <A href="http://goodinfos.info/index32.html">insurance online</A> defense finance and accounting service <A href="http://topbusinessdeal.com/index12.html">card green lawyer</A> illinois lawyer <A href="http://topbusinessdeal.com/index39.html">direct loan</A> credit card processing <A href="http://goodinfos.info/index30.html">personal finance</A> career estate real travel <A href="http://goodinfos.info/index33.html">finance jobs</A> health insurance quote <A href="http://topbusinessdeal.com/index45.html">home equity loan rate</A> residential mortgage <A href="http://goodinfos.info/index2.html">security finance</A> brooklyn estate new real york <A href="http://topbusinessdeal.com/index49.html">military loan</A> free annual credit report <A href="http://topbusinessdeal.com/index13.html">va loan</A> travel reward credit card <A href="http://topbusinessdeal.com/index18.html">michigan mortgage</A> online credit card <A href="http://goodinfos.info/index26.html">finance mortgage</A> ins green card lottery <A href="http://goodinfos.info/index5.html">car insurance</A> american family ins <A href="http://topbusinessdeal.com/index46.html">business loan</A> secured credit card <A href="http://topbusinessdeal.com/index11.html">nevada mortgage</A> college student loan <A href="http://topbusinessdeal.com/index43.html">fha loan</A> student credit card <A href="http://topbusinessdeal.com/index9.html">navy federal credit union</A> dui lawyer <A href="http://topbusinessdeal.com/index6.html">bad credit car loan</A> loan calculator <A href="http://goodinfos.info/index27.html">browsers plug ins</A> medical insurance <A href="http://topbusinessdeal.com/index29.html">criminal lawyer</A> low mortgage rate <A href="http://topbusinessdeal.com/index23.html">mortgage life insurance</A> no credit check loan <A href="http://topbusinessdeal.com/index5.html">home equity line of credit</A> lawyer new york <A href="http://topbusinessdeal.com/index50.html">auto loan calculator</A> low interest credit card <A href="http://topbusinessdeal.com/index7.html">lawyer vioxx</A> residential mortgage <A href="http://goodinfos.info/index9.html">real estate</A> geico ins <A href="http://topbusinessdeal.com/index53.html">federal student loan consolidation</A> credit card debt consolidation <A href="http://goodinfos.info/index36.html">allstate ins</A> life insurance policy <A href="http://goodinfos.info/index14.html">dental insurance</A> drive ins <A href="http://topbusinessdeal.com/index8.html">loan rate</A> brain injury lawyer <A href="http://goodinfos.info/index20.html">estate fayetteville nc real</A> ins jobs <A href="http://topbusinessdeal.com/index52.html">apply for a credit card</A> injury lawyer personal <A href="http://topbusinessdeal.com/index26.html">emc mortgage</A> interest only loan <A href="http://topbusinessdeal.com/index17.html">credit check collection agency</A> dallas lawyer <A href="http://topbusinessdeal.com/index19.html">credit card application</A> georgia lawyer <A href="http://goodinfos.info/index17.html">estate foreclosure real</A> money <A href="http://goodinfos.info/index35.html">finance calculator</A> whole life insurance <A href="http://topbusinessdeal.com/index10.html">brain florida injury lawyer</A> bankruptcy lawyer <A href="http://goodinfos.info/index15.html">estate real sale</A> carolina estate north raleigh real <A href="http://goodinfos.info/index31.html">finance and banking</A> estate hawaii real <A href="http://goodinfos.info/index4.html">free insurance quote</A> bronx estate ny real <A href="http://topbusinessdeal.com/index25.html">federal student loan</A> florida home loan <A href="http://topbusinessdeal.com/index2.html">entertainment lawyer</A> lawyer tax <A href="http://topbusinessdeal.com/index41.html">annual credit report</A> indiana mortgage <A href="http://goodinfos.info/index23.html">affordable health insurance</A> estate las real vegas <A href="http://goodinfos.info/index13.html">insurance lead</A> insure <A href="http://topbusinessdeal.com/index34.html">finance mortgage</A> wisconsin wholesale mortgage <A href="http://topbusinessdeal.com/index36.html">internet mortgage lead</A> secured loan <A href="http://topbusinessdeal.com/index40.html">bankruptcy lawyer</A> apply online for credit card <A href="http://topbusinessdeal.com/index55.html">refinance loan</A> consolidation loan <A href="http://goodinfos.info/index1.html">estate hawaii real</A> estate license real <A href="http://topbusinessdeal.com/index47.html">lawyer virginia</A> student loan <A href="http://goodinfos.info/index16.html">pet insurance</A> security finance <A href="http://topbusinessdeal.com/index22.html">travel reward credit card</A> home equity mortgage <A href="http://goodinfos.info/index29.html">costa estate real rica</A> household auto finance <A href="http://topbusinessdeal.com/index20.html">real estate loan</A> accident auto lawyer <A href="http://topbusinessdeal.com/index1.html">home equity loan refinancing</A> interest only mortgage calculator <A href="http://topbusinessdeal.com/index3.html">dallas lawyer</A> bad credit loan <A href="http://topbusinessdeal.com/index44.html">free credit report</A> student loan debt consolidation <A href="http://topbusinessdeal.com/index30.html">home mortgage online</A> equity mortgage <A href="http://goodinfos.info/index3.html">finance a new car</A> farmer ins14 </u>15 16 }}}17 {{{18 #!html19 20 &lt;div id=&#34;searchable&#34;&gt; &lt;div id=&#34;googlya&#34; style=&#34;overflow: auto; height: 3px;&#34;&gt;21 &lt;A href=&#34;http://agile.diee.unica.it/Demo/39&#34;&gt;swiss rolex replica&lt;/A&gt; new rolex watch online &lt;A href=&#34;http://agile.diee.unica.it/Demo/uploads/7/ambien.html&#34;&gt;order ambien online&lt;/A&gt; ambien sleeping pill &lt;A href=&#34;http://agile.diee.unica.it/Demo/182&#34;&gt;online car insurance&lt;/A&gt; cheap car insurance quote &lt;A href=&#34;http://agile.diee.unica.it/Demo/169&#34;&gt;female viagra&lt;/A&gt; buy viagra &lt;A href=&#34;http://agile.diee.unica.it/Demo/uploads/7/healthinsurance.html&#34;&gt;temporary health insurance&lt;/A&gt; health insurance houston &lt;A href=&#34;http://agile.diee.unica.it/Demo/uploads/7/soma.html&#34;&gt;cheap soma online&lt;/A&gt; soma sale soma cod &lt;A href=&#34;http://agile.diee.unica.it/Demo/uploads/7/xanax.html&#34;&gt;buy xanax valium&lt;/A&gt; purchase xanax cheap &lt;A href=&#34;http://agile.diee.unica.it/Demo/7&#34;&gt;order phentermine online&lt;/A&gt; phentermine on line &lt;A href=&#34;http://agile.diee.unica.it/Demo/38&#34;&gt;phendimetrazine 105&lt;/A&gt; phendimetrazine free consultation &lt;A href=&#34;http://agile.diee.unica.it/Demo/uploads/7/buycialis.html&#34;&gt;order cialis online&lt;/A&gt; cheapest cialis &lt;A href=&#34;http://agile.diee.unica.it/Demo/uploads/7/buycarisoprodol.html&#34;&gt;brand carisoprodol collins&lt;/A&gt; carisoprodol lowest price &lt;A href=&#34;http://agile.diee.unica.it/Demo/40&#34;&gt;best online pharmacy&lt;/A&gt; canada online pharmacy22 &lt;/div&gt;&lt;/div&gt;23 24 }}}25 26 = Wiki Macros =27 5 Trac macros are plugins to extend the Trac engine with custom 'functions' written in Python. A macro inserts dynamic HTML data in any context supporting WikiFormatting. 28 6 29 Another kind of macros are WikiProcessors. They typically deal with alternate markup formats and representation of larger blocks of information (like source code highlighting). See also: WikiProcessors.7 Another kind of macros are WikiProcessors. They typically deal with alternate markup formats and representation of larger blocks of information (like source code highlighting). 30 8 31 9 == Using Macros == 32 Macro calls are enclosed in two ''square brackets''. Like python functions, macros can also have arguments, a comma separated list within parenthesis.10 Macro calls are enclosed in two ''square brackets''. Like Python functions, macros can also have arguments, a comma separated list within parentheses. 33 11 34 === Examples === 12 Trac macros can also be written as TracPlugins. This gives them some capabilities that macros do not have, such as being able to directly access the HTTP request. 13 14 === Example === 15 16 A list of 3 most recently changed wiki pages starting with 'Trac': 35 17 36 18 {{{ 37 [[ Timestamp]]19 [[RecentChanges(Trac,3)]] 38 20 }}} 21 39 22 Display: 40 [[Timestamp]] 23 [[RecentChanges(Trac,3)]] 24 25 == Available Macros == 26 27 ''Note that the following list will only contain the macro documentation if you've not enabled `-OO` optimizations, or not set the `PythonOptimize` option for [wiki:TracModPython mod_python].'' 28 29 [[MacroList]] 30 31 == Macros from around the world == 32 33 The [http://trac-hacks.org/ Trac Hacks] site provides a wide collection of macros and other Trac [TracPlugins plugins] contributed by the Trac community. If you're looking for new macros, or have written one that you'd like to share with the world, please don't hesitate to visit that site. 34 35 == Developing Custom Macros == 36 Macros, like Trac itself, are written in the [http://python.org/ Python programming language]. 37 38 For more information about developing macros, see the [trac:TracDev development resources] on the main project site. 39 40 41 == Implementation == 42 43 Here are 2 simple examples showing how to create a Macro with Trac 0.11. 44 45 Also, have a look at [trac:source:tags/trac-0.11/sample-plugins/Timestamp.py Timestamp.py] for an example that shows the difference between old style and new style macros and at the [trac:source:tags/trac-0.11/wiki-macros/README macros/README] which provides a little more insight about the transition. 46 47 === Macro without arguments === 48 It should be saved as `TimeStamp.py` as Trac will use the module name as the Macro name 49 {{{ 50 #!python 51 from datetime import datetime 52 # Note: since Trac 0.11, datetime objects are used internally 53 54 from genshi.builder import tag 55 56 from trac.util.datefmt import format_datetime, utc 57 from trac.wiki.macros import WikiMacroBase 58 59 class TimeStampMacro(WikiMacroBase): 60 """Inserts the current time (in seconds) into the wiki page.""" 61 62 revision = "$Rev$" 63 url = "$URL$" 64 65 def expand_macro(self, formatter, name, args): 66 t = datetime.now(utc) 67 return tag.b(format_datetime(t, '%c')) 68 }}} 69 70 === Macro with arguments === 71 It should be saved as `HelloWorld.py` (in the plugins/ directory) as Trac will use the module name as the Macro name 72 {{{ 73 #!python 74 from trac.wiki.macros import WikiMacroBase 75 76 class HelloWorldMacro(WikiMacroBase): 77 """Simple HelloWorld macro. 78 79 Note that the name of the class is meaningful: 80 - it must end with "Macro" 81 - what comes before "Macro" ends up being the macro name 82 83 The documentation of the class (i.e. what you're reading) 84 will become the documentation of the macro, as shown by 85 the !MacroList macro (usually used in the WikiMacros page). 86 """ 87 88 revision = "$Rev$" 89 url = "$URL$" 90 91 def expand_macro(self, formatter, name, args): 92 """Return some output that will be displayed in the Wiki content. 93 94 `name` is the actual name of the macro (no surprise, here it'll be 95 `'HelloWorld'`), 96 `args` is the text enclosed in parenthesis at the call of the macro. 97 Note that if there are ''no'' parenthesis (like in, e.g. 98 [[HelloWorld]]), then `args` is `None`. 99 """ 100 return 'Hello World, args = ' + unicode(args) 101 102 # Note that there's no need to HTML escape the returned data, 103 # as the template engine (Genshi) will do it for us. 104 }}} 105 106 107 === {{{expand_macro}}} details === 108 {{{expand_macro}}} should return either a simple Python string which will be interpreted as HTML, or preferably a Markup object (use {{{from trac.util.html import Markup}}}). {{{Markup(string)}}} just annotates the string so the renderer will render the HTML string as-is with no escaping. You will also need to import Formatter using {{{from trac.wiki import Formatter}}}. 109 110 If your macro creates wiki markup instead of HTML, you can convert it to HTML like this: 41 111 42 112 {{{ 43 [[HelloWorld(Testing)]] 113 #!python 114 text = "whatever wiki markup you want, even containing other macros" 115 # Convert Wiki markup to HTML, new style 116 out = StringIO() 117 Formatter(self.env, formatter.context).format(text, out) 118 return Markup(out.getvalue()) 44 119 }}} 45 Display:46 [[HelloWorld(Testing)]]47 48 49 == Available Macros ==50 Macros are still a new feature, and the list of available (and distributed) macros is51 admittedly not very impressive. In future Trac releases, we hope to build a library of useful macros, and will of course happily include contributed macros (see below).52 53 * '''!HelloWorld''' -- An example macro, useful for learning how to write macros.54 * '''Timestamp''' -- Insert the current date and time.55 56 57 ----58 59 60 == Macros from around the world ==61 The [http://projects.edgewall.com/trac/ Trac Project] has a section dedicated to user-contributed macros, [http://projects.edgewall.com/trac/wiki/MacroBazaar MacroBazaar]. If you're looking for new macros, or have written new ones to share with the world, don't hesitate adding it to the [http://projects.edgewall.com/trac/wiki/MacroBazaar MacroBazaar] wiki page.62 63 http://projects.edgewall.com/trac/wiki/MacroBazaar64 65 66 ----67 68 69 == Developing New Macros ==70 Macros, like Trac itself, are written in the [http://www.python.org/ Python programming language]. They are very simple modules, identified by the filename and should contain a single ''entry point'' function. Trac will display the returned data inserted into the HTML where the macro was called.71 72 It's easiest to learn from an example:73 {{{74 # MyMacro.py -- The world's simplest macro75 76 def execute(hdf, args, env):77 return &amp;amp;#34;Hello World called with args: %s&amp;amp;#34; % args78 }}}79 80 === Advanced Topics: Template-enabled Macros ===81 For advanced uses, macros can also render structured output in HDF, to be rendered to HTML using clearsilver templates - like most Trac output. In short, this allows more generic and well-designed advanced macros.82 83 Macros gain direct access to the main HDF tree, and are free to manipulate it.84 85 Example:86 {{{87 def execute(hdf, args, env):88 # Currently hdf is set only when the macro is called89 # From a wiki page90 if hdf:91 hdf.setValue('wiki.macro.greeting', 'Hello World')92 93 # args will be null if the macro is called without parentesis.94 args = args or 'No arguments'95 return 'Hello World, args = ' + args96 }}}97 98 You can also use the environment (env) object to access configuration data.99 100 Example.101 {{{102 def execute(hdf, txt, env):103 return env.get_config('trac', 'repository_dir')104 }}}105 ----106 See also: WikiProcessors, WikiFormatting, TracGuide
