nik/FreedomBox
1
0
Fork 0
mirror of https://github.com/freedombox/FreedomBox.git synced 2026-01-21 07:55:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: Remove modules.mdwn

Browse Source 
Its information is merged into the online Developer Manual which will be
imported here.
This commit is contained in:
Sunil Mohan Adapa 2015-09-13 12:13:38 +05:30 committed by James Valleroy
parent 3ba786275e
commit b4443330fb
3 changed files with 1 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
LICENSES
View File

@ -18,7 +18,6 @@ otherwise.
- doc/hacking.mdwn :: -
- doc/header.html :: -
- doc/Makefile :: -
- doc/modules.mdwn :: -
- doc/themes.mdwn :: -
- static/themes/default/FreedomBox-Identity-Manual.pdf :: -
- static/themes/default/FreedomBox-Logo.7z :: [[http://thread.gmane.org/gmane.linux.debian.freedombox.user/4124/focus=4439][GPL3+/CC-BY-SA]]

2
doc/Makefile
View File

@ -6,7 +6,7 @@ PDFLATEX=pdflatex
# List text files in the order in which you want them to appear in the
# complete manual:
SOURCES=README.mdwn INSTALL.mdwn themes.mdwn hacking.mdwn modules.mdwn COPYING.mdwn
SOURCES=README.mdwn INSTALL.mdwn themes.mdwn hacking.mdwn COPYING.mdwn
MAN_SOURCES=$(patsubst COPYING.mdwn,copyright_notice00,$(SOURCES))
NEWLINE_SOURCES=$(patsubst %,% oneline.txt,$(SOURCES))

38
doc/modules.mdwn
View File

@ -1,38 +0,0 @@
# Modules
Almost all of the front end's functionality is contained in small,
separate modules that reside in the directory tree beneath
`plinth/modules`. Some are installed by default, some are
required for operation, and some are entirely optional.
## Installing and Loading Modules
Eventually, the goal is for module to be separate Debian package so
installation is as simple as `aptitude install freedombox-foo`. As an
intermediate step, we'll start scripting module installation. But
until then, we can install them manually.
A Plinth module is a Django application with some additional Plinth
specific extensions. To enable a module, create a file containing its
Python module path into `data/etc/plinth/modules-enabled/`. During
installation, this file will be copied to
`/etc/plinth/modules-enabled/`. The file in `/etc` will be read during
normal execution of Plinth. The file in `data/etc/` in the source code
directory will be used when running Plinth under the run-without-install
mode. Plinth will read the module path from the file in one of these
paths during start-up and configure Django to use it as a Django
application. With this approach, you can install your Plinth module
anywhere on the system and use it in Plinth (just like in Django).
TODO: automatically prune dead links to clear out old module installs.
This is something the install scripts should do.
## Coding Practices for Modules
All the
[coding practices for hacking on the front end](#hacking_code_practices)
also apply to modules. In addition, I try to stick to the other
practices listed in this section.
* Every module should `from gettext import gettext as _` and wrap
displayed strings with _().