Index: trunk/core/module_help/events_list.txt
===================================================================
diff -u
--- trunk/core/module_help/events_list.txt (revision 0)
+++ trunk/core/module_help/events_list.txt (revision 1716)
@@ -0,0 +1 @@
+ This tab contains the texts for email notifications sent out by the system when specific events occur. It contains all notification texts for the In-portal platform and the installed modules.
\ No newline at end of file
Index: trunk/kernel/module_help/languages_edit_general.txt
===================================================================
diff -u
--- trunk/kernel/module_help/languages_edit_general.txt (revision 0)
+++ trunk/kernel/module_help/languages_edit_general.txt (revision 1716)
@@ -0,0 +1,14 @@
+The general tab contains the cultural settings of the pack.
+
+ - Language Id - this field is a read-only, unique and internal system regional package ID. It is also displayed in the URL as a part of the query string.
+ - Pack Name - this field contains the English name of a regional package, or any label the administrator wants to use for the pack.
+ - Local Name - this field contains the name of the regional package in the native language of the pack. For example, for a German regional pack, this field would be set to 'Deutsch.'
+ - Icon URL - this field contains the URL of the image, which will be used to display the regional pack designator icon (usually a country flag, associated with the pack's language). This may be a remote URL, or a local URL, in which case it should be relative to the 'in-portal/themes/[current theme]' directory. The icon is necessary for the language selector in the default theme on the front end.
+ - Date Format - this field contains the date format of the regional pack. The information should be entered using standard programming codes for various formats of days, months and years. For more information about the date codes, please refer to PHP's web site: http://us2.php.net/manual/en/function.date.php . The example to the right of the field shows the resulting format of the current date. This example will update after you save the changes.
+ - Time Format - this field contains the time format of the regional pack. The information should be entered using standard programming codes for various formats of seconds, minutes and hours. For more information about the time codes, please refer to PHP's web site: http://us2.php.net/manual/en/function.date.php . The example to the right of the field shows the resulting format of the current time. This example will update after you save the changes.
+ - Decimal Point - this field contains the character that will be used for separating the decimal part from the whole number. For example, in the U.S. it is a period: '10.00' and in Europe , as well as other locals, it is a comma: '10,00'.
+ - Thousands Separator - this field contains the character that will be used for separating the thousands in numbers.
+ - Enabled - this field is the regional pack status flag.
+ - Primary - this flag indicates whether the pack is primary or not. If you check it while editing a non-primary pack, the pack that used to be primary will no longer be - only one primary pack can exist in a system.
+ - Copy Labels to this Language - this is not an actual attribute of the regional pack, like the other fields on this form. It is a function that will copy all language phrases from another pack, designated in the drop down, into the current pack. It is useful for creation of new regional packs.
+
\ No newline at end of file
Index: trunk/kernel/module_help/email_messages_edit.txt
===================================================================
diff -u
--- trunk/kernel/module_help/email_messages_edit.txt (revision 0)
+++ trunk/kernel/module_help/email_messages_edit.txt (revision 1716)
@@ -0,0 +1,8 @@
+An email notification has the following fields:
+
+ - Subject - this field contains the subject of the email notification.
+ - Send Email As - This flag designates the email to be either in Plain Text or in the HTML format. Some older email clients cannot display the HTML emails, although they can be formatted a lot better.
+ - Extra Mail Headers � this field contains additional email headers that you may want to add to the outgoing email notification. The mail headers need to be entered in exact accordance with the email regulations.
+ - Message -this field contains the body of the message. It is possible, and in many cases recommended, to use In-tags in side the email subject and body. The In-tags will allow you to create customized emails. For example, to create an email notification that will address the user by their first and last names, you would use the following In-tags: 'Dear <inp:touser _Field="FirstName" /> <inp:touser _Field="LastName" /> '.
+
+The other columns in the list display the information about the event itself, which cannot be changed from the Regional settings section. To change the event properties, please go to the appropriate Events section, for example, Structure & Data -> Email Setting for In-portal platform category events.
\ No newline at end of file
Index: trunk/core/module_help/email_messages_edit.txt
===================================================================
diff -u
--- trunk/core/module_help/email_messages_edit.txt (revision 0)
+++ trunk/core/module_help/email_messages_edit.txt (revision 1716)
@@ -0,0 +1,8 @@
+An email notification has the following fields:
+
+ - Subject - this field contains the subject of the email notification.
+ - Send Email As - This flag designates the email to be either in Plain Text or in the HTML format. Some older email clients cannot display the HTML emails, although they can be formatted a lot better.
+ - Extra Mail Headers � this field contains additional email headers that you may want to add to the outgoing email notification. The mail headers need to be entered in exact accordance with the email regulations.
+ - Message -this field contains the body of the message. It is possible, and in many cases recommended, to use In-tags in side the email subject and body. The In-tags will allow you to create customized emails. For example, to create an email notification that will address the user by their first and last names, you would use the following In-tags: 'Dear <inp:touser _Field="FirstName" /> <inp:touser _Field="LastName" /> '.
+
+The other columns in the list display the information about the event itself, which cannot be changed from the Regional settings section. To change the event properties, please go to the appropriate Events section, for example, Structure & Data -> Email Setting for In-portal platform category events.
\ No newline at end of file
Index: trunk/kernel/module_help/phrase_edit.txt
===================================================================
diff -u
--- trunk/kernel/module_help/phrase_edit.txt (revision 0)
+++ trunk/kernel/module_help/phrase_edit.txt (revision 1716)
@@ -0,0 +1,7 @@
+A label has the following fields:
+
+ - Phrase Id - this field is a read-only, unique and internal system language phrase ID.
+ - Label - this field contains the system name of the language phrase. This name is used in all templates, and in some settings. For visual convenience, all labels to be used on the front-end start with the prefix 'lu_', and all labels to be used in the administrative console start with the prefix 'la_'. The administrator may use their own conventions for naming the labels, however it is recommended to follow this naming rule to keep the regional pack compatible with the ones produced by Intechnic Corporation.
+ - Value - this field contains the label value in the local language of the pack. That is where the translation goes.
+ - Phrase Type - this field designates whether the label is to be used in the front-end, or in the administrative panel, or in both. Unlike the prefix of the label, this field must be set properly, as it drives the caching mechanism. There are two ways to edit multiple labels at once. The first way is to edit one label, and then to use the blue Previous and Next buttons to go back and forth between the labels. The same order as in the list will be used in this case. The second way is to select multiple labels at once, and click the edit button. As with any other second-level list, it is very important to remember, that your changes are not actually saved, until the regional package is saved. If you make changes to the labels, and then move to a different section without hitting Save on the regional package level, your changes will be lost.
+
\ No newline at end of file
Index: trunk/kernel/module_help/import_language.txt
===================================================================
diff -u
--- trunk/kernel/module_help/import_language.txt (revision 0)
+++ trunk/kernel/module_help/import_language.txt (revision 1716)
@@ -0,0 +1 @@
+'Import a regional pack' button (globe icon with a yellow arrow pointing down) allows the administrator to install a new pack, or update an existing one. Each pack can be downloaded and stored as a file. The format of the file is XML, and the name of the language pertaining to the pack is built into the file. Therefore, it is not necessary to select a pack when performing an import � its name will be automatically determined from the pack file. When importing a pack file, the administrator will need to upload it from the local computer by using the Browse button. Then the administrator should choose what types of phrases should be imported � �Front-end', �Administrator', or �Both'. In this case, �Both' does not mean �Front-end' and �Administrator', but it means the phrases of the type �Both' (which are used on the front-end and in the administrative console). The option �Overwrite Existing Phrases' will cause a replacement of all current phrases which are also found in the pack file being imported. It will not delete the language phrases, which are not found in the file. It is recommended to uncheck this option, to preserve any customized language values you may have. At the end of the import, a page with the result will be displayed. If a language import fails, this is usually due to the fact that there are not sufficient directory privileges on the �in-portal' directory, and the platform cannot upload the file for temporary use.
\ No newline at end of file
Index: trunk/core/module_help/phrase_edit.txt
===================================================================
diff -u
--- trunk/core/module_help/phrase_edit.txt (revision 0)
+++ trunk/core/module_help/phrase_edit.txt (revision 1716)
@@ -0,0 +1,7 @@
+A label has the following fields:
+
+ - Phrase Id - this field is a read-only, unique and internal system language phrase ID.
+ - Label - this field contains the system name of the language phrase. This name is used in all templates, and in some settings. For visual convenience, all labels to be used on the front-end start with the prefix 'lu_', and all labels to be used in the administrative console start with the prefix 'la_'. The administrator may use their own conventions for naming the labels, however it is recommended to follow this naming rule to keep the regional pack compatible with the ones produced by Intechnic Corporation.
+ - Value - this field contains the label value in the local language of the pack. That is where the translation goes.
+ - Phrase Type - this field designates whether the label is to be used in the front-end, or in the administrative panel, or in both. Unlike the prefix of the label, this field must be set properly, as it drives the caching mechanism. There are two ways to edit multiple labels at once. The first way is to edit one label, and then to use the blue Previous and Next buttons to go back and forth between the labels. The same order as in the list will be used in this case. The second way is to select multiple labels at once, and click the edit button. As with any other second-level list, it is very important to remember, that your changes are not actually saved, until the regional package is saved. If you make changes to the labels, and then move to a different section without hitting Save on the regional package level, your changes will be lost.
+
\ No newline at end of file
Index: trunk/kernel/module_help/export_language.txt
===================================================================
diff -u
--- trunk/kernel/module_help/export_language.txt (revision 0)
+++ trunk/kernel/module_help/export_language.txt (revision 1716)
@@ -0,0 +1 @@
+'Export' button (globe icon with a green arrow pointing out) allows the administrator to export a pack into a file. The file is first saved on the web server, and then it can be downloaded onto the workstation. The first field to enter is the file name. The full path is shown to the left of the file name input field. Please ensure that this directory is writable to the web server, otherwise the export will fail. Once the export is done, it will provide you with a link to download the file, or an error message, if the export failed.
\ No newline at end of file
Index: trunk/kernel/module_help/events_list.txt
===================================================================
diff -u
--- trunk/kernel/module_help/events_list.txt (revision 0)
+++ trunk/kernel/module_help/events_list.txt (revision 1716)
@@ -0,0 +1 @@
+ This tab contains the texts for email notifications sent out by the system when specific events occur. It contains all notification texts for the In-portal platform and the installed modules.
\ No newline at end of file
Index: trunk/core/module_help/import_language.txt
===================================================================
diff -u
--- trunk/core/module_help/import_language.txt (revision 0)
+++ trunk/core/module_help/import_language.txt (revision 1716)
@@ -0,0 +1 @@
+'Import a regional pack' button (globe icon with a yellow arrow pointing down) allows the administrator to install a new pack, or update an existing one. Each pack can be downloaded and stored as a file. The format of the file is XML, and the name of the language pertaining to the pack is built into the file. Therefore, it is not necessary to select a pack when performing an import � its name will be automatically determined from the pack file. When importing a pack file, the administrator will need to upload it from the local computer by using the Browse button. Then the administrator should choose what types of phrases should be imported � �Front-end', �Administrator', or �Both'. In this case, �Both' does not mean �Front-end' and �Administrator', but it means the phrases of the type �Both' (which are used on the front-end and in the administrative console). The option �Overwrite Existing Phrases' will cause a replacement of all current phrases which are also found in the pack file being imported. It will not delete the language phrases, which are not found in the file. It is recommended to uncheck this option, to preserve any customized language values you may have. At the end of the import, a page with the result will be displayed. If a language import fails, this is usually due to the fact that there are not sufficient directory privileges on the �in-portal' directory, and the platform cannot upload the file for temporary use.
\ No newline at end of file
Index: trunk/core/module_help/languages_edit_general.txt
===================================================================
diff -u
--- trunk/core/module_help/languages_edit_general.txt (revision 0)
+++ trunk/core/module_help/languages_edit_general.txt (revision 1716)
@@ -0,0 +1,14 @@
+The general tab contains the cultural settings of the pack.
+
+ - Language Id - this field is a read-only, unique and internal system regional package ID. It is also displayed in the URL as a part of the query string.
+ - Pack Name - this field contains the English name of a regional package, or any label the administrator wants to use for the pack.
+ - Local Name - this field contains the name of the regional package in the native language of the pack. For example, for a German regional pack, this field would be set to 'Deutsch.'
+ - Icon URL - this field contains the URL of the image, which will be used to display the regional pack designator icon (usually a country flag, associated with the pack's language). This may be a remote URL, or a local URL, in which case it should be relative to the 'in-portal/themes/[current theme]' directory. The icon is necessary for the language selector in the default theme on the front end.
+ - Date Format - this field contains the date format of the regional pack. The information should be entered using standard programming codes for various formats of days, months and years. For more information about the date codes, please refer to PHP's web site: http://us2.php.net/manual/en/function.date.php . The example to the right of the field shows the resulting format of the current date. This example will update after you save the changes.
+ - Time Format - this field contains the time format of the regional pack. The information should be entered using standard programming codes for various formats of seconds, minutes and hours. For more information about the time codes, please refer to PHP's web site: http://us2.php.net/manual/en/function.date.php . The example to the right of the field shows the resulting format of the current time. This example will update after you save the changes.
+ - Decimal Point - this field contains the character that will be used for separating the decimal part from the whole number. For example, in the U.S. it is a period: '10.00' and in Europe , as well as other locals, it is a comma: '10,00'.
+ - Thousands Separator - this field contains the character that will be used for separating the thousands in numbers.
+ - Enabled - this field is the regional pack status flag.
+ - Primary - this flag indicates whether the pack is primary or not. If you check it while editing a non-primary pack, the pack that used to be primary will no longer be - only one primary pack can exist in a system.
+ - Copy Labels to this Language - this is not an actual attribute of the regional pack, like the other fields on this form. It is a function that will copy all language phrases from another pack, designated in the drop down, into the current pack. It is useful for creation of new regional packs.
+
\ No newline at end of file
Index: trunk/core/module_help/export_language.txt
===================================================================
diff -u
--- trunk/core/module_help/export_language.txt (revision 0)
+++ trunk/core/module_help/export_language.txt (revision 1716)
@@ -0,0 +1 @@
+'Export' button (globe icon with a green arrow pointing out) allows the administrator to export a pack into a file. The file is first saved on the web server, and then it can be downloaded onto the workstation. The first field to enter is the file name. The full path is shown to the left of the file name input field. Please ensure that this directory is writable to the web server, otherwise the export will fail. Once the export is done, it will provide you with a link to download the file, or an error message, if the export failed.
\ No newline at end of file