Skip to content

Latest commit

 

History

History
231 lines (146 loc) · 7.26 KB

icalBuddyLocalization.pod

File metadata and controls

231 lines (146 loc) · 7.26 KB
Raw

NAME

icalBuddyLocalization -- documentation for the icalBuddy localization file

SYNOPSIS

The icalBuddy localization file should be saved in ~/.icalBuddyLocalization.plist and is thus per-user. The contents of this file are expected to be a valid property list, so it's recommended that you use the Property List Editor application distributed with the OS X Developer Tools to edit it. If you want to edit this file manually, please consult the plist(5) and plutil(1) man pages. The example at the end of this man page might also be of help.

DESCRIPTION

Structure of the Localization File

The root object of the localization file should be a dictionary. Keys in this dictionary should be localization string identifiers that uniquely identify specific strings that icalBuddy would like to display to the user (see below,) and the corresponding values should be the actual strings that will be displayed.

General Considerations

Some localization string identifiers require a specific substring to be present in their values, such as %d or %@, in order to specify the location of some variable, like a number or a string. See below for info on which identifiers have such requirements. If any localization string identifiers are missing in the localization file, icalBuddy will simply display the corresponding default strings, which will be in english.

Available Localization String Identifiers

The following localization string identifiers may be used:

title

The name of the "title" property of a calendar item (event or task.)

notes

The name of the "notes" property of a calendar item (event or task.)

url

The name of the "url" property of a calendar item (event or task.)

location

The name of the "location" property of an event.

dueDate

The name of the "due date" property of a task.

noDueDate

The words used to describe the lack of a due date for a task.

priority

The name of the "priority" property of a task.

high

The translation of the value "high" for the "priority" property of a task.

medium

The translation of the value "medium" for the "priority" property of a task.

low

The translation of the value "low" for the "priority" property of a task.

noPriority

The translation of the value "none" for the "priority" property of a task.

priorityTitle

The formatting of a task priority as a title (e.g. %@ priority). Must include substring %@ to specify the location of the priority value. If this cannot be used (like it cannot for e.g. french), priorityTitleLow, priorityTitleMedium and priorityTitleHigh should be defined instead.

priorityTitleNone

The lack of a task priority as a title (e.g. No priority).

priorityTitleLow

"Low priority" as a title. If defined, will be used instead of priorityTitle. Note that if using priorityTitle is sufficient for the language (like it is for e.g. english), this one does not need to be defined.

priorityTitleMedium

"Medium priority" as a title. If defined, will be used instead of priorityTitle. Note that if using priorityTitle is sufficient for the language (like it is for e.g. english), this one does not need to be defined.

priorityTitleHigh

"High priority" as a title. If defined, will be used instead of priorityTitle. Note that if using priorityTitle is sufficient for the language (like it is for e.g. english), this one does not need to be defined.

someonesBirthday

The title for an event in the Birthdays calendar (e.g. %@'s Birthday.) Must include substring %@ to specify the location of the person's name, and optionally also substring %i to specify the person's age (e.g. %@'s Birthday (age %i)).

someonesBirthdayNoAge

The title for an event in the Birthdays calendar (e.g. %@'s Birthday.) Must include substring %@ to specify the location of the person's name.

myBirthday

The title for your own birthday event (e.g. "My Birthday".)

today

The translation of "today".

tomorrow

The translation of "tomorrow".

yesterday

The translation of "yesterday".

dayBeforeYesterday

The translation of "day before yesterday".

dayAfterTomorrow

The translation of "day after tomorrow".

xDaysAgo

The translation of "%d days ago", where %d is a number of days (the %d must be included to specify the location of this number.)

xDaysFromNow

The translation of "%d days from now", where %d is a number of days (the %d must be included to specify the location of this number.)

thisWeek

The translation of "this week".

lastWeek

The translation of "last week".

nextWeek

The translation of "next week".

xWeeksAgo

The translation of "%d weeks ago", where %d is a number of weeks (the %d must be included to specify the location of this number.)

xWeeksFromNow

The translation of "%d weeks from now", where %d is a number of weeks (the %d must be included to specify the location of this number.)

dateTimeSeparator

What to print between the date and the time (for example, in english: " at ".)

noItems

What to print under empty sections (i.e. dates, if separating by date and showing empty dates) (for example, in english: "Nothing.")

EXAMPLES

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
        <key>title</key>
        <string>title</string>
        <key>location</key>
        <string>location</string>
        <key>notes</key>
        <string>notes</string>
        <key>url</key>
        <string>url</string>
        <key>dueDate</key>
        <string>due</string>
        <key>noDueDate</key>
        <string>no due date</string>
        <key>priority</key>
        <string>priority</string>
        <key>someonesBirthday</key>
        <string>%@'s Birthday (age %i)</string>
        <key>someonesBirthdayNoAge</key>
        <string>%@'s Birthday</string>
        <key>today</key>
        <string>today</string>
        <key>tomorrow</key>
        <string>tomorrow</string>
        <key>yesterday</key>
        <string>yesterday</string>
        <key>dayBeforeYesterday</key>
        <string>day before yesterday</string>
        <key>dayAfterTomorrow</key>
        <string>day after tomorrow</string>
        <key>xDaysAgo</key>
        <string>%d days ago</string>
        <key>xDaysFromNow</key>
        <string>%d days from now</string>
        <key>thisWeek</key>
        <string>this week</string>
        <key>lastWeek</key>
        <string>last week</string>
        <key>nextWeek</key>
        <string>next week</string>
        <key>xWeeksAgo</key>
        <string>%d weeks ago</string>
        <key>xWeeksFromNow</key>
        <string>%d weeks from now</string>
        <key>high</key>
        <string>high</string>
        <key>medium</key>
        <string>medium</string>
        <key>low</key>
        <string>low</string>
        <key>noPriority</key>
        <string>none</string>
        <key>priorityTitle</key>
        <string>%@ priority</string>
        <key>priorityTitleNone</key>
        <string>No priority</string>
        <key>dateTimeSeparator</key>
        <string> at </string>
</dict>
</plist>

SEE ALSO

icalBuddy(1), plist(5), plutil(1), icalBuddyConfig(1)

AUTHORS

This man page has been written by Ali Rantakari (http://hasseg.org)