Configuration file keys

This describes the configuration file keys added to plucker.ini or .pluckerrc to be used by Plucker Desktop. These are in addition to the keys used by the Plucker distiller (see the Plucker reference for a full description of them). The keys are grouped by their section that they are in, with keys listed alphabetically in each.

Beginner tip: The boolean keys need to be 0 or 1, not TRUE/FALSE or YES/NO. Strings don't have quotation marks around the values. Directories don't have any trailing slash on them

[PLUCKER_DESKTOP] keys

• add_channel_wizard_do_launch_channel_dialog 1 to launch a Channel dialog after completing an Add Channel Wizard. 0 to just return to the Main Dialog.
• after_group_command Command to execute after spidering a group of channels.
• branding_about_dialog_style Style of about dialog: "simple" will show a single html page, "enhanced" [and ""] will show the regular a 3-tabbed enhanced about, and "messagebox" or any other non-empty string will show the standard messagebox.
• branding_application_desktop_name Name of the application's desktop component. Default is "Plucker Desktop".
• branding_application_publisher Publisher of the application, Default is "The Plucker Team"
• branding_application_suite_name Name of the application suite. Default is "Plucker".
• branding_preferences_dialog_hidden_pages Index numbers of pages in the preferences dialog to be hidden. Semicolon delimited array. Numbered from 0 on the leftmost. Default is no pages hidden.
• branding_tips_exclusion_filter Semicolon delimited array of filters to apply to exclude certain tips-of-the-day from being displayed. For example, plkrTIP_ADVANCED will hide advanced tips. See the tips.txt file in the resources for the possible filters.
• before_group_command Command to execute after spidering a group of channels.
• channel_dialog_position_x Previous x position of this dialog.
• channel_dialog_position_y Previous y position of this dialog.
• channel_dialog_size_x Previous width of this dialog.
• channel_dialog_size_y Previous height of this dialog.
• directory_documentation Directory of Plucker Desktop documentation.
• directory_locale Directory of Plucker Desktop locale files (gettext .mo files).
• directory_pda_viewer Directory of Plucker viewer .prcs to be installed.
• directory_pyplucker Returns the PyPlucker directory which has Spider.py and the other files for the Python parser.
• directory_resource Directory of Plucker Desktop resources.
• directory_wxwindows_configuration Directory to store a file of wxWindows settings, like help bookmarks, file dialog styles, etc. (Not the directory returned by wx-config on POSIX).
• editor_dialog_position_x Previous x position of this dialog.
• editor_dialog_position_y Previous y position of this dialog.
• editor_dialog_size_x Previous width of this dialog.
• editor_dialog_size_y Previous height of this dialog.
• editor_use_advanced_toolbars 1 to use the advanced toolbar in the HTML editor. 0 to use the basic one, with 'Insert Hyperlink' only.
• editor_tools_insert_linefeeds 1 to insert linefeeds at the end of text generated through one of the toolbar buttons.
• help_startup_tips_enabled 1 to show startup tips on startup. 0 to not.
• help_startup_tips_type Number 0-2 of type of startup tip to to show on startup. 0=basic tip, 1=advanced tip, 2=rubber chicken trivia.
• help_startup_tips_last_tip_shown The number of the last tip shown. This is the line number of the startup tips text file for the certain type.
• html_editor Optional commandline to an external editor. If left blank, will use the integrated internal HTML editor.
• installation_plkrdata_fullnames Semicolon delimited array of filenames that were consulted during installation. This key is used internally, and should not ever need to be set by hand.
• installation_plkrdata_datetimes Semicolon delimited array of last modified datetimes of filenames that were consulted during installation. It is used to compare a file to see if it has already been imported. This key is used internally, and should not ever need to be set by hand.
• internationalization_enabled 1 to enable localization of interface into another language. 0 to disable.
• is_first_execution 1 if it is the first execution of the program (and thus should launch the setup wizard, etc). 0 if not.
• locale_wx_number A wxWindows number of the current locale. Used internally and shouldn't be changed. However, a value of -1 can be specified, which will pop up a choice dialog on startup, asking which language to use.
• main_frame_position_x Previous x position of this dialog.
• main_frame_position_y Previous y position of this dialog.
• main_frame_size_x Previous width of this dialog.
• main_frame_size_y Previous height of this dialog. main_frame_statusbar_enabled 1 to show the status bar in the main dialog, 0 to not.
• main_frame_toolbar_enabled 1 to show a toolbar in the main dialog. 0 to not.
• message_dialog_enabled_no_destinations_selected 1 to keep showing the message dialog that there is no destinations selected, when close a channel dialog. 0 to repress this message dialog.
• message_dialog_enabled_no_destinations_selected_update 1 to keep showing the message dialog that there is no destinations selected, when about to update a channel. 0 to repress this message dialog.
• message_dialog_enabled_palm_desktop 1 to keep showing the message dialog that was unable to find Palm Desktop and other Palm keys in the registry. 0 to repress this message dialog. Used on MSW only.
• plucker_desktop_version Version of Plucker Desktop application
• plucker_home A cached version of the value of PluckerHome in the systems registry (only used on MSW).
• preferences_dialog_position_x Previous x position of this dialog.
• preferences_dialog_position_y Previous y position of this dialog.
• preferences_dialog_size_x Previous width of this dialog.
• preferences_dialog_size_y Previous height of this dialog.
• process_launch_distiller_directly MSW only. 1 to execute the distiller program directly, instead of calling plucker-build which then executes the distiler. Very likely want this to be 1.
• process_kill_using_sigkill 1 to use SIGKILL to terminate a process instead of SIGTERM. Default is to use SIGKILL on MSW and SIGTERM on all others. On MSW, SIGKILL is mapped to closing a process by sending window close events to the application, which is useless if there isn't any, such as a console-only plucker-build, python or java application.
• progress_dialog_close_on_error 1 to close the progress dialog even if there was an error reported by the parser.
• progress_dialog_close_on_exit 1 to close the progress dialog automatically on exit if there was no errors reported by the parser.
• progress_dialog_show_details 1 to initially show the details when a progress dialog is displayed. 0 to initially hide details.
• showcase_dialog_insert_all_parameters 1 to insert all parameters
• showcase_dialog_layout_type 0=horizontal layout. 1=vertical layout. showcase_dialog_main_splitterwindow_sash_position Previous sash position in pixels for the splitterwindow. Will resize back to an acceptable value if value would put the splitter offscreen.
• showcase_dialog_position_x Previous x position of this dialog.
• showcase_dialog_position_y Previous y position of this dialog.
• showcase_dialog_show_details 1 to show details in the showcase dialog. 0 to not.
• showcase_dialog_show_images 1 to show images in channel previews. 0 to not.
• showcase_dialog_show_preview 1 to show previews in the showcase dialog. 0 to not.
• showcase_dialog_size_x Previous width of this dialog.
• showcase_dialog_size_y Previous height of this dialog. from the showcase into the channel. 0 to just insert name and URL only.
• spidering_display_mode The feedback method for spidering. Either dialog or console.
• splashscreen_enabled 1 to show splashscreen on startup. 0 to not.
• theme Theme of the icon set.
• window_placement_type Number of 0-2 of where to place a child dialog when it is opened. 0=center on screen, 1=center on parent, 2=last location.

