Getting Started

Keynote Files for Revit are simple text files that follow a specific format. This application has been created to make it easier to work with those keynote files.

Keynote Manager can be used for either a "text file per project" system, or a "text file per office" system. If your office uses one master file for the whole office, simply ignore the "Master Keynote Files" section of the settings dialog and use the "Browse" button to set to your office master. If you use an independent text file for each project, set the path to your master files in the settings menu. You will then be able to create new files based on those master files. Keynote Manager will issue a warning if a master keynote file is selected for editing.

Keynote Manager is available in two separate applications; the standalone application and the Revit integrated application. The standalone application is a standalone windows program that can be started from the Windows start menu and does not require Revit to be running. The Revit integrated application is a Revit add-in that cannot run on it's own.

Keynote Manager Plus licenses allow access to either or both of the applications if desired, however they are separate installers so if both are desired they must be installed separately.

The standalone application can be used by spec writers, managers, or others that may not need or want to open Revit to work with the keynote files. It can also be used to create new project keynote files from office masters (see below). The Revit integrated application is intended for use by those who use Revit on a regular basis and need to edit keynote files.

Please note that this application contains two distinct save modes:

• Instant Save / Multi-User - This mode will save all changes to the keynote file instantly and allows multiple users to edit a keynote file at the same time. This mode is recommended for larger offices or situations where multiple users may need to edit the file simultaneously. Note that in this mode there is no need to save, but no ability to undo, so please use caution.
  • With instant save mode, if you have hidden files shown you may notice a new hidden folder appear next to your keynote file. This folder is used by Keynote Manager to communicate and track changes made by all users accessing the file, similar to Revit's worksharing folder. Please do not modify this folder manually, however if you need to move the keynote file to a new location it may be discarded.
• Manual Save - This mode uses a standard file access system that opens the text file and locks other users out of the file while it is open. This mode is recommended for single users or offices where only one user is authorized to edit the keynote file.

All user files (settings, backups, etc.) that are saved by the Keynote Manager will be saved at "*AppData*\Revolution Design\Keynote Manager". This resolves to the following paths:

Windows XP: C:\Documents and Settings\*username*\Application Data\Revolution Design\Keynote Manager
Windows Vista/7/8: C:\Users\*username*\AppData\Roaming\Revolution Design\Keynote Manager

Keynote Manager does not send any personally identifiable information to Revolution Design or to anyone else without permission. Other than the licensing module, the only communication is through Reporting, and the bug reporting system.

New keynote files can be created through the Keynote Manager File menu (KM Standalone) or the file drop down (KM+) in one of three ways:

• Blank - This option will start a new blank text file and allow you to build keynotes manually from scratch.
• From Master - This option will allow you to select any master file defined in the settings and will create a copy of that master in the location you specify. This new copy will then be opened for editing and can be modified without affecting the master file. Note that this option will be unavailable if no master files are defined in settings.
• Browse - This option allows the user to browse to an existing keynote file and create a copy of it. This new copy will then be opened for editing and can be modified without affecting the original file.

Keynote text files can also be created through windows explorer or any other means without issue as long as they follow Revit's formatting conventions.

Note that using these commands from KM+ will set the keynote file for the active Revit model to the newly created file.

If you (or someone else on your team) has already created a keynote file, select File->Open or press Ctrl+O and browse to select the existing file. Keynote Manager will open the file and you will be ready to start editing.

Upon opening an existing file, Keynote Manager will run a quality control check on the file to make sure that there are no errors in the file at startup. The primary checks Keynote Manager runs are as follows:

• Improper Formatting - If Keynote Manager encounters notes that are not in the correct format in the text file it will warn the user that those text file lines will be ignored (and deleted) as Revit will be unable to read them.
• Duplication - Keynote Manager will check for duplication of keynote key values within the file. If duplications are encountered the user is given the choice to delete, overwrite, or automatically sequence no the next available number.
• Orphaned notes - Notes that list a parent note, but the parent note does not exist are orphan keynotes. If these are encountered in a file the user is given the choice to delete the orphan notes, or move them to the top level where they can be relocated later.

Note that opening a file with KM+ will set the keynote file for the active Revit project to that file.