Flying Meat's Wiki.2005-06-24T14:55:33ZFlying Meat Inc. and Friends of Flying Meaturn:uuid:547f7640-0089-44d0-a983-c2933b9c30dfVoodooPad: Start Pageurn:uuid:353ec59a-c72a-01d9-1c37-c0cbe4c4b920:832007-12-16T17:22:51Z2005-05-17T16:20:08Zh2. VoodooPad 3.0
* <b>VoodooPad Tutorial</b>: A gentle ~introduction to what VoodooPad is all about.
* <b>Glossary</b>: Terms you might want to learn to get around in VoodooPad.
* <b>Script Plugins</b>: Learn how to extend VoodooPad with simple scripts.
* <b>Lua Plugin Snippets</b>: Lots of examples of useful scripts.
* <b>AppleScript</b>: Learn how to automate VoodooPad with Apple's scripting language.
* <b>Aliases</b>: Make words or phrases link to another page.
* <b>Encryption in VoodooPad</b>: Hide your data from prying eyes.
* <b>How to register VoodooPad</b>: You bought it- now how do you stop the nagging?
* <b>Page Templates</b>: Customize the look of new pages.
* <b>Web Export</b>: Flexible exporting of your documents as HTML
* <b>Categories</b>: Organize pages in VoodooPad document according to topics
* <b>Tips</b>: Random bits of info.
* <b>Plugins</b>: Add functionality to VoodooPad via a downloadable plugin.
* <b>Linking, Pasting, and Embedding Files</b>: How does some stuff (like images) get in there anyway?
* <b>Hidden Preferences</b>: Change certain behaviors of VoodooPad
* <b>Data Sent to Flying Meat</b>: Find out what bits of information is sent to the mothership.
* <b>Old Versions</b>: Need to grab a previous version of VoodooPad?
h2. VoodooPad Pro
* <b>Triggers</b>: Script VoodooPad during specific events.
* <b>Web Server</b>: Share pages of your document to friends and co-workers.
* <b>Page Meta</b>: Customizable attributes for pages.
h3. Online
* "VoodooPad's mailing list / Yahoo! group":http://groups.yahoo.com/group/voodoopad/
Talk with and receive information from VoodooPad users around the world.
* "The official website":http://flyingmeat.com/voodoopad/
h3. Version information:
* New in 3.5
* New in 3.2
* New in 3.1
* New in 3.0
* New in 2.5
* New in 2.1
* New in 2.0
* "List of all pages":/fs/flystashweb.cgi?allPages=1&space=353ec59a-c72a-01d9-0eb2-c0cbe4c48523VoodooPad: New in 3.5urn:uuid:2dc35f78-ac3e-01dc-01d4-c0cbe4c4bd91:32007-12-16T17:22:39Z2007-12-16T17:19:57Zh2. VoodooPad 3.5:
h3. New Features:
* Double clicking an image open it up in a suitable external editor (such as Acorn or Preview or Photoshop or whatever). Saving the image will then update the original image located in your VoodooPad Page. You've seen Acorn, right? http://flyingmeat.com/acorn/
* You can now edit pages and sort the results in the search window (woo!).
* Option-clicking on a tab close button will close all the open tabs except the one clicked on.
* The "default page text" in the preferences now accepts rich text, so you can embolden certain phrases or whatever. Go crazy.
* Pages served up via VoodooPad Pro's built in webserver look a whole lot better, especially on the iPhone.
* Speaking of the webserver- you now have the ability to search through all the pages when looking at a document in your browser (VoodooPad Pro only).
* The zoom factor of the page is remembered in the document workspace, so it'll be remembered between launches.
* When splitting a document, links to pages in the original document are retained for the pages being copied out.
* Added a page index to the default Web Export templates. Now you have a handy list of all the pages in your Web Export.
* New AppleScript: tell window 1 of application "VoodooPad" to insert text "hello world!"
* New AppleScript command to add/embed a file to the current document.
* Added an option to VoodooPad AppleScript export command- "with synchronous", which makes the export happen in the foreground.
h3. Changes:
* Reworked AppleScript implementation, which may require changes to your previous AppleScripts.
* No longer showing the license when starting up a new version. Please don't sue me.
* Cleaned up a preferences dialog box which could be confusing.
* Exporting to the iPod Notes folder is now done on a background thread, which makes things more responsive if you have a ton of pages.
* Changed the shortcut for deleting a page from Command-D to Command-Shift-D, making in less likely to hit by accident.
* Double clicking an image with the option key down will now prompt you to save the image.
h3. Bug Fixes:
* Fixed a problem where cmd-w wouldn't always close a window.
* VoodooPad Lite no longer tries to install plugins, which it can't use.
* Fixed a bug where the wiki engine would not markup a link directly following an email in the format 'first.last@foo.com'.
* You can now copy and paste linkback data across pages.
* Fixed some issues where list bullets would seemingly pop out of nowhere.
* Fixed a bug where VP would crash with certain embedded webarchives.
h3. Other:
* New hidden pref for writing out images to the iPod Notes folder (Only works on 5th gen iPods):
defaults write com.flyingmeat.VoodooPad_Pro writeIpodImages 1
* When exporting to the iPod notes folder, pages that have been deleted from the document but were still around from the last export are now cleaned up
* New hidden pref: defaults write com.flyingmeat.VoodooPad_Pro alwaysShowRuler 1
VoodooPad: Simple AppleScript Examplesurn:uuid:8596b25e-3567-01da-0fb1-c0cbe4c4b51f:352007-12-16T16:02:51Z2005-10-04T23:16:10Zh2. Here are some snippets of AppleScript that you might find handy.
Note: These are examples that work in VoodooPad 3.5. If you have a previous version of VoodooPad, check the help files that came with that version. For folks with VoodooPad Pro, just substitute "VoodooPad Pro" where you see "VoodooPad below.
*Prepend to the top of a page:*
<carea class="textareaCodeMini">tell application "VoodooPad"
tell page "index" of document 1 to prepend text "this goes at the top" & return
end tell</carea>
*Append to the bottom of a page:*
<carea class="textareaCodeMini">tell application "VoodooPad Pro"
tell page "junk" of document 1 to append text "this goes at the bottom" & return
end tell</carea>
*Create a new page:*
<carea class="textareaCodeMini">tell application "VoodooPad"
tell document 1 to create new page with name "new page" with content "This is a new page."
end tell</carea>
*Export to iPod:*
<carea class="textareaCodeMedium">tell application "VoodooPad"
-- this is the path to your document.
open "srv:Users:gus:Desktop:astest.vdoc" as alias
tell front document
export to ipod
end tell
end tell</carea>
*Getting text from a specific page*:
<carea class="textareaCodeMini">tell application "VoodooPad"
set theString to (text of page "index" of document 1) as string
end tell</carea>
*An example that loops through all the pages and displays it's name and contents*
<carea class="textareaCode">tell application "VoodooPad"
tell document 1
repeat with i from 1 to number of items in pages
set s to text of page i
set n to name of page i
display dialog n & return & s
end repeat
end tell
end tell</carea>
*An example that loops through all the pages, and prepends some text to every page*
<carea class="textareaCodeSmall">tell application "VoodooPad"
repeat with i from 1 to number of items in pages of document 1
set n to name of page i of document 1
tell page n of document 1 to prepend text "this goes at the top" & return
end repeat
end tell</carea>
*Sort and pull out pages by create page:*
<carea class="textareaCode">tell application "VoodooPad Pro"
set theDoc to first document
tell theDoc
set myList to ordered names sorted by create date
repeat with idx from 1 to number of items in myList
set pageName to item idx of myList
set s to text of (page pageName of theDoc)
-- now do something exciting with s
end repeat
-- we could have also done:
-- set myList to ordered names sorted by modified date
-- set myList to ordered names -- default, sorted by key
end tell
end tell</carea>
*Call into VoodooPad's scripting language "Lua" from AppleScript* (it's kind of crazy)
<carea class="textareaCode">tell application "VoodooPad Pro"
set s to "print 'Hello World!'; table.foreach(applescriptProperties, print); applescriptProperties.output = 'Hello from the return value!'"
tell window 1
set x to use plugin named "Lua Script" with properties {source:s, aprop:"This is a property passed in"}
display dialog x
end tell
set s to "applescriptProperties.output = windowController:textView():string()"
tell window 1
set x to use plugin named "Lua Script" with properties {source:s}
display dialog (x as string)
end tell
end tell</carea>
*Fun with Meta Values*
<carea class="textareaCode300">tell application "VoodooPad Pro"
set currentPage to current page name
tell page currentPage of document 1 to add meta record with value {|the key|:"the value"}
activate
display dialog "did it add?"
set thePageMeta to meta record of page currentPage of document 1
set s to |the key| of thePageMeta
display dialog s
tell page currentPage of document 1 to remove meta record with key "the key"
delay 1
display dialog "did it go away?"
end tell</carea>
*Fun with Categories*
<carea class="textareaCode300">tell application "VoodooPad Pro"
set currentPage to current page name
activate
tell page currentPage of document 1 to add category named "foo"
delay 1
display dialog "did it add?"
tell page currentPage of document 1 to remove category named "foo"
delay 1
display dialog "did it remove?"
end tell
tell application "VoodooPad Pro"
activate
tell document 1 to add category named "Foo"
delay 1
display dialog "did it add?"
tell document 1 to remove category named "Foo"
delay 1
display dialog "did it remove?"
end tell</carea>
Flying Meat: Start Pageurn:uuid:c2cde496-c729-01d9-0405-c0cbe4c4a89b:412007-09-13T14:39:38Z2005-05-17T16:16:56Zh2. Welcome to Flying Meat's online documentation.
There are a couple of spaces on this here that you might be interested in:
* "Acorn":http://www.flyingmeat.com/acorn/docs/
A simple and easy to bitmap image editor
* "VoodooPad":$scriptName$/space-353ec59a-c72a-01d9-0eb2-c0cbe4c48523
The award winning desktop wiki for Mac OS X. You put your brain in it.
* "FlyGesture":$scriptName$/space-4982c31c-c72a-01d9-1928-c0cbe4c4ee67
Move a little, do a lot.VoodooPad: Encryptionurn:uuid:f5eafb3e-1fda-01da-16f7-c0cbe4c4fd6d:82007-08-24T11:57:23Z2005-09-07T13:07:05Zh1. Encryption in VoodooPad
There are two ways to encrypt your data in VoodooPad. The first one (available in VoodooPad and VoodooPad Pro) is the ability to encrypt a single page. This is known as "Page Level Encryption". The second way (available in Voodoopad Pro only) is known as "Document Level Encryption". We'll go over Page Level Encryption first.
h2. Page Level Encryption
VoodooPad supports encrypting pages one at time, so you can have a mix of encrypted and unencrypted pages in a single document.
When encrypting a page, you are prompted to enter your password twice (to make sure your typing matches your intentions), and an option to keep the password in the Keychain.
p=. !$imagesDir$/voodoopad/encryptsheet.png! <br/>(encrypting a page)
When you place your password on the Keychain, you won't have to remember it when decrypting or encrypting your page. If you change your mind later and you would like to have your password removed from the Keychain, hold down the option key when decrypting the page and the password will be removed from the Keychain. Holding down the option key when encrypting will bring up the sheet regardless if you have the password on the Keychain or not.
p=. !$imagesDir$/voodoopad/decryptsheet.png! <br/>(decrypting a page)
h2. Document Level Encryption
VoodooPad Pro has the ability to make your whole document encrypted. With this in effect, you enter your password once when opening up your document, and you gain access to all your pages inside.
To remove a password from an encrypted document choose "Set Document Password..." from the Edit menu, and leave the password fields empty. To add a password to a plain document, choose "Change Document Password..." from the Edit menu and enter your password in the fields.VoodooPad: Editing Texturn:uuid:c14ec986-ccba-01da-15c6-c0cbe4c4b595:62007-07-17T14:12:32Z2006-04-15T13:02:24Zh2. Editing Text
As we mentioned earlier, text editing in VoodooPad is very similar to editing the text in a Rich Text document using TextEdit (and most other rich text editors on the Mac). However, because the rich text features of the Mac's text system are more similar to a word processor than to a simple text editor, we'll review a few of these features to be sure you're aware of their availability in VoodooPad.
On the other hand, because most of this functionality is so basic to Mac OS X, we'll make use of the hyperlinking capability of VoodooPad to reference much of this topic so you can move through it quickly if it's already familiar. If you see an editing capability referenced followed by the parenthesized note: "see edit details", simply click on the edit details link. The resulting page will have a link back to this one.
Open a new VoodooPad document by choosing File->New Document, or by pressing Shft-Cmd-N on the keyboard. When the the new window opens you should see the same document, with the heading: "VoodooPad, You put your brain in it." that you saw the last time we created a new VoodooPad document.
h3. Letter, Word and Paragraph Selection
We can select a letter, word or paragraph by clicking and dragging across them. Dragging across letters contains no surprises (see edit details). Doing so allows us to demonstrate text resizing on individual letters in a word (see edit details).
Notice the ease with which you can precisely select words by double clicking on the first and dragging across more (see edit details). We can also add to existing text properties in a selection (see edit details).
Finally, a paragraph is most easily selected by triple clicking and multiple paragraphs are easily selected by triple clicking and dragging (see edit details).
h3. Multiple Undo
As with most things Macintosh, we can undo what we've done by choosing Edit->Undo or pressing the Cmd-z keys. In fact, if we press Cmd-z often enough, or simply hold it down for a few seconds, we can undo all the changes we've just made on this page.
h3. Font Properties
Triple click to select the first paragraph of the page. Now choose Format->Font->Strike Out. We can undo the strike outs by pressing Cmd-z or by choosing Format->Font->Strike Out again while the strike out text is still selected.
Click on the Format menu item and drag to the Font item to see its submenu. Notice the things you can do directly from this menu:
• Bold, Italic, Strike Out, Underline to change font properties
• Bigger, Smaller to incrementally increase or decrease the selected text size
• Kern to spread letters apart or compress them horizontally
• Ligature to add ligatures used in your font
• Baseline to raise or lower the baseline of selected text
...and so forth.
Feel free to play with these properties if you're not familiar with them. In particular, with some text selected, choose Underline. Notice that rather than underlining the text, VoodooPad instead displays this panel:
The reason for this preference is that VoodooPad uses both underlining and text color to indicate links. It can be difficult to determine which underlined words really represent links if non-link words and phrases are also underlined and/or colored. Use the application's Preferences panel to change from the default with care.
With the first paragraph still selected, choose Format->Font->Show Fonts to bring up the Font pallette. This allows us to choose a new font for the selected text, change it's size and many other of it's properties.
To create the perception of lifting some text off the page, for instance, try clicking on the rectangle centered directly under the "Font" title of the Font pallette. To confirm that you've selected the correct rectangle, just hold the mouse pointer on the rectangle for a few moments until a tool tip pops up indicating that this is the Text Shadow rectangle. If it says something else, try again.
With the first paragraph selected when this rectangle is activated, the text in the paragraph will display shadows for each character. Directly to the right of the rectangle are three sliders, slide the first about 2/3 of the way towards the right, slide the second about 1/8 from the left and slide the third about 3/4 of the way toward the right.
As you do this, notice how the text seems to lift off the page. You can also click and drag the small indentation in the circle to the right of the third slider. As you do this, you'll see an apparent shift of the virtual light illuminating the text to cast the shadows at a changing angle.
h3. Font Colors
You can also choose Format->Font->Show Colors to display the color pallette. However, like underlining, by default you will not be able to change text colors. Choose VoodooPad->Preferences... and select the Appearance tab to change this default behavior.
Text Alignment and the Ruler
In our overview, we touched on the text ruler. Triple click on the third paragraph to select the entire paragraph and bring the ruler up again by choosing Format->Text->Show Ruler.
The text ruler is primarily used for setting page margins, paragraph indentation, tabs and alignment or justification. It also has pop-down menus for selecting line spacing, bullet point styles and an alternate means of selecting font properties.
With the third paragraph still selected, click on the third tab in the ruler tab bar that looks like this:
This should justify (or straighten the edges of) the paragraph on both sides. Now select the document title, "You put your brain in it." and click the far left of the four tabs to left justify the title.
h3. Setting Tabs
As a final demonstration of VoodooPad's standard text editing features, let's set some tab stops. First be sure that the VoodooPad window is wide enough by looking for the red Delete icon in the far right side of window's tool bar. If the far right icon is not the red Delete icon, then drag the lower right corner of the window to the right until red Delete icon appears.
Next scroll to the bottom of the page and click to place the text insertion bar at the very end of the text. Press the Return key a couple times to make some room. Then type in the following text. Note that as you do so, space each word or number from the others by a single tab:
Be sure that you've entered no spaces but only a single tab between each word or number. Then select all of the text in those five lines. With all five lines selected, go to the text ruler at the top of the window and drag all the tab stops that are to the left of the 5" mark out of the ruler. Don't worry if words or numbers in the five lines we've selected seem to go a bit berserk. We'll bring order to them shortly.
Look for the tab stop well at the far right of the ruler which looks like this:
Put your mouse pointer on each of the icons in the tab stop well for a couple seconds until a tool tips label appears. You should see that they are called from left to right respectively, the "Left tab stop", the "Center tab stop", the "Right tab stop" and the "Decimal tab stop".
Now drag a left tab stop from the tab stop well to the ruler and drop it at the top of the 3/4" mark. Next drag a Center tab stop from the well and drop it on the 2 1/4" mark. Next drag a Decimal tab stop from the well and drop it on the 3 1/4" mark. Finally, drag a Decimal tab stop from the well and drop it on the 4 1/4" mark.
If you've done this correctly, your five lines should now look like this:
Notice that the words in the Item column are left justified in the column. The numbers in the Quantity column are centered and the money amounts in the Price and Amount columns are aligned on their decimal points. Also notice a couple weaknesses in our formatting: the numbers in the number column should probably be centered in the column and the headers for the Price and Amount columns are right justified on the Decimal tab stops for each of those columns.
We could clean this up a bit by using different tab stops for the heading line then we used in the item and total lines, and by centering the numbers in the Number column, but we've demonstrated how the tab stops can be used and that was our objective in this tutorial.
If the resulting columnar list makes you uncomfortable, feel free to clean it up by inserting a tab at the left end of each of the last four lines, selecting only those four lines and adding a Center tab stop at the 1/4" mark. You can also select only the header line and replace the two Decimal tab stops there with two left tab stops placed at the 3" and the 4" marks. If you decide to do that, your result should look as follows:
But wait a minute, you say... the price for VoodooPad and FlySketch are $39.95, not $19.95! However, we reply, if you buy them in quantities of two or more, they're only $19.95 each.
Advanced Text Editing VoodooPad: Importing and Exportingurn:uuid:53020980-ccaa-01da-067c-c0cbe4c4b7b0:102007-07-17T14:10:37Z2006-04-15T11:04:46Zh2. Importing and Exporting
How does one publish or distribute a VoodooPad document?
Beyond just emailing the VoodooPad document itself (which only works if the recipient also has the application), VoodooPad gives us other ways to export our work for distribution:
* as a set of RTFD files (Rich Text Format with graphics)
* as a set of plain text files
* as Microsoft Word documents
* as an XML file
* to your iPod
* to HTML pages that retain the same links
Let's try these one at a time.
h3. Exporting as RTFD
First, create a folder on your desktop or in your home folder in which to do some playing. For purposes of our discussion, we'll call it VDTemp but you can call it any other name you can remember.
If you've closed the LinksAndPages.vpdoc VoodooPad document, let's open it again. When it's open, choose File->Export->Export as RTFD files... Navigate the resulting File Save sheet to your new folder, VDTemp, then click the Export button.
Now open a Finder window into the VDTemp folder. You should see four documents in the folder:
If you double click on the Index.rtfd document, it should open in TextEdit as a Rich Text document containing the content of the page named VoodooPad from our LinksAndPages.vpdoc VoodooPad document.
Notice that all of the links that were present on that page in LinksAndPage.vpdoc are present here, but though they look like links, they're not. That's because TextEdit doesn't support links between TextEdit documents.
Instead of creating a single document with an arbitrary page order, VoodooPad creates a set of documents, one for each page, in a folder. You can reorder them and print them in any order you desire, rather than having an arbitrary order forced on you.
When you've examined those pages sufficiently, throw them in the trash (or drag them to some other folder) to clear the VDTemp folder for our next experiment.
h3. Exporting as Plain Text
Next, let's try exporting as plain text. Once again, click on the LinksAndPages.vpdoc to make it active. This time choose File->Export->Export as Text files... Once again navigate the resulting Save File sheet to our VDTemp folder and click the Export button.
Go back to the Finder window (or open a new one) in the VDTemp folder. Notice now that we have four files named the same as before, except this time they have the .txt suffix. Let's double click on Index.txt to open it again in TextEdit and examine its contents.
This time we see the same content that was in our Index page, but all in the same font with no font styles and no apparent links, not even simulated links. This should not be a surprise, since this was created as a plain text document. So if your only interest is in the content of your pages without regard to any formatting, this would be the appropriate export method.
h3. Exporting as XML
Once again, clear the VDTemp folder for our next experiment. This time, choose File->Export->Export as XML..., navigate the Save File sheet to the VDTemp folder and click Save. When we go back to our Finder window in VDTemp, we have a small surprise. Instead of four files, one for each page in the original document, we only have a single file named after the VoodooPad document and suffixed with ".xml".
Double clicking on this file could lead to various results depending on what applications you've installed that can open XML files. To make your results predictable so we can examine the file together, first open the TextEdit application (if it's not already open) and from its File menu, choose File->Open. Navigate the resulting File Open dialog box to our VDTemp folder and open the LinksAndPages.xml document.
It's beyond the scope of this tutorial to delve very deeply into what we're seeing here. It's legitimate XML, so if you're familiar with the XML format, the content of this open file might make some sense to you. For our purposes, it's sufficient to expose the file and add that this method of export works for at least two purposes:
* to take a backup of our LinksAndPages.vpdoc document from which a new version, identical to the one we saved here, can be reconstituted.
* to provide a human and machine readable back up file that can be meaningfully examined by humans and can be parsed by other applications for reasons we haven't even considered yet.
If you are a developer and have worked with XML formatted files, you'll recognize from this latter point that XML provides a medium for generated documents that may be directly imported into VoodooPad.
h3. Exporting to Your iPod
If you don't have an iPod, you can skip this section, but if you have one, then plug it in.
Once your iPod shows up in the Finder, choose File->Export->Export to iPod. Once this command has completed, eject your iPod and navigate using the scroll wheel to Extras->Notes. Next you will see the name of your document listed, and when clicked on using the scroll wheel, you'll see your index page show up on the pod, with links! To move around through your document on the iPod, use the scroll wheel to move up and down.
You will notice that sometimes a link has a dark underline, while all the other ones have a light grey underline. When a link is dark, you can use the iPod button in the middle of the scroll wheel to move to that page on your iPod, just like you would when clicking on a link in VoodooPad.
h3. Exporting to the Web
For our final exporting exercise, choose File->Export->Web Export... which will display the Web Export Manager panel. On this panel, choose RTFD in the Export Format popup menu. Next, click the Choose... button to the far right of "Output directory:". When the Open dialog sheet appears, navigate it to our VDTemp folder and click Open. Leave the rest of the panel controls as they were and click the Export button. When you see the phrase, "Finished exporting" to the far left of the three buttons, Reset, Close and Export, then click the Close button.
Go back to the Finder window (or open a new one) in the VDTemp folder. Notice that we have four files, as before, but this time with ".html" suffixes. If you double click on index.html, a page should open in your web browser with the content of our Index page showing links. If you click on any of the links, it should take you to the page comparable to that page in VoodooPad.
It's important to recognize that though we are seeing the same content and clicking links with the same functionality, we are doing all of this in a web browser and using .html files, not the VoodooPad document. If we made a change to our VoodooPad document at this point, we wouldn't see the corresponding change in the web browser unless we exported again into the same folder.
In fact, while keeping our web browser open, let's do that. Go back to our work area in VoodooPad and click on the Home button in the Toolbar. On the Index page, add the following indented line to the bottom of the page.
p{padding-left: 20px;}. This is a line not yet reflected in our web pages.
and click the Save button in the Toolbar. The line is now saved in our VoodooPad document, but should not be seen in our web version. To confirm that, let's go back to the Finder window and double click on the index.html file to reopen it in our web browser. The page that opens should be our Index page, but there should be no indication of the last line we added. Once again, keeping the page open in our web browser, go back to the Work Area in VoodooPad and choose Web export...
The Web Export Manager panel should already be set up the way we want it, but to be sure, check that the Output directory is our VDTemp folder. Now click the Export button. When you see the phrase, "Finished exporting" to the far left of the three buttons, Reset, Close and Export, then click the Close button.
Now if we go back to our web browser page and click the Reload button which looks like this in Safari:
...then we should see the last line appear. In other words, we've just updated our little local web site with the new content from VoodooPad.
The other settings for web exporting in the Web Export Manager panel can be found in the VoodooPad manual under the Help menu.
Exporting to the Web makes our document easier to distribute widely than the printed page. It is easily reviewed by anyone who has a web browser, and today, that includes nearly everyone using computers. Finally, it retains its dynamic organization of pages, in which each page is related to the others through hyperlinks rather than through some sort of simulated physical proximity.
h3. Importing
Now that we've seen how to get information out of a VoodooPad document in several different formats, the next natural concern is how to get information into the document. The most obvious answers, of course, are to do what we've been doing, that is, type or paste the information in. However, we have other options, including:
* importing files
* dragging text
* dragging pages
On to Editing TextVoodooPad: Pluginsurn:uuid:40de692c-e33c-01d9-12a1-c0cbe4c4d9e7:242007-07-17T11:03:49Z2005-06-22T09:39:51Zh2. Extra plugins you can have for VoodooPad
The plugin interface for VoodooPad is accessed via the Plugin menu. Plugins have files named *.vpplugin and are installed by selecting the VoodooPad application file (.app) in the Finder, executing the Get Info command from the File menu, opening the Plugin section, hitting Add, and selecting the plugin file from the dialog box. Then when VoodooPad is closed and reopened the plugin command will appear in the Plugin menu. <!-- The following isn't true.. not sure where this idea comes from... Note that when you update VoodooPad to a new version, your plugins are not carried along, so you'll need to keep them and install them again when you update the application file. -->
( If you would like to know about developing plugins for VoodooPad, please visit the Plugin Development page. )
h3. Script Plugins:
Check out the Script Plugins page for information on how to build and install quick plugins. Visit Lua Plugin Snippets for examples.
The View Document plugin opens up a window with a paginated view of your entire document, which really isn't all that useful by itself. However- you can then bring up the print panel, and choose "Save As PDF" to get a PDF of your entire document. That's cool and useful.
The source is available for hacking on as well:
http://flycode.googlecode.com/svn/trunk/voodoopadplugins/documentview/
The Python Plugin Enabler is a simple VoodooPad plugin that lets you write additional plugins .. in python. Just double click it and it will install examples in:
~/Library/Application Support/VoodooPad/Script PlugIns/
This plugin was written by Jonathan Wight of "Toxic Software":http://www.toxicsoftware.com/ . Support questions should go to gus@flyingmeat.com however.
Extract Images will add a plugin that will let you extract all the images in a page to the place of your choosing. Actually- it'll extract any file attachment in there, but you've probably only got images in. OS: 10.3.5+
The Hot Key plugin lets you assign a hot key to VoodooPad, which when pressed from any application will bring VoodooPad to the front. It is very useful for people who like to take down notes quickly. OS: 10.2.8+
HTML Tools provides a preview window for interpreting the current page as HTML. It also provides an option to view the page as rendered Textile or Markdown, as well as an option to copy the selected text as HTML. OS: 10.4+
h3. Script Stuff
Script Stuff provides two actions under the Script menu. The first on is "Execute as AppleScript", which will take the contents of the current page and run it like you would in ScriptEditor. The second function is "Format as Python", which will take the front page and colorize it like it is a python script. Make sure the preference "Allow manual underlining and font color changes" is enabled first. OS: 10.3.5+
Random options that should probably be in VoodooPad. OS: 10.4.3+
* "New Current Date Page" This creates a new page (and inserts a link at the current position) in the format of 2005.01.31 (for January 1, 2005)
* "Select Line" selects the current line
* "Select Paragraph" selects the current paragraph
(Available for VoodooPad 2.5 on the Lua Plugin Enabler page. VoodooPad 3.0 and later includes the Lua Plugin Enabler by default)VoodooPad: Andy's Blog Engineurn:uuid:2fa9d30e-6e27-01db-01a0-c0cbe4c4ec54:212007-07-16T12:49:34Z2006-11-06T22:14:12Zh2. Andy's Blog Engine
These are a couple of script plugins, for using the current document as a blog engine. To install... well, I should add some links to install them.
h3. Usage:
Bear in mind that these scripts don't do any rendering. That is done during the Web Export. Because these scripts utilize the page meta function; they will only work in VoodooPad Pro.
I have a line in my postflight script that changes the name of the rendered file @home.html@ to @index.html@. If you change the variable @homePageName@ from @home@ then this line will need to change as well.
To see what this looks like in action check out the site I'm doing for my son's "Boy Scout Troop 262":http://troop262ps.org/ . Please bear in mind this is a work in progress. I could point you to my business site, but I don't want to use this as a forum for advertising. ;-)
Neither of these scripts has any data that are specific to any VPP document. I did this so that if you have multiple VPP documents that you are using as a CMS for a blog then the only thing that needs to be done is creating the "HomepageMeta" page in each document for the data.
h4. Meta Markup
* This script is used to *mark* the pages whose content will be placed on the "home" page.
* It does this by adding several page meta tags. Personalizing these tags for your document will be necessary.
* If you aren't using @Markdown@ markup then you should set @isMarkdown = "0"@
* This is where you set the location of Desktop folder that you write out the @atom.xml@ file. If you don't want it to be on your Desktop then you need to make changes in the other script.
* baseURL is the location of your blog page.
* homeURL is the index page of your site.
* categoryId is the name of the VoodooPad category that you want all the "posts" to go in.
* outdir is will be a folder on your Desktop at ~/Desktop/outdir
*Set your data in a new document page named "HomepageMeta". It will be in the following format.*
* This is the script that does the work.
* It will find all the pages that you have marked using the *Meta Markup* script and concatenate their content.
* It will then place this content on a newly created page in the document named "home". You can change this name but you'll need to do it in this script.
* I've tried to keep most, if not all, the personalized data out of this script.
* I now make an Atom feed that converts relative URLs to absolute URLs, but only in the feed.
*Make Homepage & Feed* script
<carea class="textareaCodeLarge">--[[
VPLanguage = lua
VPScriptSuperMenuTitle = Blog
VPScriptMenuTitle = Make Homepage & Feed
VPEndConfig
]]
--Written by Andy Fragen <andy@thefragens.com>
--with lots of help by Gus Mueller. :-)
function xmlEscape(str)
str = string.gsub(str, "&", "&amp;")
str = string.gsub(str, "<", "&lt;")
str = string.gsub(str, ">", "&gt;")
return str
end
atom = string.replace(atom, "$baseURL$", baseURL)
atom = string.replace(atom, "$blogTitle$", blogTitle)
atom = string.replace(atom, "$authorName$", authorName)
atom = string.replace(atom, "$homeURL$", homeURL)
if isMarkdown == "1" then
content = content:string()
content = vp.formatViaMarkdown(content)
document:createNewVPDataWithKey(pageDate)
pageTemp = document:pageForKey(pageDate)
attributedString = pageTemp:dataAsAttributedString()
attributedString:objc_mutableString():setString(content)
pageTemp:setDataAsAttributedString(attributedString)
if feedEntry == nil then
feedEntry = template
else
feedEntry = feedEntry .. template
end
--end Atom feed
end
atom = atom .. feedEntry
all:objc_mutableString():appendString(postTagClose .. "\n")
if isMarkdown == "1" then
document:deleteItemWithKey(pageDate)
end
count = count + 1
if count >= maxPosts then
break
end
end
end
atom = atom .. "\n</feed>"
--write out homepage
page = document:pageForKey(homePageName)
page:setDataAsAttributedString(all)
--write out atom feed
os.execute('mkdir -p ' .. outdir)
file = outdir .. "/atom.xml"
fd = io.open(file, 'w')
fd:write(atom)
fd:close()
--os.execute("open http://srv.local/xxx/")
vpconsole("Homepage and Atom feed created.")
</carea>
Much thanks to Gus. I couldn't have completed this without his time responses to my constant pestering. :-)VoodooPad: Andy's Web Export Category Moving and Sitemap scripturn:uuid:e5c0b6b8-33d3-01dc-07c7-c0cbe4c49166:22007-07-16T12:36:50Z2007-07-16T12:36:50ZDescribe Andy's Web Export Category Moving and Sitemap script here.VoodooPad: Andy's Fix Relative Linksurn:uuid:440fe13e-7a5d-01db-029e-c0cbe4c4a87e:82007-07-16T12:33:04Z2006-11-22T11:11:33Zh2. Andy's Fix Relative Paths script
This is a little shell script that will traverse a VPWebExportOutputDirectory and convert any <code>./</code> into <code>../</code> in any <code>*.html</code> files that it finds.
h3. Usage
Make this script executable and put it in your web export plugin and reference it in the Info.plist as a postflight script.
h4. fixRelativePaths.sh
<carea class="textareaCode250">#!/bin/bash
# A script to fix the relative URL for folders one level deep
# for use in web export plugin
# written by Andy Fragen <andy@thefragens.com>
for i in `find $base -type d -mindepth 1 -maxdepth 1 -name '*' -print`; do
for F in `find $i -type f -maxdepth 1 -name '*.html' -print`; do
mv $F $F.tmp ;
sed 's_"\.\/_"\.\.\/_g' $F.tmp > $F ;
rm $F.tmp ;
echo $F
done
done
An alias in VoodooPad is a way to assign certain words or phrases to another page. For instance, if you have a page named "Pizza" and you would also like the words "Pizzas" and "Italian Pie" to link to the Pizza page, you would make an alias to it. Here's how:
First bring up the Pizza page, and then choose "Page and Document Inspector" from the Window-&gt;Palettes menu. A window will come up that looks like this:
p=. !$imagesDir$/voodoopad/pizza_alias1.png!
Press the " + " button on the bottom left, and then enter "Pizza". Press the " + " button again, and enter Italian Pie.
p=. !$imagesDir$/voodoopad/pizza_alias2.png!
Next, bring up another page such as the index page. Type in either "Pizzas" or "Italian Pie". The word(s) will highlight and when you click on them you will be taken to the Pizza page.VoodooPad: Advanced Text Editingurn:uuid:f9a2d632-ccbb-01da-0dd7-c0cbe4c4d793:72007-07-15T11:32:44Z2006-04-15T13:11:08Zh2. Advanced Text Editing
In our last topic, we demonstrated that VoodooPad shares the flexibility of the Mac OS X Text System as represented in TextEdit. However, VoodooPad provides text editing features beyond that basic set, features such as tables, flexible bullet lists, more sophisticated line and paragraph spacing, highlight colors and a convenient margin shift capability for more convenient outlining.
h3. Tables
Let's open a new VoodooPad document by pressing Cmd-Shft-n, select everything in the window and delete it all with the delete key for a blank page.
Now enter a title, such as "Comparing Apples and Oranges" at the top of the document followed by two blank lines. You can do this by typing the title in, or by copying it from the previous sentence and pasting it in. Instead, let's drag the text to the new window.
To do this, double click on the word "Comparing" in the first sentence of the last paragraph, drag to the work "Oranges" and release the mouse button. Then click and hold the mouse within the selected text until the mouse pointer changes from an insertion bar to an arrow, then drag the selected text to the new blank VoodooPad window. Be sure to leave a couple blank lines after this title.
Next, let's add a 4 row X 2 column table to our document. Choose Format->Table... from the menu bar and notice that two things happened when you did so:
* a 2 row X 3 column table was inserted into our document at the insertion bar
* a table control panel was displayed to help us configure the table
Since this is not quite the table configuration we wanted, let's change it. While the table is still selected, click on the Table control panel, change the rows to 4 and the columns to 2. You can do this either by selecting the "2" and pressing the 4 key, or by clicking twice on the up arrow immediately to the right of the Rows text field. When you've changed the Rows field, select the "3" in the columns field and type in 2, or click once on the down arrow immediately to the right of the Columns text field.
If the table hasn't changed its configuration, be sure that you've selected any cell of the table and that the window containing the table is the frontmost window. You can confirm this by noting that the three buttons in the upper left corner of the table are colored while you're changing the table's configuration.
Now let's enter some values into the table. In the top row, type "Fruit" in the left column and "Desirability" in the right. In the three rows of the left column under the heading "Fruit", type: "apples", "oranges" and "bananas". In the right hand column, type "7", "8", "10".
You've probably heard that it's not possible to compare apples to oranges. With VoodooPad, we quite often do what other's have found difficult to impossible. We've gone one better, in this case, and included bananas in our comparison. But what if you don't like the desirability levels we've chosen. Hey, it's your VoodooPad document; change the values to suit you. Just because we believe bananas to be the perfect fruit doesn't mean that you have to agree.
However, our goal here is to learn VoodooPad's special editing characteristics, so let's go back to making our page look better. To do that, first select the page title and press Cmd-t on the keyboard to bring up the font pallette. Then select some sans serif font in the "Family" column of the font table, such as Helvetica, click "Bold" in the Typeface column and either enter "18" in the size text field, or click on 18 in the column below that text field. Close the font pallette and while the title is still selected, choose Format->Text->Center (or just press the Cmd-Shft-| keys).
Next we want to center the numbers in the desirability column. To do that, let's make use of a little known trick in the Mac OS X text repertoire: column selection. To select a column, hold down the Option key as you click and drag the mouse from the top left of the first number to the bottom right of the last number in the desirability column.
As you do this, notice that only the bottom right three cells of the table are selected, which is exactly what we wanted. Now click on the Center alignment tab in the table control panel, which looks like this:
Let's next click and drag across the two heading cells at the top of the table to select the words "Fruit" and "Desirability" simultaneously. Then click on the Center alignment tab in the table control panel again and press Cmd-b to make both words bold. You wouldn't actually need to select both words to center them in their cells as long as some part of each of the two cells is selected. However, we needed the words selected to make them both bold.
To illustrate the flexibility of tables in VoodooPad, click anywhere in the table and increase the row count in the Table control panel from 4 to 5. Notice that a new row has been added to the bottom of the table. Next, we want to select the bottom two cells. The easiest way to do that is to double click in one of the cells of the new row and drag through the other. Then click the Merge Cells button in the Table control panel.
We should now have a single cell at the bottom of the table that spans the table width. Click in this new cell and type "* mostly cloned", and suffix the word, banana, above with an asterisk. FlyGesture: How to Purchase and Registerurn:uuid:53ca49ec-177c-01da-112c-c0cbe4c4e838:62007-07-03T11:01:35Z2005-08-27T21:29:31Zh2. How to Purchase and Register FlyGesture.
You don't have too anymore - it's free!FlyGesture: Start Pageurn:uuid:4982c326-c72a-01d9-07fe-c0cbe4c4e873:202007-07-03T11:01:17Z2005-05-17T16:20:42Zh2. FlyGesture
* About FlyGesture
Find out what Flying Meat's FlyGesture is all about.
* How it Works.
Find out what makes FlyGesture tick.
* Movies
Watch FlyGesture in action.
* Frequently Asked Questions
Do you have a question that needs to be answered? VoodooPad: Web Exporturn:uuid:33e3c704-3124-01da-160e-c0cbe4c4be5d:232007-05-25T15:03:33Z2005-09-29T13:04:12Zh1. Web Export
Web Export is a new feature in VoodooPad 2.5. It allows you to export your document as HTML files, with options for marking up the pages as Textile, Markdown, or just treating it as plain text.
In addition, you are given the opportunity to specify "Web export plugins" to apply special formatting with the export.
Here's a quick rundown of the various options available in the Web Export window.
*Export format*: This is the format that you would like the text in your VoodooPad pages to be written out as.
* RTFD to HTML is probably going to be the most used option- it tries to match exactly what your pages look like on output.
* No Markup exports your pages as-is. No attempt is used to try and interpret any formatting in the pages.
* Plain Text exports the pages without any special formatting, or images, but does format for line breaks.
* Interpret as Markdown exports your pages using a popular text to HTML formating script. For more information on Markdown please visit http://daringfireball.net/projects/markdown/
* Interpret as Textile exports your pages using another popular text o HTML formatting script. For more information on Textile, please visit http://www.textism.com/tools/textile/
*Output directory*: This is the folder where the html files and images are written to.
*Web export plugin*: You may select a specific plugin to be used to provided extra workflow options, or template for exporting. These plugins are located in your "~/Library/Application Support/VoodooPad/Web Export PlugIns" folder.
*Preflight script*: This is a unix script (or application) that you may choose to be run before the actual export is taken place. This is useful if you want to create resources such as folders or supporting files to manage your workflow.
*Postflight script*: This follows the same idea as the preflight script, but is run after the export has taken place. For example, you could use this to automate the uploading of your html files and images to a server.
*Preset*: If you spend a little bit of time and energy into setting up what scripts need to be run, and what folders you want everything to be exported to, then you might want to save those setting for use at a later time. That's what this setting is for. Use the + button to add or modify a preset, use the - button to remove a preset.
*Reset button*: This resets all the export options to their default state.
*Close button*: This closes the Web Export window.
*Export*: This kicks off the export, and progress is updated via a label in the lower left corner of the window.
<br/>
h2. Special Pages:
The Web Export feature allows you to create special pages within your VoodooPad document, which supply additional information, scripts, or templates to be used alongside whatever plugin is used for export.
WebExportPreflightScript: This page will be executed like a normal shell script, and is called at the beginning of the export.
WebExportPostflightScript: This page will be executed like a normal shell script, and is called at the end of the export.
WebExportProperties: this page will be written to meta.xml, so you can place config information in here if it is needed.
WebExportPageTemplate: this page will override the template given in the selected plugin.
That'll include the page named "header" in your document.
h2. Special Variables.
<pre>$page$</pre> This will be replaced with the contents of the page.
<pre>$alias$</pre> This will include the first alias you have for a page.
<pre>$alias[0]$</pre> This will also include the first alias you have for a page.
<pre>$alias[1]$</pre> This will include the second alias you have for a page.
<pre>$alias[2]$</pre> The third alias for a page...
<pre>$alias[x]$</pre> Etc... (you get the point).
<pre>$displayName$</pre> This will insert the page name. ($title$ works as well, but is deprecated).
<pre>$categories$</pre> This will list the categories the page is in.
<pre>$documentName$</pre> This will include the document name, with the .vpdoc extension
<pre>$documentTitle$</pre> This will include the document name, excluding the .vpdoc extension
<pre>$year$, $modifiedYear$, $shortDate$, $longDate$, $time$, $shortTime$,
$timeDate$, $modifiedShortDate$, $modifiedLongDate$, $modifiedTime$,
$modifiedShortTime$, $modifiedTimeDate$</pre> These will list the dates in various formats, for both the create date, and last modified dates.
h2. AppleScript
Web Export can be controlled via AppleScript. Below are a couple of examples doing this.
<carea class="textareaCode">
tell application "VoodooPad"
tell document 1
web export to "/tmp" with properties {fileExtension:"php",
postflightScript:"/path/to/some/script.sh",
preflightScript:"/path/to/another/script.sh"}
end tell
end tell
tell application "VoodooPad"
tell document 1
web export using conversion format plain text with properties {fileExtension:"html",
preset:"to markdown folder",
pluginName:"GMDC Blog Layout"}
end tell
end tell
</carea>
h2. Automator
There are a couple of Automator actions for invoking Web Export in VoodooPad. Launch Automator and you will see them listed if you have installed VoodooPad.
<br/>
h1. Information for advanced users or plugin developers.
h2. Export / Script Execution Order
The following steps are what takes place when you press the "Export" button in the Web Export window. The hope is that this information will be useful for anyone wanting to make a plugin, or for advanced uses.
1. Preflight script specified in the export window is run.
2. WebExportPreflightScript page, if available, is run.
3. Preflight script(s) specified in the "PreflightScripts" array of the plugin's Info.plist file are run.
4. Pages are exported to output directory.
5. meta.xml is written out to the output directory if the boolean key "WriteMetaInfo" is set to yes in the plugin's Info.plist
6. Category files are written out.
7. Postflight script(s) specified in the "PostflightScripts" array of the plugin's Info.plist file are run.
8. WebExportPostflightScript page, if available, is run.
9. Postflight script specified in the export window is run.
h2. Shell Script Environment Variables:
These are environment variables that VoodooPad exports, for use in pre and postflight scripts.
VPWebExportOutputDirectory: The directory the files are written to.
VPWebExportVoodooPadDocument: The document that is being exported.
VPPluginPath: The path to the web export plugin that is being used.
h2. Plugin Info.plist keys
These are the various keys you should have defined in the plugins Info.plist file. This is really only of any use if you are wanting to write a Web Export plugin.
*NSExcludedElementsDocumentAttribute* - An array with items to exclude for the apple rtf->html converter. Values are given on this page: http://developer.apple.com/releasenotes/Cocoa/AppKit.html (search for NSExcludedElementsDocumentAttribute) 10.4 only.
*DisplayName* - what shows up in the pulldown list for the plugin.
*PrincipalTemplate* - the path to the html template to use when exporting.
*PreviewImage* - the path to a png image, which will be used for a preview in the WebExport window.
*PreflightScripts* - an array of paths, pointing to scripts to be run before the export takes place.
*PostflightScripts* - an array of paths, pointing to scripts to be run after the export takes place.
VoodooPad: New in 3.2urn:uuid:20f83654-03df-01dc-1cdc-c0cbe4c4ad6b:52007-05-24T16:59:29Z2007-05-16T11:56:18Zh2. New in VoodooPad 3.2:
h3. View Categories as Tags.
Lots of people have been wanting the ability to view the assigned categories as "tags". Well, now you've got it. Just open up the category palette, and use the cog-widget in the categories list to change the view as "tags".
h3. Page Previews.
Holding down the command and control keys while hovering over an interal VoodooPad link gives you a preview of the linked page. This is awesome if you want to be able to see the first couple of lines of a page, but don't want to open it up.
h3. Drag and Drop Linking Between Documents.
You can now drag and drop a tab from one document to another to create links. It's a super easy way to have inter-document links.
h3. Copy Link to Item Command
We've got a new command- Edit-&gt;Copy Link to Item, which will copy text to the clipboard which you can use to link to the specific page. This will work for any applications that respect the NSLink attribute in rich text.
h3. Link to Specific pages
You no longer need to setup aliases to link custom text to pages in your document. Select some text and choose "Link selection to item" in the Edit menu, and away you go.
h3. Other Stuff
Now using Sparkle to do updates of the application, no longer removing custom link attributes, bug fixes, you can view embedded web archives, improved searching, and more. test: Start Pageurn:uuid:98230ce6-c019-01da-19cb-c0cbe4c4d0ff:32007-05-23T14:58:36Z2006-03-30T10:18:32ZLD
it's my home
not mine...
(To open up the Categories window, choose the Window->Palettes->Categories menu item)
VoodooPad has the ability to assign different categories to a specific page in your document. What this means is you can create a category named "Food" and then assign this category to the pages "Cupcake recipe", "Dinner Ideas", and "The Cake".
And pages can belong in multiple categories as well. For example, say we have a "Wedding" category and then assign the pages "Guest List", "Reception Info", and "The Cake" to it. Notice that "The Cake" is in the Food category as well.
This is an easy way to organize pages in VoodooPad document according to topics.
p=. !$imagesDir$/voodoopad/categories_list.png!
*Tip:* To rename a category, hold down the option key and double click its name in the listing view.
h2. Categories as Tags
You can also view the categories for an item as "tags". To switch to this view, click on the widget in the top right corner of the categories list, and select "View as Tags":
Here are a list of keys that you can use to activate certain tools or features, just in case your hands don't feel like moving away from the keyboard.
"0,1-9" Pressing the number keys will cycle the canvas through various levels of transparency.
Here are the various key commands to change the current tool:
"V" Selection arrow.
"C" Oval.
"L" Line.
"R" Rectangle.
"E" Round Rectangle.
"T" Text.
"F" Freehand Sketch.
"H" Highlighter
Command-C copies the current canvas, or the current selection if any.
Command-V pastes
Command-Shift-E will export the canvas as an image.
*FlySketch 1.5 Only:*
* Option-drag in a color well to change the level of opacity. Move up to make it opaque, move down to make it transparent.
* Command click in a color well to bring up the standard color picker.VoodooPad: Quicksilver Append to VoodooPadurn:uuid:4af589d2-5834-01da-05df-c0cbe4c4bc81:102007-03-04T07:18:47Z2005-11-18T05:07:38Z[AUTHOR UPDATE (MARCH 2007): This script is no longer necessary for appending to QS. If you want easy prepends and appends (and more!) for QS, go grab the Voodoopad plugin for QS, which has a great deal more functionality and is likely coded far better.]
This is a script allowing appends to a number of VoodooPad pages from Quicksilver using a keyword at the beginnning of an entry. I use it for quickly adding information on the fly to any of a number of lists without switching window focus and not maintaining several text files.
It's here in case anyone else might find it (or parts of it) useful.
Please feel free to make changes if you have ideas or can improve on my limited scripting ability.
<carea class="textareaCodeLarge">
--Quicksilver Append to VoodooPad.scpt
--Version 0.21 (2005-11-16)
-- IMPORTANT: This script MUST be modified in at least one place for it to work successfully. At a minimum, the values of the VPDoc and VPDocPath variables defined below must be modified to point to an existing VoodooPad file and its full path. Additionally, the triggers and pages in the big if block below should be modified to suit the particular desires of the user. Note that the page targets defined in the if block below must exist when the script is invoked. If they do not, data sent to those pages will be lost. At a bare minimum, the user should add a "Log" page to the target VoodooPad document to catch default log entries.
-- Purpose: This script works with the applications VoodooPad from Flying Meat Inc. and Quicksilver from Blacktree, Inc. Both must be installed for the script to work. It links the two to allow rapid-fire appends to VoodooPad pages by using a keyword of one or more letters at the beginning of a Quicksilver input string.
-- Installation: The script should be installed in a scripts folder. Note, however, that the script does not work if called directly from the scripts menu; it only works when invoked via Quicksilver with a "Process Text" action. Setting up a Quicksilver trigger that calls the script plus a "Process Text" action to allow one-keystroke access to the append command line is recommended.
-- Usage: The text input expected is a keyword plus a text string to add to the page. In the if block below, Quicksilver input string of "gr ice cream" would add "ice cream" to the "Groceries" page in Quicksilver. This generally occurs in the background without distracting the user from the current work. If a keyword is used by itself as input, however, it brings the corresponding VoodooPad page to the front of the current windows for input. If no keyword is recognized, the entire text is appended with a timestamp to the "Log" page.
-- Declare globals
global InputKeyword, InputString, VPDocPath, VPDoc
-- Grab the input string from Quicksilver.
using terms from application "Quicksilver"
on process text QSInputString
-- The following global variables point to the VoodooPad document to which Quicksilver should append, and that VoodooPad document specified with its full path. They should be changed by the user to match their preferred VoodooPad document and path.
set VPDoc to "main.vdoc"
set VPDocPath to "BB HD:Users:sample:Documents:VoodooPad:main.vdoc"
-- Copy Quicksilver input string to global InputString. The first word of InputString is InputKeyword which will be tested in the big if block below, and clipped (if specified) in the VPAppend handler.
set InputString to QSInputString
set InputKeyword to first word of InputString
-- The big if block. Essentially, it tests InputKeyword against lists of possible keywords for a particular page or list, and calls VPAppend with parameters matching how that list should be treated. The syntax is pretty straightforward: the list of strings in brackets in the if-clause are all the possible keywords that will trigger sending the input to the page specified in the PageName parameter in the then-clause. If a keyword is used in two different if clauses, the first clause will be the destination.
-- ClipKeyword: Calling the handler with ClipKeyword will remove the first word from the input string before appending (so lists do not have various abbreviations before each entry if not desired).
-- LogStyle: Calling the handler with LogStyle will append a full date and timestamp before the input string for time-sensitive entries.
-- IMPORTANT: The page specified in PageName MUST already exist in the target VoodooPad document. Entries will be lost if not.
if InputKeyword is in {"g", "gr", "gl", "groceries", "groc", "food"} then
VPAppend with ClipKeyword without LogStyle given PageName:"Groceries"
else if InputKeyword is in {"id", "idea", "ideas"} then
VPAppend with ClipKeyword without LogStyle given PageName:"Ideas"
else if InputKeyword is in {"ln", "link", "links"} then
VPAppend with ClipKeyword and LogStyle given PageName:"Links"
else if InputKeyword is in {"n", "note", "notes"} then
VPAppend with ClipKeyword without LogStyle given PageName:"Notes"
else if InputKeyword is in {"s", "sc", "scr", "scratch"} then
VPAppend with ClipKeyword without LogStyle given PageName:"Scratch"
else if InputKeyword is in {"w", "wishlist", "wish"} then
VPAppend with ClipKeyword without LogStyle given PageName:"Wishlist"
else if InputKeyword is in {"log", "l"} then
VPAppend with ClipKeyword and LogStyle given PageName:"Log"
else
-- Default action: if the first word of the input string is not recognized as a keyword, prepend "log" to the input string so that it is processed by the VPAppend handler as a log entry, then call the VPAppend handler. The prepend is necessary so that input of a single non-keyword doesn't automatically bring up the log.
set InputString to "log" & space & InputString
VPAppend with ClipKeyword and LogStyle given PageName:"Log"
end if
end process text
end using terms from
-- VPAppend handler. Takes the string PageName to which input should be directed, plus booleans LogStyle and ClipKeyword to define how the input string should be modified. Actions of LogStyle and ClipKeyword are described below.
on VPAppend given PageName:PageName, LogStyle:LogStyle, ClipKeyword:ClipKeyword
tell application "VoodooPad"
-- Check to see whether document is already open. If not, open it.
if not (exists document named VPDoc) then
open VPDocPath
end if
-- If only nonwhitespace and nonpunctuation input is the keyword, then bring document to the front for input, open corresponding page, move cursor to the bottom of the page, and return
ignoring white space and punctuation
if InputKeyword is InputString then
tell application "Finder" to activate document VPDoc of application "VoodooPad"
open page document VPDoc with title PageName
-- This is a little hack to deal with VoodooPad's placing the cursor at the bottom of text on pages with 100 characters or fewer, but at the very top of all text on pages with more than 100 characters, when "open page" is called. This sends a Command-DownArrow to the page to place the insert point at the bottom of the page. Replacing "ASCII character 31" with "ASCII Character 30" below would cause the cursor to be placed at the top of the page, if that is preferred.
tell application "System Events" to keystroke (ASCII character 31) using command down
return
end if
end ignoring
-- Process ClipKeyword: If true, delete the keyword from the append string (i.e., get second word through to the end of the string).
if ClipKeyword then
set AppendString to text from word 2 to last word in InputString
else
set AppendString to InputString
end if
-- Process LogStyle: If true, prepend timestamp to the string
if LogStyle then
set AppendString to short date string of (current date) & space & time string of (current date) & ":" & space & AppendString
end if
-- Finally, append the text and a return character to the selected page.
append text AppendString & return to page PageName of document VPDoc
end tell
end VPAppend
</carea>VoodooPad: Triggersurn:uuid:96d13fbc-ed3b-01da-126a-c0cbe4c4d8a1:142007-03-03T18:07:02Z2006-05-26T21:45:15Zh2. Triggers
A VoodooPad Pro only feature- triggers are a handy way to script VoodooPad when certain events occur, such as a new page being created or deleted, documents opening or closing, files being written on web export and more.
*Note*: triggers are written in a scripting language named Lua, and a little bit of programming experience is required. You can find out more about Lua from http://www.lua.org/ .
The easiest way to learn triggers is to create one. Start off by creating a new page named "New Page Trigger", and delete all the text on the new page so we have a clean slate to work with. Next, just copy and paste this quick script:
pre. newPage = triggerDictionary.item
vpconsole("we're creating a new page named " .. newPage:displayName())
What this script does is print out the name of the new page in the VoodooPad console. Next we need to assign this script to an event in VoodooPad. So bring up the Page and Document Inspector (under the "View" menu) and switch to the Triggers tab. Select the event "Page opened" for the "On event:" label, and then press the plus button at the bottom of the window to select our new page:
Now try creating a new page in VoodooPad named "random". You should see the text "we're creating a new page named random
" pop open in a little window. Go ahead and delete the random page, and let's take a look at this script with a little more detail.
pre. newPage = triggerDictionary.item
Every trigger that is executed has a couple of global variables setup automatically. One of these is named "triggerDictionary". This dictionary contains values that can be of use when your triggers are being run. An easy way to find out what all the values in the dictionary are is to use this simple line that will print out the keys in the dictionary:
pre. table.foreach(triggerDictionary, vpconsole)
So in the first line of our example, we are assigning the value "item" of the trigger dictionary to a new variable named "newPage". This represents the page that has just been created.
The next line simply prints out some text with the name of the page to the console:
pre. vpconsole("we're creating a new page named " .. newPage:displayName())
The two dots (..) is how Lua concatenates strings together, so we get a single line of text that we send to the console. the newPage:displayName() bit calls a method named "displayName" on the new page object. A couple of other methods that we could call are "modifiedDate", "createdDate", "key", "type". There are more, but we won't get into those right now. Instead, let's spice up our example a little more.
Next, we're going to take the contents of our new page and modify them a little bit by adding the current date to it. There are a couple of easier ways we could do this, but for this example let's just pretend there aren't. So to start, let's go back to our "New Page Trigger" page and delete all the text there, and replace it with this:
pre. newPage = triggerDictionary.item
attributedString = newPage:dataAsAttributedString()
newString = os.date("\nThis page was created on %A, in %B")
attributedString:objc_mutableString():appendString(newString)
newPage:setDataAsAttributedString(attributedString)
What we do here is:
1: Grab the new page that's being created.
2: Grab the attributed string out of the page. An attributed string is a technical way of saying "stylized text". It is what keeps track of your bold and italic text, custom margins, and other fancy text stuff.
3: Create our date string that will will append to the end of our new page, in the format of "This page was created on Tuesday, in May"
4: Append our new text to our attributed string
5: Set that attributed string back into the page so it'll show up when we view it.
Now whenever we create a new page, you'll see that text appended to the end of it.
Other Topics:
* Trigger Examples
* "Lua website":http://www.lua.org/VoodooPad: New in 3.0urn:uuid:fafb03d4-ed49-01da-1cee-c0cbe4c4e99c:162007-01-31T18:29:17Z2006-05-26T23:28:16Zh2. New in VoodooPad 3.0:
*Tabs*
Open up multiple pages in the same window using tabs. Command click on a link to open it in a new tab, or right click on a link and choose "Open Link in New Tab". (And you can still open up pages in new windows by holding down shift-command when clicking on a link)
*Search Improvements*
Search in VoodooPad is lightning fast now, and returns results in record times.
*Support for big documents*
Stuff gigabytes of data inside a VoodooPad document, it won't mind. A new file format makes saving documents super quick as well.
*Linkback*
A user can paste content from any LinkBack-enabled application into VoodooPad and reopen that content later for editing with just a double-click. See http://www.linkbackproject.org/ for more info.
*Embed images, pdfs, and other types of files.*
The improved file format for VoodooPad 3.0 means you can embed files such as images, pdfs, mp3s, and most other types of files as well. VoodooPad also includes a new PDF Service so you can print from any application directly into VoodooPad.
*Full Screen*
Edit your pages in full screen mode, to keep you focused on the task at hand.
*Script Plugins*
Script Plugins are an easy way to extend the functionality of VoodooPad. Download new plugins or write your own.
*Palettes*
VoodooPad sheds the drawer and moves content out into easy to use palettes. Find your backlinks, pages list, categories, recently updated pages, and (new for 3.0) recently visited pages quick and easily.
*Text Styles*
A new text styles palette lets you add and apply text styles to your pages.
*Custom Shortcuts*
VoodooPad has a new preference pane where you can set and change the menu item shortcuts. So if you don't like that a certain plugin has no shortcut- now you've got an easy way to fix it!
*Merge and Split*
Merge two VoodooPad documents together using the import menu option, or split pages from a document into a new file to slim things down a bit.
*Improvements and Other New Stuff*
* Rulers stay in place now when moving from page to page.
* Smooth lines for sketch
* Clippings folder now supports RTFD files
* Sending by mail now includes images
* New Web Export date placeholders
* Upgraded linking engine recognizes CJK links without spaces, and much more.
* Copy no longer copies links that are only good to VoodooPad
* Plain text pages
* New package file format which is subversion friendly
* Double clicking an image will now prompt you to save the image to disk
* New toolbar buttons
* Window and tab states are now stored in the document
* Updates to the plugin api
* New preference to choose wether or not to use the default welcome text for new documents
* The open page panel is no longer case sensitive
* New applescript command "current page name" to get the name of the front most page
h2. VoodooPad Pro
There's a new addition to the VoodooPad family for the 5% of you who want some crazy advanced features. And here's what it has:
*Document level encryption*
Have every bit of your VoodooPad document protected by a password, and not just on a page by page basis.
*Triggers*
A handy way to script VoodooPad when certain events occur such as a new page being created or deleted, documents opening or closing, files being written on web export and more.
*Item Meta*
Assign meta data to an individual page which can be used for whatever you'd like, and access them in script plugins or triggers.
*Webserver*
A built in webserver to share your pages with friends or co-workers on your local network without any pain. Bonjour support so you don't have to hand around cryptic urls. VoodooPad: Old Versionsurn:uuid:28fc7dd0-f3e0-01d9-0161-c0cbe4c49a7b:122007-01-02T17:15:53Z2005-07-13T13:53:27ZHere are a list of links to older versions of VoodooPad, just in case you need one for some reason. However, you should always be running the latest version of VP, since it usually has important bug fixes that older versions don't have.
VoodooPad-2.5.5.dmg: http://flyingmeat.com/download/VoodooPad-2.5.5.dmg (Requires at least 10.3.9)
VoodooPadLite-2.5.5.dmg: http://flyingmeat.com/download/VoodooPadLite-2.5.5.dmg (Requires at least 10.3.9)
VoodooPad 2.1.2 http://flyingmeat.com/download/VoodooPad-2.1.2.dmg
VoodooPad Lite 2.1.2: http://flyingmeat.com/download/VoodooPadLite-2.1.2.dmg
VoodooPad 2.1.1: http://flyingmeat.com/download/VoodooPad-2.1.1.dmg
VoodooPad Lite 2.1.1: http://flyingmeat.com/download/VoodooPadLite-2.1.1.dmg
VoodooPad 2.1: http://flyingmeat.com/download/VoodooPad-2.1.dmg
VoodooPad Lite 2.1: http://flyingmeat.com/download/VoodooPadLite-2.1.dmg
VoodooPad 2.0.2: http://flyingmeat.com/download/VoodooPad-2.0.2.dmg
VoodooPad Lite 2.0.2: http://flyingmeat.com/download/VoodooPadLite-2.0.2.dmg
VoodooPad 2.0.1: http://flyingmeat.com/download/VoodooPad-2.0.1.dmg
VoodooPad Lite 2.0.1: http://flyingmeat.com/download/VoodooPadLite-2.0.1.dmg
VoodooPad 2.0: http://flyingmeat.com/download/VoodooPad2.dmg
VoodooPad Lite 2.0: http://flyingmeat.com/download/VoodooPadLite2.dmg
VoodooPad 1.1.4 http://flyingmeat.com/x/VoodooPad1.1.4.dmg
VoodooPad Lite 1.1.4 http://flyingmeat.com/x/VoodooPadLite1.1.4.dmg VoodooPad: Hidden Preferencesurn:uuid:1b17df8c-c750-01d9-0c13-c0cbe4c4e94a:132006-12-26T19:10:58Z2005-05-17T20:51:25ZSometimes preferences will be built into VoodooPad without an interface to set them. Usually these are turned on and off via the command line, invoked from within one of Terminal.app's windows. Here are a few of them:
_(If you are using VoodooPad Pro instead of VoodooPad, substitute_ *com.flyingmeat.VoodooPad_Pro* _for_ *com.flyingmeat.VoodooPad* _below.)_
h3. Print Margins.
If you want to set the margins to 1/4 inch all around, open up the terminal and type this:
defaults write com.flyingmeat.VoodooPad VPPrintMarginHack -string "{{0.25, 0.25}, {0.25, 0.25}}"
The values are for left, right, top, bottom
To remove the margin, type:
defaults delete com.flyingmeat.VoodooPad VPPrintMarginHack
h3. Setting an external editor that is not BBEdit (VP 2.1+ only)
To use "SubEthaEdit":http://www.codingmonkeys.de/subethaedit/ type this in the terminal:
defaults write com.flyingmeat.VoodooPad odbeditor de.codingmonkeys.SubEthaEdit
To use "TextMate":http://macromates.com/ type:
defaults write com.flyingmeat.VoodooPad odbeditor com.macromates.textmate
h3. Single click to open a page from the drawer (2.1.2+ only)
Quit VoodooPad, and type this in the terminal:
defaults write com.flyingmeat.VoodooPad singleClickBacklinksToOpen -bool YES
Then relaunch and you should be good to go.
h3. Keep VoodooPad from opening a new document on launch (2.5+ only)
In some cases, for example when you quit VoodooPad without an open document, VP will try to create a blank document on relaunch. Use this hidden pref to change the behavior.
h3. Show the old "Export As HTML..." menu option (2.5+ only)
VoodooPad 2.5 has a new "Web Export" engine, replacing the older HTML export options. However, if still want to use the older export options, you can bring them back with the following command:
h3. Requiring a prefix for AddressBook links. (VoodooPad 3.1+ only)
If you don't like that the AddressBook links names automagically, you can make it so it only links up when a prefix is given, such as "ab:". For example, say I would like to link to the AddressBook entry "Gus Mueller", but I wanted to have to type "ab:Gus Mueller" for the link to show up, this is what I would enter in the terminal:
FlySketch: Extra Scriptsurn:uuid:5e635a12-d1f2-01d9-0622-c0cbe4c49347:132006-12-19T10:44:10Z2005-05-31T09:38:08Zh2. ~Extra Scripts
These extra scripts can be placed in your ~/Library/Application Support/FlySketch/Workflow Scripts/ folder, to add additional actions to the Workflow Scripts toolbar button.
As always, be careful when installing applications or scripts from third parties- they may contain malicious code who's sole purpose is to destroy your computer. Any scripts downloaded from flyingmeat.com have been verified to be safe.
* "Open in Eudora" script, by Stephen Dodd
http://flyingmeat.com/fs/contrib/flysketch/OpeninEudora.sh.zip
* Upload to Flickr (10.4+ only)
Build an "Automator":http://www.apple.com/macosx/features/automator/ action you can use to upload your canvas to http://flickr.com/
* Upload to Blog
Upload an image to your weblog via the MetaWeblog API.FlySketch: Upload to Blogurn:uuid:b56efb5a-a26b-01da-08d8-c0cbe4c4f980:42006-12-19T01:13:41Z2006-02-20T15:50:45Zh2. Upload to Blog
Here's a quick workflow script written in python to upload an image to your blog.
You'll have to change the parameters at the top to your specific settings, and besides that there are a couple of other requirements:
a) Your weblog system needs to support the metaweblog api (such as movable type)
b) Your workflow image format needs to be set to "PNG"
FlySketch: About FlySketchurn:uuid:bba1c8c6-fb14-01d9-06f5-c0cbe4c4c5ff:312006-12-11T11:18:11Z2005-07-22T17:57:25Zh2. About FlySketch
FlySketch is a unique new application that allows you to draw on top of just about anything on your screen. Highlight words or paragraphs, draw shapes to help define what you want to say, and then drag and drop the results onto another application, or email it to a friend
h3. Great uses for FlySketch:
Some applications just don’t do what you want them to do. Take TextEdit for example- it’s a great writing application, but it doesn’t come with any drawing tools, and the same can be said about many applications. With FlySketch you can bring up a window without ever leaving TextEdit to create diagrams using the built in line and shape tools. And then adding your creations to TextEdit is done with only the drag of a mouse.
Or maybe you’re surfing the web, and you come across a great interface that you would like to study in detail later or maybe a picture that you know might not be around for much longer. Pop up FlySketch, use the screen capture button and tuck it away to a special “web collections” folder that you added to the workflow actions.
Workflow actions may also be created out of regular applications. Simply drag an alias of Microsoft Entourage® to the workflow folder, and when you choose its corresponding action in the workflow actions the image will be attached to a new email. You can also apply the same trick to Corel Painter®, Adobe Photoshop®, Mail, or just about any other application that allows you to drag images on to its application icon.
h3. Getting images out of FlySketch is a piece of cake.
To place an image into an application, just hold down the command key and drag on the canvas to pull the image off. Let go of mouse when you have your cursor positioned over your destination. If you would like the image to have a transparent background when pasted, hold down command-option while you drag the image.VoodooPad: Trigger Examplesurn:uuid:6e981020-ed40-01da-0879-c0cbe4c48c72:142006-12-06T15:35:48Z2006-05-26T22:19:55Zh2. Trigger Examples
*A trigger that creates a new page based on the current date when a document opens*
<carea class="textareaCode60">-- assign this to the "Document did open" event.
pageName = os.date("%Y.%m.%d", os.time())
triggerDictionary.document:openPageWithTitle(pageName)</carea>
*A simple trigger that you could use to modify the default text on a new page*
<carea class="textareaCode300">-- 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)</carea>
*A WebServer trigger example:*
<carea class="textareaCode250">-- 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
&nbsp;&nbsp;&nbsp;&nbsp;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")</carea>
*A Trigger to update a page listing all the pages in the document:*
<carea class="textareaCode250">-- 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)
</carea>
*Replace the template placeholder $clipboard$ with the text on the clipboard:*
<carea class="textareaCode400">-- 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)</carea> VoodooPad: Gemsurn:uuid:81c0220a-83ea-01db-0f39-c0cbe4c4b42b:42006-12-04T14:57:41Z2006-12-04T14:55:16Zh2. VoodooPad Gems, or otherwise known as "Cool Tips"
h3. Moving text between open windows.
If you'd like to drag and drop text from window a, to window b, and have the text removed from window a after the drop, hold down the command key. If you just do a normal drag and drop it will be copied instead of moved.VoodooPad: New in 3.1urn:uuid:7df7bd64-3a0b-01db-0eee-c0cbe4c4f9b3:202006-11-29T04:11:57Z2006-09-01T15:44:57Zh2. New in VoodooPad 3.1:
(If you are new to VoodooPad, or are just curious; be sure to check out what's new in 3.0 as well)
h3. Unified Window look, and Drawers are back
After receiving tons off feedback we discovered something; people really liked the old drawers and the way the windows used to look. So now you can have it both ways! If you like the darker "Pro" look, you can turn that on in the prefs. Otherwise you get the 100% all natural, no-preservatives traditional “Unified” windows. And if you really liked the drawers or you would like to play with them to see how the other half lives, you can flip that option on in the prefs as well.
Our new motto is: "We're not changing our mind, we're just agile".
h3. New preferences pane for opening links in tabs and windows
We got a lot of feedback about opening pages in new windows too, and a few of you wanted them to open up in new tabs all the time as well. So for VoodooPad 3.1 a new preference pane has been added which allows you to control where new pages are opened up; in the same view, in a new tab, or in a new window.
h3. Text Zoom
VoodooPad as a presentation tool? It’s been done on multiple occasions. But man, sometimes that text is just a little too small to see from the back of the room...
Text Zoom to the rescue!
Located under the View menu, you can now control magnification of what you’re looking at. Too big? Shrink it down. Too small? Blow it up.
h3. Sketch Improvements
Want to draw some lines on an image you’ve already got in a VoodooPad page? Now you can select an inline image and bring it up in the sketch sheet to edit it.
h3. Links to run plugins.
There are some folks out there with some crazy ideas. They want to click on a link and have it run a plugin, and _make stuff happen_.
It seems like it could be useful, who am I to say otherwise? (Besides being the guy who wrote VoodooPad and having the ability to say “no!” that is…)
So VoodooPad 3.1 includes a new url scheme “runplugin:”. It’s pretty simple.
Let’s say you made your own little script plugin named “Send Page to Entourage". You could then make a custom url link like so: “runplugin:Send Page to Entourage” and with an alias of “Ent”. Stay with me here...
Now you can type Command-Shift-O to bring up the “Open Page” sheet, type “ent”, and have your plugin run automagically. You can also add on parameters to the custom url, and it will be passed along to your script plugin. How cool is that?
Yes, it’s very geeky. The theory is that some of you will be able to do some cool things with this and hopefully share it with everyone else.
h3. New document idle trigger for VoodooPad Pro
Have you got a trigger that you want to run when you aren’t doing anything? Maybe commit your document to a Subversion repository, or something else? With a new event named “Document went idle”, VoodooPad Pro can run a trigger to act on your very wishes. After 15 seconds of you doing nothing at the computer, it’ll run.
If you would like to change the timeout to something other than 15 seconds, you can do so with the following defaults command in Terminal.app:
Where the value 30 would make it time out at 30 seconds.
h3. New "Send To" plugin.
Take a copy of a page and send it to another application or folder.
Place aliases of applications, shell scripts, or aliases to folders in the ~/Library/Application Support/VoodooPad/Send To/ folder, and it will magically show up in the Plugin menu. You can then call on that menu item and the current page will be sent to it! And for things like audio files or PDFs it will be copied out of VoodooPad and handed to your app/script/whatever.
If you'd like for the current page to be sent as plain text to your "Send To" item, just hold down the option key when calling upon it.
h3. New "Record Audio" plugin.
Ok, this really happened in VoodooPad 3.0.2 but we thought it deserved its own headline here.
If you have a microphone hooked up to your mac, or you have one of those fancy new intel machines with the microphone built in, you can now record audio notes for yourself and keep them inside VoodooPad for listening to later. You can also combine this with the new "Send To" plugin to record something, and then send it off to your favorite email application to share with other folks.
h3. Bug fixes, little things, and performance enhancements
* VoodooPad is slightly faster at importing documents and xml files. It's also faster at exporting as xml as well.
* If a bad search index is found, it's deleted and rebuilt instead of just VP beeping at you.
* Palette windows no longer float above all other windows.
* When importing files, you are now given the option to skip all duplicates when a conflicting page name is found.
* Fixed a crasher when embedding a file with drag and drop
* $clipboard$, and $fromPage$ can be used now as a variable in the new page template.
* New lua functions- vp.formatViaMarkdown(string) and vp.formatViaTextile(string).
* The new page sheet now has an "open in new tab" button, and auto fills the name box with "Untitled", "Untitled 2", etc..
* New preference to use smart quotes when editing text.
* Added a bit of eye candy when switching tabs in the preferences window.
* The voodoopad: bookmarklet now accepts some new parameters, such as "pageName" and "addDate".
* Holding down the option key while clicking the categories toolbar button will add the current page to the currently selected category.
* The plugin menu now shows up in the contextual menu when editing text. You can right click on a link, and the Send To plugin will act on what is behind the link instead of the current page. VoodooPad: Andy's Web Export Category Movingurn:uuid:ffd0144a-7a5b-01db-1622-c0cbe4c4a00b:82006-11-25T21:59:16Z2006-11-22T11:02:29Zh2. Andy's Web Export Category Moving script
This is a script, written in Ruby, that will parse the meta.xml file that is created during a web export and move the rendered html files into folders named for the VoodooPad categories. These folders are created elsewhere, like in the preflight script.
h3. Usage
I have this script in my web export plugin and have modified my Info.plist to run it as a postflight script. Remember to make the script executable.
h4. parseMetaXml.rb
<carea class="textareaCodeLarge">#!/usr/bin/env ruby -w
# for use in web export plugin
# written by Andy Fragen <andy@thefragens.com>
require 'rexml/document'
require 'fileutils'
include REXML
include FileUtils
c = 0
dir = ENV['VPWebExportOutputDirectory'] + "/"
meta = dir + ("meta.xml")
file = File.new(meta)
doc = Document.new(file)
num = XPath.match(doc, "//page")
files = XPath.match(doc, "//fileName")
subcat = XPath.match(doc, "//category")
cat = XPath.match(doc, "//categories")
for i in 0..(num.size-1)
if cat[i].size == 1
c=c+1
next
end
newDir = dir + subcat[i-c].text
fp = subcat[i-c].text + ("/".concat(files[i].text))
fpOld = dir + (files[i].text)
fpNew = dir + fp
if File.exists?(fpOld)
if File.exists?(newDir)
mv(fpOld, fpNew)
else
next
end
else
next
end
end
</carea> VoodooPad: Poor Man's AppleScript HTML Exporturn:uuid:42444f08-3610-01da-10f7-c0cbe4c4e0d3:72006-11-22T23:18:44Z2005-10-05T19:24:02Zh2. Poor Man's AppleScript HTML Export
This example AppleScript will talk to the first document, gather all the pages, and then export them as pre-formatted html to the folder specified in the variable "outFolder"
<carea class="textareaCodeLarge">-- this is the path to the folder you would like to write out to.
set outFolder to "srv:Users:gus:Desktop:html"
tell application "VoodooPad"
repeat with i from 1 to number of items in pages of document 1
set s to text of page i of document 1
set n to name of page i of document 1
set s to my findAndReplace("&", "&amp;", s)
set s to my findAndReplace("<", "&lt;", s)
set s to my findAndReplace(">", "&gt;", s)
set outfile to outFolder & ":" & n & ".html"
set outText to "<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>Here the title</title></head><body><pre>" & s & "</pre></body></html>"
tell application "Finder"
set f to outfile
set nref to open for access file f with write permission
set eof nref to 0
write outText to file f
close access nref
end tell
end repeat
end tell
-- shamelessly stolen from http://bbs.applescript.net/viewtopic.php?id=13008
on findAndReplace(tofind, toreplace, TheString)
set ditd to text item delimiters
set text item delimiters to tofind
set textItems to text items of TheString
set text item delimiters to toreplace
if (class of TheString is string) then
set res to textItems as string
else -- if (class of TheString is Unicode text) then
set res to textItems as Unicode text
end if
set text item delimiters to ditd
return res
end findAndReplace</carea>VoodooPad: Files and Documentsurn:uuid:248431b4-ccaa-01da-044b-c0cbe4c49273:62006-11-01T10:08:01Z2006-04-15T11:03:29Zh2. Files and Documents
You can create several pages of text with VoodooPad, and like a word processor, when you save all the pages that you've created go into the single document.
However, unlike the pages in a word processor which represent printed pages, VoodooPad's pages represent ideas. They grow as large as needed to accommodate the text you add for the idea that the page represents. As long as you keep entering text in the page, it keeps growing.
To understand VoodooPad's notion of a document, let's start by opening the "LinksAndPages.vpdoc" document that we saved at the end of the last topic. The easiest way to do this in Mac OS X is to first make VoodooPad the active application. Do this by clicking on it's icon in the Dock. Then choose the File->Open Recent->LinksAndPage.vpdoc menu item. If you don't see LinksAndPage.vpdoc within that menu, it may have been discarded from the Recent Items list by other new documents that you've opened since you worked with it.
When the document has opened, hold down the command key and click the document icon in the Title bar of the window. This should open a drop-down menu showing the directories in the path to the document as menu item choices. If you drag to, and click on, one of the directories in the menu, of course, that directory will open in a Finder window, illustrating the fact that our VoodooPad document is similar in most ways to any other document or file on the system.
There is another way that VoodooPad are dissimilar to a word processor's pages. Within the VoodooPad document there is no "natural" sequence of pages. Like the web, any VoodooPad page is a click away on an appropriate hyperlink. And, of course, this is a natural way to organize ideas. Any given page is a single page (or click) away from any other page on which there is a link to it.
This is what helps VoodooPad organize our minds. As we write about an idea or concept on a named page, we naturally include words about related ideas on that page. The words for those related ideas can be made into pages of their own, in which case they are automatically related through links from the original page.
Where VoodooPad's pages represent ideas and are easy to physically relate to other pages for closely related ideas, a word processor uses a completely different model for pages. A word processor "page" is analogous to the printed page within a printed document. It is of a fixed size and comes in a predetermined sequence within the document. The printing of a word processor document is