PocketCites™
Wooden Brain Concepts
 
woodenbrain@kagi.com
http://www.woodenbrain.com

PocketCites for OS X

Index

Introduction to OS X version
Requirements
Operation
Setup
Entering new records in FileMaker Mobile
Exporting records from FileMakerMobile & PocketCites to EndNote
PocketCites Settings Notes
Further Customizing PocketCites
Shareware
Technical info
Version History
Important Notes for Upgrading Users

Introduction to OS X version:

The OS X version works much like the OS 9 version did, except that since FM Sync is no longer availabe, it works with FileMaker Mobile. This means PocketCites is a bit less functional than before: FileMaker Mobile doesn't support running scripts before & after HotSyncs. So now you have to import and export before and after a HotSync. But this is a matter of pushing a button on the database, so it's not a huge deal.

WBC is making this version available mainly as a courtesy to registered users, because I wanted to use it personally with OS X. Others are welcome to try it. I have become increasingly busy with my own work, so there won't be a lot of available support, I'm afraid. Please consider this version "as is".

Requirements:

Because a number of software products already exist to handle the storage and transfer of database records to the Palm, PocketCites takes advantage of them. Therefore, PocketCites X requires the following software:

On the Macintosh:

On the Palm:

Distribution:

Shareware: $11-22, sliding scale. (see below)

Operation:

PocketCites contains an EndNote export style, a FileMaker database specifically designed for EndNote, supporting import/export files, and a set of scripts (internal to the database) which automate the import and export of EndNote records. Once initially set up and once familiar with the process, it is easy and close to automatic.

In a nutshell: From EndNote, you save (an) export file(s) to the "import-export files" folder*. You then import that file into the PocketCites database, and synchronize that database with FileMaker Mobile on the Palm. Getting records into EndNote after a synch is also easy: simply export a file from PocketCites and import it into EndNote.

*note: the "import/export folder" has been renamed "import-export folder" for OS X.

Initial Setup:

Although the initial setup involves several steps, once completed normal operation should run smoothly. Please follow these steps exactly--especially running the first import and export scripts before the first HotSync.

We will assume that all the required software mentioned above has already been installed.

Using the PocketCites X Setup Assistant:

For convenience, a PocketCites X Setup Assistant is provided. It can automate many of the following setup steps, but it is not a substitute for following these setup instructions. At minimum you must still unstuff the distribution archive before running the Setup Assistant. You will still need to set an import file in the PocketCites database and configure it for FileMaker mobile as well.

The steps which the Setup Assistant automates are indicated with a † sign.

In the Finder:

  1. Unstuff the PocketCites folder using the current version of Stuffit Expander available free from Aladdin.
  2. Place the entire folder somewhere on your hard drive where you want to keep it.
  3. Note that having more than one version of FileMaker Pro installed on mounted volumes can cause conflicts. Removing outdated versions is highly recommended.
  4. Make a copy of the PocketCites database file you intend to use as a backup by duplicating it in the finder. (†)
  5. Copy or Move the PocketCites export style (in the "Support files" folder) to your EndNote 6.0 (or greater) styles folder. (†)
  6. Drop the Satimage OSAX (also in the "Support files" folder) to the ~/library/ScriptingAdditions/ folder. (~ means your home directory). If no ScriptingAdditions folder is in your home library folder, create it first (without a space). Remove any older version of the Satimage OSAX if one exists. (†)

In EndNote 6.0 or greater:

  1. Add "PocketCites" to your favorite Output Styles in the Style Manager. (Edit Menu->Output Syles->Open Style manager). If you are unclear about how to do this, consult the EndNote documentation.
  2. Select the "PocketCites" style in the Output Styles sub-menu.
  3. Select records in your EndNote library and export them as text. Save the file in the "import-export files" folder of the "PocketCites" folder. (As shown below.)

(†) The Setup Assistant will open EndNote for you.

Notes:

  1. All PocketCites import and export files must be kept in this "import-export files" folder
  2. You should export from EndNote with the .txt extention (not absolutely necessary). This is the file you will set as your input file in PocketCites.
  3. When you export from PocketCites, the export file will be saved in that folder as well, with the name PC-<filename>.tsv.

 

Hint: It may be helpful to create an alias to the PocketCites import-export files folder inside the EndNote folder because EndNote's export and import options often default there. You could also add it to favorites. (†)

 

In PocketCites (the FileMaker Pro database):

  1. Open the appropriate PocketCites database. (†)
  2. Push the "Set Prefs" button (or select Set Preferences from the Script Menu) and adjust as desired, or reset the defaults.
  3. Set the location of your PocketCites folder (the main PocketCites folder).
  4. Choose the file you have just exported from EndNote as your import file by pressing the choose file button. (You may prefer to use the provided "Palm.txt" file for this setup step since it only contains a few records.)
  5. Press the "Import" button. Wait for the script to finish.
  6. Press the "Export" button. Wait for the script to finish.
  7. Note that these setup steps in PocketCites are necessary before your first HotSync to establish file locations.

(†) The Setup Assistant will open a selected PocketCites database for you and prompt you to set preferences.

