| HelpSet Table of Contents | Back to Project Home Page |
The Translatable Strings File is a configuration file called trans_strings.inc, located in your Project Hirtius application directory (typically /srv/www/htdocs/hirtius/). As the name implies, this file contains a translated version of all static strings needed by LaTeX-based reports and dynamic DB contents, for all supported languages (their list is defined in the Global Definitions File). For more details on international language support in Hirtius, please refer to Language Support in Reports.
There should not be any need for you to edit the contents of the present configuration file, unless you want to add support for a new language* (or you want to customize some of the provided static contents). When editing this file, please use a UTF-8 compatible editor.
*) If you plan to do this, please first read the file called new_report_lang.txt, provided in the docs/ folder of the distribution archive, as there are more steps involved.
The Translatable Strings File contents is organized into several sections, introduced by PHP comment lines.
| $ltx_project_report_title | (array) | Project Report title, used by the Projects Report Page. |
| $ltx_slide_index_title | (array) | Slide Index title, used by the Slides Report Page when requesting the Slide Index report format. |
| $ltx_slide_book_title | (array) | Slide Book title, used by the Slides Report Page when requesting the Slide Book report format. |
| $ltx_slide_index_abstract | (array) | Template text for the abstract used by the
Slides Report Page when the Slide Index format has been requested. To be specified as a 'printf()' format string. |
| $intl_date_formats | (MDarray) | Language code and format string to use for
internationalised date/time strings (then inserted in the abstract). To be specified as a PHP 'IntlDateFormatter' pattern. |
| $ltx_project_report_clsdmsg | (array) | Template text for the extra message appended to the
abstract used by the Projects Report Page when the Project record has been
marked as "Closed". To be specified as a 'printf()' formatter string. |
| $ltx_num_slides_listed | (array) | Used when displaying the number of Slides listed in a Slide Index or Slide Book report. Called from the Slides Report Page. |
| $ltx_title_as_of | (array) | Used by the function that formats all Titles belonging to an Individual as a LaTeX bulleted list (ListTitlesLTX()). |
| $ltx_ind_alive | (array) | Used by several functions that display individuals or their meta-data in LaTeX format (ListChildrenLTX() and latexify_IND()). |
| $ltx_obj_names | (array) | Used by latexify_DIA() only at present. |
All of these are typically used by the latexify_*() functions and serve as description to the related field contents.
| $ltx_fn_location | (array) | Slide or Event location data. |
| $ltx_fn_tray | (array) | Slide tray ID. |
| $ltx_fn_shotdate | (array) | Slide shot date. |
| $ltx_fn_subjdate | (array) | Slide or Source subject date. |
| $ltx_fn_type | (array) | Slide type. |
| $ltx_fn_pub | (array) | Whether or not the present Slide or Source can be freely published. |
| $ltx_fn_cblmb | (array) | 'Created by' and 'Last modified by' information (all object types). |
| $ltx_fn_vcblmb | (array) | 'Version number', 'Created by' and 'Last modified by' information (Tiddlers only). |
| $ltx_ind_sex | (array) | Single-letter representation for the sex of an Individual. |
These are all textual descriptions of the sort order used for Slide Index or Slide Book reports in LaTeX format. They will be called from the Slides Report Page and be concatenated to the report title.
| $ltx_key_location | (array) | Order by location (i.e. location + country + description #1 + description #2). |
| $ltx_key_slide | (array) | Order by slide ID. |
| $ltx_key_tray | (array) | Order by tray ID. |
| $ltx_key_shotdate | (array) | Order by shot date. |
All of these are typically used by the latexify_*() functions and serve as headings for the related object meta-data.
| $ltx_md_reading | (array) | Slide or Source reading (i.e. literal transcription using diacritics). |
| $ltx_md_transcript | (array) | Slide or Source transcription (i.e. textual transcription without diacritics). |
| $ltx_md_translation | (array) | Slide or Source translation. |
| $ltx_md_references | (array) | Bibliographical references (including Web links). All object types. |
| $ltx_md_sources | (array) | Source references. All object types. |
| $ltx_md_events | (array) | Related events (Slides, Sources and Families). |
| $ltx_md_bio | (array) | Biography (i.e. equivalent to "Related events" for Individuals). |
| $ltx_md_altnam | (array) | Alternate names (Individuals). |
| $ltx_md_titles | (array) | Titles (Individuals). |
| $ltx_md_children | (array) | Children (Individuals). |
| $ltx_md_lineage | (array) | Lineage (Individuals). |
| $start_here_contents | (array) | Textual contents of the default Tiddler called "StartHere". This entry is automatically created at Project creation. It gives users a quick reminder on the use of the TiddlyWiki interface, and pointers to more detailed help. |
| $tw_project_scope_contents | (array) | Textual contents of the default Tiddler called "ProjectScope". |
| $birth_string | (array) | Template text used when generating the description field of birth events (= auto-events). |
| $death_string | (array) | Template text used when generating the description field of death events (= auto-events). |
| $CC_string | (array) | Template text used when generating the description field of couple creation events (= auto-events). |
Project Hirtius, © Les Ateliers du Héron, 2012.
Last updated: Wednesday, Feb. 5, 2025.
| HelpSet Table of Contents | Back to Project Home Page |