[PLUCKER_DAEMON] keys

• autoupdate_deferred_lower_time_limit If in Deferred autoupdate mode, the upper time of day limit that current time must be in order for an autoupdate to start. Must be in w3C format, for example: 19:00:00
• autoupdate_deferred_upper_time_limit If in Deferred autoupdate mode, the lower time of day limit that current time must be in order for an autoupdate to start. Must be in w3C format, for example: 23:00:00
• autoupdate_mode One of 4 autoupdate modes: 0=Never, 1=Immediately, 2=Deferred, 3=OnSync.
• autoupdate_precision Number of minutes to check if it is time to start an autoupdate, if so specified in the preferences.
• username_filter A filter of the username to update channels. Without the username filter, when hit Sync button in creadel to start an update of all due channels, it will update all channels that are due, not just the ones that have the currently syncing username included as a destination. Therefore, when hit Sync button, the conduit will write the currently syncing username to this key, and only channels that have this username as a destination will be updated. This feature is not yet implemented

Channel section keys

• after_command Command to execute after spidering this channel.
• before_command Command to execute before spidering this channel.
• copy_to_dir The directory to install channel's output.
• directory_on_card= Semicolon-delimited list of directory on handheld card to install to. If left blank, will place into the default directory on the card. The items in the comma-delimited list match up with the items in the user= key This feature is not yet implemented.
• handheld_target_storage_mode Semicolon-delimited list of whether the handheld users should install to RAM, SD-Card, MemoryStick, etc. 0=Install to RAM. 1=Install to SD Card. 2=Install to MemoryStick. The items in the comma-delimited list match up with the items in the user= key.
• update_base The base time from which to calculate a due time, by adding (update_period x update_frequency) to it. Must be in W3C format, for example: 2002-07-25T17:51:13
• update_enabled 1 to mark this channel as being due at a specified time. 0 to mark it as never due.
• update_frequency The number of periods that should elapse from the update_base before channel is due.
• update_period The units of update. Valid values are hourly, daily, weekly, monthly, or yearly.
• user The Sync username to install channel's output. A non-blank value on POSIX means to use pilot-link.