NiKKi /Doc /Macros /RtMacroList

Top
Up
Contents
RecentChanges
Attachment
Backlinks
Print
Show Page
ViewSource
Login
User:38.103.63.18
(anonymous)
3447 hits since Sun Jun 2 19:15:25 2002

<RtMacroList>

 
<RtMacroList> 

Builtin rtMacros

ActionListno doc
Adminno doc
AttachmentImg** <<AttachmentImg(imgname, [pagename,center,option])>>

- imgname : name of attached image file
- pagename (option) : name of page the image is attached (default=current page)
relative path o.k.
- center : 1 (centered=default)
- option : option string for <img src= > tag
Create <img src= > link.
AttachmentInclude** <AttachmentInclude(fname, [label,pagename])>

- fname : attached file name
- label : label default = fname
- pagename (optional) : page where the file is attached. default=current page
Include attached file as <pre>.
AttachmentLink** <<AttachmentLink(fname, [label,pagename])>>

- fname : attached file name
- label : link label default = fname
- pagename (optional) : page where the file is attached. default=current page
Creates links to the attached file.
AttachmentList** <<AttachmentList([pagename,size,date,header])>>

- pagename : name of the page whose attachments to be listed
- size : default=1, whether to show size of the files
- date : default=1 shows date, =0 does not show date
- header : default=1, whether to show header
Create a table listing attached files.
AttachmentPhotos** <<AttachmentPhotos([border,name,comment,size,date,ncol,colwidth,pagename])>>

- border : (default=0) table border size
- name : show name (=1,default) hide name(=0)
- comment : show (1, default), hide (0)
- size : show (1, default), hide(0)
- date : show date (1 default), hide date (0)
- ncol : number of columns (default=5)
- colwidth : width of column (default=120)
- pagename : target page

Create table of thumbnails.
AttachmentThumb** <<AttachmentThumbnail(imagename,[pagename,center,option])>>

- imagename : name of attached imagefile
- pagename : name of page where the imagefile is attached
- center : =1 (default) center the image, =0 no centering
- option : option string for <img src=...> tag (default='')
Shows thumbnail and link to the original.
Dateno doc
DateTimeno doc
GoTo** <<GoTo>>

Shows a form to specify pagename to jump to.
ISBNAmazonJpLinkno doc
ISBNAmazonLinkno doc
Icon** <<Icon(filename)>>

- filename : file in root attachment
Create <img src= > link. For MoinMoin compatibility.
Include<Include(pagename)>

- pagename : name of included page
PageCount** <<PageCount>>

Returns number of pages under this page.
PageList<h2><PageList(regex ,basepagename, depth)></h2>
<ul>
<li> page_regex : regular expression for page title
<li> base_pagename : descendants of base_pagename are the targets
List pages which match the page_regex pattern, if page_regex is omitted
all pages under current page are listed.
<li> depth : max depth to list (default 10)
</ul>
PageListings<h2><PageList(regex ,basepagename, depth)></h2>
<ul>
<li> page_regex : regular expression for page title
<li> base_pagename : descendants of base_pagename are the targets
List pages which match the page_regex pattern, if page_regex is omitted
all pages under current page are listed.
<li> depth : max depth to list (default 10)
</ul>
RtMacroListLists installed run-time macros and their doc strings.
StMacroListLists installed save-time macros and their doc strings
SystemInfo** <<SystemInfo>>

Basic Nikki system information.
Timeno doc
TitleIndex** <<TitleIndex>>

List page titles under current page.
TitleSearch** <<TitleSearch>>

Shows input box for title search
ToDoListno doc
WordIndex** <<WordIndex>>

List words from page titles.

Plugin rtMacros

AmazonJpLink** <<AmazonJpLink(id, [label])>>
AmazonLink** <<AmazonLink(isbn, [label])>>
CalendarMonth<CalendarMonth([year,month ,color,gatherevents? ,eventsdir ,eventpattern,
width, colwidth])>

- year = calendar year (default current)<br>
- month = calendar month (default current)<br>
- gatherevents = 1:(default) collect events from log pages, 0:only shows links to log
pages<br>
- eventsdir = directory which contains log pages (default '../' parent dir)<br>
- eventpattern = regular expression specifing events<br>
(default: '^\s\[x|_|n|\*|(\d\d:\d\d)|(\d{1,2}(am|pm))\](.*)$']')
- tableopt : option for table (default : 'border=1 width=98% cellpadding=2 cellspacing=1')<br>
- colwidth: table column width (default 14%)<br>

Create monthly calendar. Gathers events from log pages (= yyyy-mm-dd )
CalendarWeeks** <<CalendarWeeks([startdate,enddate,weekend,eventsdir,eventpattern])>>

- startdate: (default: today)
- enddate: (default: today + 3 months)
- weekend: 1: show (default) , 0: hide
- eventsdir:'../', parent dir=current dir
- eventpattern:

Date format is yyyy-mm-dd.

CalendarYear** <<CalendarYear(year,eventsdir)>>

- year :
- eventsdir :
- tableopt1:border=0 cellpadding=10 cellspacing=0 width=100%
- tableopt2:border=1 cellpadding=2 cellspacing=1>
- colors: comma separated

DatabaseTable** <<DatabaseTabel([pageregex,dir,reverse])>>

- pageregex : default '.*'
- dir : default '' -> children, (../: siblings) ...
- reverse : default 1
- renderfield: default 1, render field text
- tableopt':'border=1 cellpadding=2 cellspacing=0 width=100%',
- headeropt':'bgcolor=#CCFABB',
- rowopt':'',
- itemopt':'',
- showpagename':'1',
- showfields' :'',
- renderfield':'1',

DirectoryListings<h3><DirectoryListings([pagename,depth])></h3>
<ul>
<li> pagename : base pagename
<li> depth : how deep?, (default inf)
</ul>

Directory = pages that have children

ExtractSections** <<ExtractSections(regex, section, dir, reverse)>>

- regex : page regex to specify target pages (default all pages)
- section : target section name in a page
- dir : target directory, default '' (search children)
- reverse : default 1, (page sorting)

FullSearchno doc
GanttTableno doc
OutlineTable** <<OutlineTable( outline text )>>
PubMedLink** <<PubMedLink(id, [label])>>
RecordTableno doc
TabTable** <<TabTable( tab separated table data )>>

- tableopt: table option
- rowopt:
- colopt:
- caption:

TableOfContentsno doc
TodoList** <<TodoList(todopage,section,mode,date)>>
- todopage : default=YYYY-ToDo
- section : default= '' (all)
- mode: 0=todo, 1=done, 2=both (default)
- todo: list items with corresponding date, expired, undated
- done: list items with corresponding date
- date : default from pagename

action/todolist : check off item