Resources system rewrite + new "--save-config DIR" option

[jvcard.git] / src / be / nikiroo / jvcard / resources / display.properties

diff --git a/src/be/nikiroo/jvcard/resources/display.properties b/src/be/nikiroo/jvcard/resources/display.properties
index d03d45b343b7de26710d74a9536b6ba48e58dc4e..eb7408d247aa4c40990b48d2dbcd6f52737ca734 100644 (file)
--- a/src/be/nikiroo/jvcard/resources/display.properties
+++ b/src/be/nikiroo/jvcard/resources/display.properties
@@ -1,12 +1,52 @@
-# display options configuration
-
-# The contact list format is basically a list of VCF field names
+# Display options configuration
+#
+# The Contact List Format (CLF) is basically a list of VCF field names
 # separated by a pipe and optionally parametrised.
 # The parameters allows you to:
 # - @x: (the 'x' is the letter 'x') show only a present/not present info
 # - @n: limit the size to a fixed value 'n'
 # - @+: expand the size of this field as much as possible
+#
+# In case of lists or multiple-fields values, you can select a specific
+# list or field with:
+# - FIELD@(0): select the first value in a list
+# - FIELD@[1]: select the second field in a multiple-fields value
+#
+# You can also add a fixed text if it starts with a simple-quote (').
+#
+# Example: "'Contact: |N@10|FN@20|NICK@+|PHOTO@x"
+# 
 # 
-# You can cycle through them if you have more than one
-# (in this case, separate them with a comma (',')
-CONTACT_LIST_FORMAT = NICKNAME@10|FN@+|EMAIL@30|PHOTO@x,FN@+|EMAIL@40
+# The Contact Details Info Format (CDIF):
+# - Each detail (separated by a pipe "|" character) is visible on its own line
+# - It is made up of two parts: the label and the linked VCF field (optional),
+#              separated by an equal "=", sharp "#", plus "+" or asterisk "*" sign
+# - "=FIELD" will take the preferred value for this field
+# - "+FIELD" will take the preferred value for this field and highlight it
+# - "#FIELD" will take all the values with this field's name
+# - "*FIELD" will take all the values with this field's name, highlighting the preferred one
+#
+# Example:
+#      CONTACT_DETAILS_INFO = Phone:=TEL|eMail:=EMAIL
+#
+# This will print two lines:
+#      Phone: +32 888 88 88 88
+#      eMail: nobody@nowhere.com
+#
+
+
+# (FORMAT: coma-separated list of CLF)
+# The format of each line in the contact list
+CONTACT_LIST_FORMAT = NICKNAME@10|FN@+|EMAIL@30|PHOTO@x,N@[0]@20|N@[1]@+|EMAIL@40
+# (FORMAT: CDIF)
+# The list of details to show in View Contact mode
+CONTACT_DETAILS_INFO = Phone:=TEL|eMail:=EMAIL
+# (FORMAT: Integer or nothing for auto)
+# The size of the details' labels
+CONTACT_DETAILS_LABEL_WIDTH = 12
+# (FORMAT: CLF)
+# The default value of FN if it is not present
+CONTACT_DETAILS_DEFAULT_FN = N@[1]|' |N@[0]
+# (FORMAT: TRUE or FALSE)
+# TRUE to force all FNs to be recreated from CONTACT_DETAILS_DEFAULT_FN
+CONTACT_DETAILS_SHOW_COMPUTED_FN = true