- Éducation (fr)
The default language is English. You can switch to French by changing the
<Language>…<Language> entry in the
Parameters section of the configuration file (
<component name>.xcfg) from
fr. This two are currently the only available languages, but, by completing the locale file (
<component name>.xlcl), and modifying the configuration file accordingly, you can switch to whatever language you want.
It's also possible to change punctually the language, without having to modify the configuration file, as described below.
xdh(before the extension).
<Parameters> <Project Type="PROJECT_TYPE" Handling="HANDLING">PROJECT</Project> <Backend Type="BACKEND_TYPE">PARAMETERS</Backend> </Parameters>
PROJECT_TYPE: one of :
New: for a new (blank) project ;
Remote: for a user project stored in a file, which name and path is
PROJECT; can be blank.
Predefined: for the
PROJECTpredefined project, defined in the
Definitions/Projectssection ; can be blank.
HANDLING: one of :
Load: load the given project (prolog page is skipped),
Run: run the given project (both prolog and login pages are skipped),
Login: load the given project (prolog page is skipped), and displays only the login form on the login page.
BACKEND_TYPE: one of :
None: for no backend ;
Predefined: for a predefined backend, as defined in the
PARAMETERSis the id of the chosen backend,
FrontendPluginssection, to which
PARAMETERSis given as parameters.
Projectentry applies only to the frontends with desktop GUI, but the
Backendentry is also used for the Web (multi-user) and CLI frontends.
All command-line components from the Epeios project can have their command-line arguments be configured.
All this components read their parameters from an internal registry. This registry is filled with the content of the configuration file (and potential project file ; see below), but also with values depending from the command-line arguments. To set a value for a parameter, you can use this special option :
<path>, which is automatically prefixed with
Parameters/, is the path of the entry in the registry, and
<value> its value.
For example, there is a
Parameters/Language entry in the registry for the language to use, and which value is generally set in the configuration file. To switch temporarily to another language without having to modify the configuration file, simply add
--#Language=<language> option, where
<Language> is the language you want to switch to (given that the translations for this language exist in the locale file ; see above), when calling the component.
In the configuration file, you will find an
Arguments section. Each
Argument entry specifies a shortcut for either the command argument, an option, a flag or an argument which is neither of previous type of argument. The
Layouts section contains a
Layout entry for each command to make the link between an argument and the parameter it represents following its position.
Locale section contains the translations of the label and descriptions of the arguments, and is used for the generation of the help page of the component.
Some command-line components handle project files; in such a case, this is indicated in the help page (displayed with the
--help command) of the component. Such a project file has, by convention, a
.xprj extension, and following structure :
<?xml version="1.0" encoding="utf-8"?> <Projects> <Project target="<component name>"> ... </Project> </Projects>
In fact, all Epeios-related software components can handle project files, even when not mentioned in the help page. You only have to add a
--#Project[Type=“Remote”]=<project file name> option when launching the component, or set the
Parameters/Project[Type=“Remote”] entry in the configuration file to the project filename.
You can also define some projects in the
Definitions section of the configuration file, and then use one of them by adding a
--#Project[Type=“Predefined”]=<project id> option when launching the component, or set the
Parameters/Project[Type=“Predefined”] entry in the configuration file to the project id.
You can put in a project file the same entries as in the configuration file (although some entries don't make sense, for example the
Parameters/Project entry mentioned above). A project file can be seen as a remote configuration file. For example, there is mentioned above that you can change the language of a component by changing the
Parameters/Language entry in the configuration file. But you can also put this entry in a project file, without modifying the configuration file, so that the language of the component only changes when launched with this project file.
Entries in a project file supersede same entries in configuration file.
Setups (with final
s) is a section containing one or more
Setup (without final
s) sections, each with its own
id attribute value. Each
Setup contains a set of parameters, which, when owned by the selected setup, are entries that are considered as child of the
Parameters section of the configuration file.
To specify which setup to use, put its id as the value of the
Setup attribute of the
Parameters tag. This can be done directly in the configuration file, or through an option to type as command-line argument if defined in the
Arguments section (this should be indicated in the help page – command
--help – of the tool), or, as explained above, with the
--#@Setup=<id> option as a command-line argument, where
<id> is the setup's id.
A project file can contain its own
Entries of a selected setup supersede same entries in a project file and in the configuration file.
This is a section defined under the
Parameters section which deals with various debug features
This entry is usually given as a command-line argument (
<value> is empty, the content of all the registries is displayed.
You can also specify which registry content to display by giving as
<value> one or several of the following characters:
mfor the main registry; filled with the content of the configuration file,
lfor the lasting registry; filled with application data, and set by application,
pfor the project registry; filled by project file,
sfor the setup registry; filled with setup content, when one is specified,
afor the arguments registry; filled with the content of the command-line arguments,
rfor the runtime registry; set by the application, but lost once the application is terminated.
--#Debug/DumpRegistries=am displays the content of the argument registry and the main registry.
This entry is usually given as a command-line argument (
<value> is empty, the content of all the locales is displayed.
You can also specify which locale content to display by giving as
<value> one or several of the following characters :
mfor the main locale.
cfor the configuration locale,
pfor the project locale,
--#Debug/DumpLocales=mp displays the content of the main locale and the project locale.
Configuration/locale/project files go through the Epeios XML preprocessor, which is described on the XPPq dedicated page, before handled by the component. So, all the Epeios XML preprocessor directives can be used in this files. This allows in particular to split each of them in several sub-files.