Setting up the database for FileMaker Mobile:

Some or all of these steps might not be necessary, depending on your installation of FileMaker Mobile. Frankly I'm not sure whether they will have to be done on new systems. I have no easy way to test this.

  1. Go to FileMaker's File->Sharing menu and check the "mobile companion" box for the database (see the FileMaker mobile documentation for details on setting up databases to work with FileMaker Mobile.)
  2. Click the "Settings" button, then the "Specify Fields" button, then the "Properties" button.
  3. This will allow you to set the format for each field. You may need to do this step if you want "reference type", "year", "place published", and "publisher" to be available as pop-up menus in FileMaker Mobile.

 

 

In the FileMaker Mobile Conduit:

  1. In the HotSync Manager select Conduit Settings in the HotSync menu.
  2. Double-click on FileMaker Mobile
  3. Make sure synchronization is on (best to set as the default)
  4. Keep the PocketCites database(s) you want to synch open during each HotSync (see FileMaker Mobile documentation)

Congratulations! If you have followed these steps correctly, you should be ready for your first HotSync!

After your first HotSync:

You should now be able to open the PocketCites database file in FileMaker Mobile on your Palm. You may want to adjust settings such as column widths.

Note that several fields are pop-up fields. These are: Reference Type, Year, Place Published, and Publisher. You can edit or add to these in PocketCites using the "Change pop-up menu value lists" in the Script menu. Be careful changing the Reference Type pop-up value list, because they must exactly match EndNote's reference types. In general, only change the Place and Publisher list.

Entering New Records in FileMaker Mobile:

Try entering some new records into FileMaker Mobile. In general you enter records as you would in any database. Here are a few things to keep in mind, however:

  1. Multiple authors should each be separated by a semicolon (";"). (See PocketCites Settings notes.)
  2. Use the pop-up list for Reference Type, or if you enter your own, make sure it is defined in EndNote.
  3. Title 2 (Secondary Title) is used for the titles of Journals, Magazines, Newspapers, or Books (in the case of books sections) depending on the Reference Type. (See PocketCites and EndNote field name table.)
  4. Editor is used for Editors in Book Section, Edited Book, and Conference Proceedings reference types. (This field is mapped to Secondary Author within EndNote.)

Exporting Records from PocketCites to EndNote:

Each HotSync will synchronize the records in FileMaker Mobile and FileMaker Pro. At some point, you'll want to bring them back into EndNote.

When you hit the "export" button on the main interface of PocketCites, it will generate a new file in the "import-export files" folder. The name of this file depends on the name of the import file you have set in preferences. If your import file was "Palm.txt", the export file will be called "PC-Palm.tsv". (.tsv refers to tab-separated values.) Import this file into EndNote:

Make sure to use the Tab Delimeted import option.

