@@ -136,7 +136,44 @@ Then run the administrator control panel and you should see the new app within *
Submit your working app to *https://code.freedombone.net/bashrc/freedombone/issues*, create a pull request or if you don't have an account there you can send patches via email to bob@freedombone.net.
* Translations
* Architecture
** Apps
Apps are scripts beginning with *src/freedombone-app-*. New scripts can be created with the template command described above. Each script contains a number of function interfaces which enable the app to be installed, removed, backed up and for logging to be turned on or off. The interfaces are:
#+BEGIN_SRC bash
install_appname
install_interactive_appname
configure_interactive_appname
remove_appname
upgrade_appname
backup_local_appname
restore_local_appname
backup_remote_appname
restore_remote_appname
logging_on_appname
logging_off_appname
add_user_appname
remove_user_appname
#+END_SRC
*install_interactive* and *configure_interactive* are only used by the dialog menu interface accessible via ssh.
*backup_remote* and *restore_local* are not currently implemented and are expected to be used by a future distributed network backup system.
** Web interface
The web interface consists of a set of html files within *webadmin/EN*. These use forms to reference some php files within *webadmin* and those generate files which are then picked up by a systemd daemon running in the background (webadmin.service) which is implemented by *src/freedombone-installer*.
Typically the daemon detects the presence of a file, extracts the variables from it, maybe does some additional validation and then does whatever it needs to do with those.
The separate daemon also avoids having php code making any direct changes to the underlying system, which could create security risks. The files created by the php scripts are very small and can typically be fully validated.
The user interface is regenerated by the function *install_web_admin* within *src/freedombone-utils-webadmin*.
** How translations happen
Translations are stored within *webadmin/translations*. When you select a language html files are copied from *webadmin/EN* and then the English strings are searched and replaced. Strings to be translated are indicated within the html files with the parameter *translate=*"*yes*".
Doing it this way avoids having duplicated versions of the many html files for different languages. See the *change_language* function within *src/freedombone-installer* for details of how this process works.
* Doing translations
These can be added or edited within the web UI. Navigate to http://freedombone/admin or its onion address, select *settings* then *language*. Select the language that you want to translate to then the *translate* button. In the right hand column you can then manually edit the translated strings. When you are done select the *update* button.
The format of the translation files is very simple. It's:
Apps are scripts beginning with <b>src/freedombone-app-</b>. New scripts can be created with the template command described above. Each script contains a number of function interfaces which enable the app to be installed, removed, backed up and for logging to be turned on or off. The interfaces are:
</p>
<divclass="org-src-container">
<preclass="src src-bash">install_appname
install_interactive_appname
configure_interactive_appname
remove_appname
upgrade_appname
backup_local_appname
restore_local_appname
backup_remote_appname
restore_remote_appname
logging_on_appname
logging_off_appname
add_user_appname
remove_user_appname
</pre>
</div>
<p>
<b>install_interactive</b> and <b>configure_interactive</b> are only used by the dialog menu interface accessible via ssh.
</p>
<p>
<b>backup_remote</b> and <b>restore_local</b> are not currently implemented and are expected to be used by a future distributed network backup system.
The web interface consists of a set of html files within <b>webadmin/EN</b>. These use forms to reference some php files within <b>webadmin</b> and those generate files which are then picked up by a systemd daemon running in the background (webadmin.service) which is implemented by <b>src/freedombone-installer</b>.
</p>
<p>
Typically the daemon detects the presence of a file, extracts the variables from it, maybe does some additional validation and then does whatever it needs to do with those.
</p>
<p>
The separate daemon also avoids having php code making any direct changes to the underlying system, which could create security risks. The files created by the php scripts are very small and can typically be fully validated.
</p>
<p>
The user interface is regenerated by the function <b>install_web_admin</b> within <b>src/freedombone-utils-webadmin</b>.
Translations are stored within <b>webadmin/translations</b>. When you select a language html files are copied from <b>webadmin/EN</b> and then the English strings are searched and replaced. Strings to be translated are indicated within the html files with the parameter <b>translate=</b>"<b>yes</b>".
</p>
<p>
Doing it this way avoids having duplicated versions of the many html files for different languages. See the <b>change_language</b> function within <b>src/freedombone-installer</b> for details of how this process works.
These can be added or edited within the web UI. Navigate to <ahref="http://freedombone/admin">http://freedombone/admin</a> or its onion address, select <b>settings</b> then <b>language</b>. Select the language that you want to translate to then the <b>translate</b> button. In the right hand column you can then manually edit the translated strings. When you are done select the <b>update</b> button.
</p>
...
...
@@ -393,9 +465,9 @@ If you prefer to edit the raw files within your own editor of choice they can be
If you want to make your own specially branded version of the mesh images, such as for a particular event, then to change the default desktop backgrounds edit the images within <b>img/backgrounds</b> and to change the available avatars and desktop icons edit the images within <b>img/avatars</b>. Re-create disk images using the instructions shown previously.
