Link Search Menu Expand Document

Interact Scratchpad

Table of Contents

  1. Get Interact
  2. What is Interact Scratchpad?
  3. Basics
  4. Using Tags
    1. Tag Format
    2. Available Tags
    3. Using Labels
    4. Multiline Note Tag
    5. Tag Helpers
  5. Preferences
  6. About Contact Accounts
  7. URL Schemes
    1. /scratchpad

Get Interact

COMING SOON <!– Download Interact from the Mac App Store: –?

Download on Mac App Store

What is Interact Scratchpad?

Interact Scratchpad is a Mac menu bar utility to ease the creation of contacts from snippets of text, like email signatures and more.

Basics

To use the Scratchpad:

interact/interact-basics

  • Click the Scratchpad icon in your menu bar (or hit the configurable global hot key) to open the Scratchpad window.
  • Type or paste some text with contact information into the Scratchpad. The Scratchpad will search the text for recognizable contact information, such as names, phones numbers, addresses. Any values it has recognized will be shown in bold.
  • If needed, mark additional text with tags. If you wish to add additional values, or mark values the Scratchpad could not automatically identify, you can use tags. Tags can be manually typed at the beginning of a line, followed by a “:” and the value for the tag - or inserted by making a text selection and choosing the tag from the tag selection dropdown menu. Read more about available tags and their use.
  • Once your text is ready, you have several options:
    • Create: Adds a new contact to your default macOS contacts account using the text provided.
    • Add to…: Allow selection of an existing contact to merge new data. This is great for completing unfinished contact records, add additional phone numbers, etc.
    • Preview: Shows a preview of the contact card as it will be created.
    • Share: Allows export of a vCard version of the parsed contact information. Sharing can be done without creating a contact record and is a great tool for creating shareable vCards will limited information.

Using Tags

Interact Scratchpad recognizes many common contact-related values without any additional help, but sometimes it needs some help determining certain values. Tags allow you to give the Scratchpad the hints it needs.

Tag Format

Tags should always appear at the beginning of a line of text and be in the format:

tag: Value

Only tags in the available tags list below, appearring at the beginning of a line text will be used, and the tag name should appear first, followed by a colon (:) character, then the tag value. The tag value will be any text on after the : on the same line. Whitespace at the beginning and end of the line will be stripped from the value.

Some tags also support an optional label value to appear after the tag name, separated by a “-“ hyphen character, but before the “:”. If present, this label is used as the label for the value, for example to attach a “work” or “home” label to a phone number.

Some examples of valid tags:

first: Joe
title: Vice President
phone-home: 888-555-1234

Available Tags

The following tags are currently available:

  • first
  • middle
  • last
  • name: Use when full name is on a single line.
  • phoneticFirst
  • phoneticLast
  • nickname
  • prefix: Examples: Mr., Dr.
  • suffix: Examples: Jr., III, Sr.
  • groups: Comma-delimited list of group names to add the contact. e.g. “groups: - Family, Friends”.
  • street
  • city
  • region
  • postalcode
  • country
  • phone
  • email
  • company
  • title
  • twitter
  • skype
  • note

Using Labels

The “email” and “phone” tags can accept labels to mark the type of value. Labels are included by adding a hyphen and a label string. For example, phone-mobile: 888-555-1234 would add the phone number labelled as “mobile”.

Multiline Note Tag

The “note” tag also supports a special syntax for capturing a multiline block of text as a note using » and « to delimit the start and end of a block, as follows:

note>>
Any text between the markers,
even on multiple lines, will be captured as the note.
<<

Tag Helpers

If you are good typist, you may find it easier to type tags when needed, but the Scratchpad also offers tag helper keys above the keyboard to fill in tag values and assist with the proper formatting. To use a tag helper, you can select text in the Scratchpad, and hit the appropriate tag key for the value, and the Scratchpad will take care of inserting the proper tag to pick up that value.

Preferences

Interact Scratchpad offers several preferences that can be used to customize how you access and use the app. Access these preferences via the gear icon in the lower left of the Interact Scratchpad window.

interact/interact-preferences

  • Global Shortcut: The global shortcut is a keyboard shortcut which can be used to open the Interact Scratchpad from anywhere. The default value is Shift-Command-1, but the shortcut can be change to avoid conflicts with global shortcuts configured in other apps - or just to meet your own preferences.
  • Launch at Login: Check this box to setup Interact to run automatically whenever you login to your Mac, so it is always there ready to use.
  • Open Contacts After Creation: When enabled, after a new contact is created, or values added to an existing contact, Interact will open that contact’s card in the built-in Mac contacts app. Once you get comfortable with the Interact Scratchpad, or if you do not use the built-in Contacts app, you may wish to disable this setting so the Contacts app is no longer opened.
  • Clear Text After Creation: When this preference is enabled, after succesfully creating a new contact (or adding the current values to an existing contact), the Scratchpad will clear the text. In most cases this is desireable, but there might be a time when you want to create a series of similar contacts which share information, and it can be useful to disable this feature to allow the text to remain and be reused with a few changes to create additional contact records.

About Contact Accounts

The Interact Scratchpad uses Contacts accounts configured in macOS System Preferences. The same accounts used by the built-in Contact app. New contacts created by Interact will reside in the default Contacts account for the system. The default account can be selected in the built-in macOS Contacts app.

Interact can use the “Add to…” feature to merge values into existing contacts in any Contacts account.

URL Schemes

Interact supports for integration with other apps via the x-callback-url protocol. Interact registers the interact URL scheme. All URLs should begin with the base URL “interact://x-callback-url/[action]” where action is one of the actions listed below.

/scratchpad

Opens Interact directly to the Contact Scratchpad to parse plain text to contact data.

  • Arguments
    • text [string, optional] : URL encoded text to be used in the scratchpad.
  • Examples
    • interact://x-callback-url/scratchpad?text=Hello%20World

Download on App Store Download on Mac App Store

© 2012-2020 by Agile Tortoise, Inc.
Drafts is a registered Trademark of Agile Tortoise, Inc.
Privacy | Terms