mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-05-20 10:34:30 +00:00
doc: Remove themes.mdwn
Its information is merged into the online Developer Manual which will be imported here.
This commit is contained in:
parent
b4443330fb
commit
eb89f9fa80
1
LICENSES
1
LICENSES
@ -18,7 +18,6 @@ otherwise.
|
|||||||
- doc/hacking.mdwn :: -
|
- doc/hacking.mdwn :: -
|
||||||
- doc/header.html :: -
|
- doc/header.html :: -
|
||||||
- doc/Makefile :: -
|
- doc/Makefile :: -
|
||||||
- doc/themes.mdwn :: -
|
|
||||||
- static/themes/default/FreedomBox-Identity-Manual.pdf :: -
|
- 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]]
|
- static/themes/default/FreedomBox-Logo.7z :: [[http://thread.gmane.org/gmane.linux.debian.freedombox.user/4124/focus=4439][GPL3+/CC-BY-SA]]
|
||||||
- static/themes/default/readme.md :: [[file:themes/default/readme.md::This%20theme%20is%20free%20software%20offered%20to%20you%20under%20the%20terms%20of%20the%20GNU%20Affero%20General%20Public%20License,%20Version%203%20or%20later:][GNU Affero General Public License Version 3]]
|
- static/themes/default/readme.md :: [[file:themes/default/readme.md::This%20theme%20is%20free%20software%20offered%20to%20you%20under%20the%20terms%20of%20the%20GNU%20Affero%20General%20Public%20License,%20Version%203%20or%20later:][GNU Affero General Public License Version 3]]
|
||||||
|
|||||||
@ -6,7 +6,7 @@ PDFLATEX=pdflatex
|
|||||||
|
|
||||||
# List text files in the order in which you want them to appear in the
|
# List text files in the order in which you want them to appear in the
|
||||||
# complete manual:
|
# complete manual:
|
||||||
SOURCES=README.mdwn INSTALL.mdwn themes.mdwn hacking.mdwn COPYING.mdwn
|
SOURCES=README.mdwn INSTALL.mdwn hacking.mdwn COPYING.mdwn
|
||||||
MAN_SOURCES=$(patsubst COPYING.mdwn,copyright_notice00,$(SOURCES))
|
MAN_SOURCES=$(patsubst COPYING.mdwn,copyright_notice00,$(SOURCES))
|
||||||
|
|
||||||
NEWLINE_SOURCES=$(patsubst %,% oneline.txt,$(SOURCES))
|
NEWLINE_SOURCES=$(patsubst %,% oneline.txt,$(SOURCES))
|
||||||
|
|||||||
@ -1,51 +0,0 @@
|
|||||||
# Themes and Templates
|
|
||||||
|
|
||||||
The visual look and feel of the front end is described in theme files
|
|
||||||
while <a
|
|
||||||
href="https://docs.djangoproject.com/en/1.7/topics/templates/">Django
|
|
||||||
templates</a> handle layout.
|
|
||||||
|
|
||||||
## Themes
|
|
||||||
|
|
||||||
Themes are stored in `/themes`. Themes consist entirely of static
|
|
||||||
files (e.g. css, images and javascript) and templates. The default or
|
|
||||||
active theme is linked from `/static/default` and `templates/default`.
|
|
||||||
If your theme needs to change anything other than these items, you'll
|
|
||||||
need a module (perhaps you'll need both).
|
|
||||||
|
|
||||||
There is not currently any support for dynamically choosing a theme at
|
|
||||||
runtime, but it is theoretically possible.
|
|
||||||
|
|
||||||
## Templates
|
|
||||||
|
|
||||||
Plinth uses the Django templating system. Templates are stored in
|
|
||||||
`/templates`. Template requirements are not specified.
|
|
||||||
|
|
||||||
TODO: formalize the template spec so template writers know what they
|
|
||||||
need to implement and where they can deviate.
|
|
||||||
|
|
||||||
In this section, I'll attempt to document some of the assumptions the
|
|
||||||
program has about templates. The goal is that if you write a tempate
|
|
||||||
that implements the spec, it should work just fine.
|
|
||||||
|
|
||||||
### The Template Stack
|
|
||||||
|
|
||||||
The template is a hierarchical stack, where some templates extend on
|
|
||||||
others. At the base of this stack is `base.tmpl`. It should specify
|
|
||||||
sections as blocks (rather than using the variables). This allows
|
|
||||||
other templates to easily override the base template.
|
|
||||||
|
|
||||||
`err.tmpl` builds on top of `page.tmpl` by adding some decoration to
|
|
||||||
the title field.
|
|
||||||
|
|
||||||
### Layout
|
|
||||||
|
|
||||||
Plinth expects a `content` block. This is where the meat of the
|
|
||||||
content goes. It is the center pane in the default layout. There
|
|
||||||
is a `title` block that the program will fill with text describing
|
|
||||||
the current page. There are two bars on the left side: `submenu`
|
|
||||||
for the menu and `sidebar` where short help texts go.
|
|
||||||
The lowest layer in the navigation is `subsubmenu`, displayed on top
|
|
||||||
of the content pane.
|
|
||||||
|
|
||||||
All these items are inside of blocks and can be overwritten.
|
|
||||||
Loading…
x
Reference in New Issue
Block a user