From eb89f9fa80ca3757cd53741978d482302699c002 Mon Sep 17 00:00:00 2001 From: Sunil Mohan Adapa Date: Sun, 13 Sep 2015 13:21:31 +0530 Subject: [PATCH] doc: Remove themes.mdwn Its information is merged into the online Developer Manual which will be imported here. --- LICENSES | 1 - doc/Makefile | 2 +- doc/themes.mdwn | 51 ------------------------------------------------- 3 files changed, 1 insertion(+), 53 deletions(-) delete mode 100644 doc/themes.mdwn diff --git a/LICENSES b/LICENSES index 746a8eec7..cbda19bd9 100644 --- a/LICENSES +++ b/LICENSES @@ -18,7 +18,6 @@ otherwise. - doc/hacking.mdwn :: - - doc/header.html :: - - doc/Makefile :: - -- 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]] - 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]] diff --git a/doc/Makefile b/doc/Makefile index dd0923b62..476d00d8b 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -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 COPYING.mdwn +SOURCES=README.mdwn INSTALL.mdwn hacking.mdwn COPYING.mdwn MAN_SOURCES=$(patsubst COPYING.mdwn,copyright_notice00,$(SOURCES)) NEWLINE_SOURCES=$(patsubst %,% oneline.txt,$(SOURCES)) diff --git a/doc/themes.mdwn b/doc/themes.mdwn deleted file mode 100644 index 3f5ae78c4..000000000 --- a/doc/themes.mdwn +++ /dev/null @@ -1,51 +0,0 @@ -# Themes and Templates - -The visual look and feel of the front end is described in theme files -while Django -templates 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.