I also recommend that you both import records via a different library than your primary or default library. This way you can avoid unwanted mistakes, unexpectedly truncated fields, etc. The included "Palm" library can be used for this purpose. (This library can be opened from the Scripts menu on PocketCites' main menu bar.) Then you can drag over the records you want to add to your main library.

PocketCites Settings Notes:

Once you're comfortable with the default PocketCites settings, the Set Preferences screen allows you to fine-tune the way PocketCites handles file import and export and the conversions necessary to move citations from EndNote to FileMaker Mobile and back.

Choosing when to Import

You may prefer to run the import script only when you've exported a new file from EndNote and placed it in the PocketCites folder. PocketCites keeps track of modification dates, so if you hit import and there have been no changes while this option is set, the imput routine will end, making it faster.

Clearing Records and Handling Duplicates

When you import citations into PocketCites for transfer to FMM, you are rather likely to get many duplicates, especially if you are using the same import file or if you frequently update your citations in EndNote and then wish to transfer them to FMM. There are two ways PocketCites handles this.

First, you can set PocketCites to clear all records before an import. This method may result in the matching records in FMM also being removed or with FMM confusion about which records to maintain, so use this option with care. This option, if set, will override the preferred (default) method, removing duplicates.

The default method is to remove duplicates. PocketCites will remove duplicates one of two ways. It will always retain the first instance of the citation, so that it will be properly sync'ed with FMM. However, you may wish to retain changes you've made to a citation in EndNote. To handle this, PocketCites defaults to the "merge records with incoming data" option. This will merge citations field-by-field with the newly imported citations, thus making sure that changes made in EndNote are properly transferred. This method may take some extra time, especially for large databases.

PocketCites will always remove duplicates on import unless it is set to "clear all records". On export, removing duplicates is generally not necessary, so you may turn it off.

Character Conversions and field truncations

Due to FileMaker Mobile limitations and EndNote oddities, some problems could be encountered if your EndNote fields are too long or they contain carriage returns. PocketCites will automatically strip carriage returns (i.e., ¶, or the return character) from your import file. Carriage Returns will be replaced by the text you specify in preferences, defaulting to "…"

When entering or changing citation records in FMM, you may now safely enter line breaks and PocketCites can generate an export file that will be properly imported in EndNote. EndNote requires that authors be separated by semicolons (;). If you turn the "Restore ; for authors and "…" for Keywords, Abstracts, and Notes" option on, PocketCites will convert line breaks in Author, Editor, and Translator fields to ";" and will replace line breaks with "…" or the character you specify. Since this may take some extra time, this option defaults to off.

Note: After importing records back into EndNote, you can select the "Change Text" option to replace the specified text with a carriage return if you choose. "…" can be typed with option-; (option-semicolon) and a return is option-return.

PocketCites will also limit your keywords, abstracts, and notes fields to the value you specify.

Interface Options and File Settings

One of the most common difficulties people have in setting up PocketCites has to do with the folder locations. When in doubt, re-set the folder and file locations by pushing the Choose a Folder and Choose a File buttons.

Advanced users may wish to change the default settings for the Details and List views. These are actually layout numbers as are described on the preferences screen. In most cases there is no need to change these values.

You can set options to close the database and quit FileMaker after an export and/or a HotSync.

Other Options and Features

You can move from record to record with the Next and Last buttons on some views, and can perform a Find with the Find button. Enter your searches in the appropriate fields, and PocketCites will find everything that matches all fields entered. If you hold down option and click on Find, PocketCites will return to display all citations in the database. The small buttons to the left of the citation in list views will bring up the detail view for that record.

Script Menu

Note the script menu on the main menu bar. Some duplicate buttons available in the views. You can also change pop-up values for certain fields, go to EndNote, open the "Palm" EndNote library in the PocketCites folder, and open the Wooden Brain Concepts web page in your default browser. In the case of problems, you can also send Wooden Brain Concepts a log of the results of imports and exports via e-mail. (Clicking on the Wooden Brain icon in the preferences screen has the same effect.)

Further Customizing PocketCites:

Customizing Fields used in FileMaker Mobile

This should be possible as it was in the OS 9 version, but I haven't tested it.

Multiple Databases

It is possible to HotSync multiple databases in a single HotSync. As long as they are all kept within the PocketCites folder, you may duplicate the PocketCites database in the finder as many times as you like, naming them whatever you wish. The name of the database will be the name of the FMM database as well.

You will then set up each database to work with FileMaker Mobile as described above.

Shareware:

This software is offered as Shareware. Although I would like to distribute it as Freeware, I've put a considerable amount of time into this project, when I should (have been) writing my doctoral dissertation (and now should not be doing this). I would thus very much appreciate some minimal compensation.

Please be aware, however, that because I'm quite busy on non-computer related work, I am not able to promise extensive support. If you feel paying the shareware fee entitles you to lots and lots of support, please don't pay and use the software as is—with my compliments—instead.

This is a fully functional version, except that it has a built-in nag screen and an irritating vocal reminder each time you export or close the database. After you have paid, I will e-mail you a Shareware Code to disable the nag screen.

Send me what you can afford, on a sliding scale. $11 for students, up to $22 for professors or other professionals.

PAYMENT VIA KAGI IS NOW AVAILABLE!

To pay via Kagi, you can pay on-line using a credit card via a secure server or by snail mail using cash or a check.

Various site-license and world-wide license arrangements are also available.

To pay by snail mail, send cash or a personal check to:

Thank you!

Technical Info:

Moving the PocketCites folder

You now can put the PocketCites folder anywhere you'd like, though the default is the FileMaker folder. Change the location in preferences. If you put it at the top level of your hard drive, you can set this in a pop-up menu. If you want it somewhere else, move it there first, then hit the Choose a Folder button.

Other technical notes

Please do not move or delete any of the folders contained within the PocketCites folder (Support files, Working, etc.) or the files in them. If you do, PocketCites will probably choke.

Limitations

  1. PocketCites should now be able to handle databases quite large in size. It has been tested with libraries up to 500 records.
  2. Individual citations (records) can be no longer than 100,000 characters
  3. Because the PocketCites EndNote Style uses the infinity sign to mark the ends of records, putting that character in EndNote libraries will cause conflicts.
  4. Exported citations from EndNote cannot contain tabs within fields, since tabs are used to separate fields.

Disclaimer:

The author cannot be held responsible for any damage this software may do to your data, to your computer, to your sanity, to your appetite, or anything else. Using this software constitutes an agreement to these terms.

Troubleshooting & Technical Help:

Because of the way FileMaker Pro handles import and export (developers cannot directly specify file locations but the file locations are determined relative to the location of the database), exact folder locations and performing the set-up steps correctly are very important. If you encounter file location errors, run through the set-up steps again.

See limitations, above.

I will offer technical help only to registered owners via e-mail: woodenbrain@kagi.com. Immediately after encountering replicable problems, please e-mail your logs by selecting that option in the scripts menu or by clicking on the Wooden Brain logo in the preferences view. I'll do my best to respond, but please be patient.

Version History

v2.0b1 (October 18, 2002)

See OS 9 version history for complete history.


If you use WBC software please consider making a donation .

donate some $$ for freeware products via KAGI

WBC Home
Products
Stuff
WBC Portal
Whatever
Support