VoodooPad: Trigger Examples

Version: 14

Make sure to check out the new wiki located at http://flyingmeat.com/wikka/. This one will eventually be retired.

Trigger Examples

A trigger that creates a new page based on the current date when a document opens

-- assign this to the "Document did open" event.
pageName = os.date("%Y.%m.%d", os.time())
triggerDictionary.document:openPageWithTitle(pageName)

A simple trigger that you could use to modify the default text on a new page

-- assign this to the "Page created" event
newPage = triggerDictionary.item
-- check and see if we are dealing with a regular page type.
-- if it's not a regular page type, then bail out on this trigger.
if (newPage:type() ~= VPPageType) then
    return
end
 
-- we grab the contents of the page
attributedString = newPage:dataAsAttributedString()
 
-- using objc_mutableString() insteadof mutableString() will return an objective-c object which we can then
-- call a function on, instead of a lua string.
attributedString:objc_mutableString():appendString("\nThis is an addition to the new page text.")
attributedString:objc_mutableString():appendString("\nThis new page's name is '" .. newPage:displayName() .. "'")
 
-- and now we set the value in the new page.
newPage:setDataAsAttributedString(attributedString)

A WebServer trigger example:

-- assign this to the "Web server will send page" event
 
-- check and see if we are dealing with a regular page type.
-- if it's not a regular page type, then return.
if (triggerDictionary.item:type() ~= VPPageType) then
    return
end
 
-- grab what's going to be sent out to the browser (this is the raw html)
output = triggerDictionary.output
 
-- look for the key $lookingFor$ , and replace it with the string "replaceValue"
-- notice that we assign the value back to the trigger dictionary.  This way, VoodooPad
-- gets the updated value.
triggerDictionary.output = output:replace("$lookingFor$", "replaceValue")

A Trigger to update a page listing all the pages in the document:

-- assign this to the "Page Deleted" and "Page Created" events.
-- the index is created in a page named "Page Index"
indexPageName = "Page Index"
document = triggerDictionary.document
list = "All the pages in this document:\n"
for key in objc.values(document:keys()) do
    page = document:pageForKey(key)
    list = list .. page:displayName() .. "\n"
end
document:createNewPageWithName(indexPageName) -- noop if it's already around.
pageData = document:pageForKey(indexPageName)
attributedString = pageData:dataAsAttributedString()
attributedString:objc_mutableString():setString(list)
pageData:setDataAsAttributedString(attributedString)

Replace the template placeholder $clipboard$ with the text on the clipboard:

-- assign this to the "Page created" event
newPage = triggerDictionary.item
-- check and see if we are dealing with a regular page type.
-- if it's not a regular page type, then bail out on this trigger.
if (newPage:type() ~= VPPageType) then
    return
end
-- we grab the contents of the page
attributedString = newPage:dataAsAttributedString()
-- grab the clipboard
p = objc.class("NSPasteboard"):generalPasteboard()
t = p:stringForType("NSStringPboardType")
range = objc.luaToNSRange({location=0, length=attributedString:objc_mutableString():length()})
if (t ~= nil) then
    count = attributedString:objc_mutableString():replaceOccurrencesOfString_withString_options_range_("$clipboard$", t, 0, range)
else
    -- otherwise just make the $clipboard$ placeholder an empty string
    attributedString:objc_mutableString():replaceOccurrencesOfString_withString_options_range_("$clipboard$", "", 0, range)
end
-- and now we set the value in the new page.
newPage:setDataAsAttributedString(attributedString)