The djula Reference Manual

4.1.1 djula/djula.asd

Source

djula.asd.

Parent Component

djula (system).

ASDF Systems

djula.

---

4.1.2 djula/src/compiler.lisp

Dependencies

• lexer.lisp (file).
• parser.lisp (file).
• template-store.lisp (file).

Source

djula.asd.

Parent Component

src (module).

Public Interface

• *current-compiler* (special variable).
• *recompile-templates-on-change* (special variable).
• compile-template (generic function).
• compile-template* (function).
• compiler (class).
• fragment-compiler (reader method).
• initialize-instance (method).
• print-object (method).
• render-template* (function).
• string (function).
• toplevel-compiler (class).

Internals

• compile-string (function).
• compile-template-file (method).
• compile-token (function).
• compiled-template (reader method).
• (setf compiled-template) (writer method).
• compiled-template (class).
• linked-templates (reader method).
• (setf linked-templates) (writer method).
• template-changed (method).
• template-file (reader method).
• (setf template-file) (writer method).
• template-file-write-date (reader method).
• (setf template-file-write-date) (writer method).

---

4.1.3 djula/src/conditions.lisp

Dependency

specials.lisp (file).

Source

djula.asd.

Parent Component

src (module).

Internals

• render-error-template (function).
• template-error (function).
• template-error (condition).
• template-error* (function).
• template-error-string (function).
• template-error-string* (function).
• with-template-error (macro).

---

4.1.4 djula/src/filters.lisp

Dependency

pipeline.lisp (file).

Source

djula.asd.

Parent Component

src (module).

Public Interface

• add (function).
• addslashes (function).
• capfirst (function).
• cut (function).
• date (function).
• datetime (function).
• default (function).
• divisibleby (function).
• escape (function).
• first (function).
• force-escape (function).
• format (function).
• join (function).
• last (function).
• length (function).
• length_is (function).
• linebreaks (function).
• linebreaksbr (function).
• lisp (function).
• lower (function).
• make_list (function).
• replace (function).
• rest (function).
• reverse (function).
• safe (function).
• scan (function).
• slice (function).
• sort (function).
• time (function).
• truncatechars (function).
• upper (function).
• urlencode (function).
• with (function).

Internals

apply-filters (function).

---

4.1.5 djula/src/lexer.lisp

Dependencies

• pipeline.lisp (file).
• util.lisp (file).

Source

djula.asd.

Parent Component

src (module).

Public Interface

verbatim (function).

Internals

• get-closing-delimiter (function).
• next-tag (function).
• parse-tag (function).
• parse-template-string (function).
• token-type (function).

---

4.1.6 djula/src/locale.lisp

Dependency

lexer.lisp (file).

Source

djula.asd.

Parent Component

src (module).

Public Interface

• directory-translate-strings (function).
• file-template-translate-strings (function).
• locale-list (function).
• update-caveman-project (function).
• update-locale-list (function).
• update-project (function).

Internals

• +whitespace+ (constant).
• alter-pathname (function).
• backup-file (function).
• parse-template-string (function).
• string-string-p (function).
• string-translate-strings (function).
• trim-whitespace (function).

---

4.1.7 djula/src/packages.lisp

Source

djula.asd.

Parent Component

src (module).

Packages

• djula.token-processors.
• djula.tag-compilers.
• djula.
• djula.locale.
• djula.tag-processors.
• djula.token-compilers.
• djula.filters.
• djula.unparsed-tag-processors.

---

4.1.8 djula/src/parser.lisp

Dependency

pipeline.lisp (file).

Source

djula.asd.

Parent Component

src (module).

Public Interface

• comment (function).
• string (function).

Internals

• process-token (function).
• process-tokens (function).

---

4.1.9 djula/src/pipeline.lisp

Dependency

conditions.lisp (file).

Source

djula.asd.

Parent Component

src (module).

Public Interface

• def-filter (macro).
• def-tag-compiler (macro).

Internals

• def-delimited-tag (macro).
• def-tag-processor (macro).
• def-token-compiler (macro).
• def-token-processor (macro).
• def-unparsed-tag-processor (macro).
• find-filter (function).
• find-tag-compiler (function).
• find-tag-processor (function).
• find-token-compiler (function).
• find-token-processor (function).
• find-unparsed-tag-processor (function).

---

4.1.10 djula/src/specials.lisp

Dependency

packages.lisp (file).

Source

djula.asd.

Parent Component

src (module).

Public Interface

• *allow-include-roots* (special variable).
• *catch-template-errors-p* (special variable).
• *current-language* (special variable).
• *default-language* (special variable).
• *default-template-arguments* (special variable).
• *djula-execute-package* (special variable).
• *elision-string* (special variable).
• *error-template* (special variable).
• *fancy-debug-p* (special variable).
• *fancy-error-template-p* (special variable).
• *verbose-errors-p* (special variable).

Internals

• *accumulated-javascript-strings* (special variable).
• *block-alist* (special variable).
• *current-block* (special variable).
• *current-template* (special variable).
• *eval-lisp-tags* (special variable).
• *linked-templates* (special variable).
• *template-arguments* (special variable).

---

4.1.11 djula/src/tags.lisp

Dependencies

• tag.lisp (file).
• variables.lisp (file).

Source

djula.asd.

Parent Component

src (module).

Public Interface

• *djula-emptyp* (special variable).
• almost-parsed-ifequal (function).
• almost-parsed-ifnotequal (function).
• autoescape (function).
• block (function).
• comment (function).
• comment-tag (function).
• cycle (function).
• debug (function).
• emit-js (function).
• endautoescape (function).
• endblock (function).
• endcomment (function).
• endfilter (function).
• endfor (function).
• endif (function).
• endifchanged (function).
• endifequal (function).
• endifnotequal (function).
• endjs-script (function).
• extends (function).
• filter (function).
• firstof (function).
• for (function).
• if (function).
• ifchanged (function).
• ifequal (function).
• ifnotequal (function).
• include (function).
• js (function).
• js-script (function).
• lisp (function).
• parsed-autoescape (function).
• parsed-block (function).
• parsed-filter (function).
• parsed-for (function).
• parsed-if (function).
• parsed-ifchanged (function).
• parsed-ifequal (function).
• parsed-js (function).
• parsed-js-script (function).
• parsed-lisp (function).
• parsed-set (function).
• semi-parsed-filter (function).
• semi-parsed-if (function).
• semi-parsed-ifequal (function).
• semi-parsed-ifnotequal (function).
• semi-parsed-js-script (function).
• set (function).
• set-language (function).
• set-package (function).
• show-language (function).
• ssi (function).
• super (function).
• templatetag (function).

Internals

• and-bterm (function).
• bliteral (function).
• boolean-comparison (function).
• boolexp-factor (function).
• boolexp-parser (function).
• bterm (function).
• comparison-operator-parser (function).
• compile-boolexp (function).
• compile-logical-statement (function).
• djula-emptyp (function).
• in-list (function).
• iterable-list (generic function).
• not-bfactor (function).
• or-bterm (function).
• parse-if-clause (function).
• print-debugging-information (function).
• print-fancy-debugging-information (function).
• process-ifequal-args (function).
• remove-first (function).
• split-if-clause (function).
• transform (function).
• with-file-handler (macro).

---

4.1.12 djula/src/tag.lisp

Dependency

pipeline.lisp (file).

Source

djula.asd.

Parent Component

src (module).

Public Interface

• tag (function).
• tag (function).
• unparsed-tag (function).

Internals

• find-end-tag (function).
• find-end-tag-nested (function).
• parse-rest-of-tag (function).
• semi-parse-tag (function).

---

4.1.13 djula/src/template-store.lisp

Dependency

specials.lisp (file).

Source

djula.asd.

Parent Component

src (module).

Public Interface

• *current-store* (special variable).
• add-template-directory (function).
• fetch-template (generic function).
• fetch-template* (function).
• filesystem-template-store (class).
• find-template (generic function).
• find-template* (function).
• list-asdf-system-templates (function).
• memory-template-store (class).
• template-store (class).

Internals

• search-path (reader method).
• (setf search-path) (writer method).

---

4.1.14 djula/src/translation.lisp

Dependencies

• specials.lisp (file).
• pipeline.lisp (file).

Source

djula.asd.

Parent Component

src (module).

Public Interface

• *translation-backend* (special variable).
• trans (function).
• trans (function).
• translate (function).
• translation (function).
• unparsed-translation (function).

Internals

• *gettext-domain* (special variable).
• *untranslated-messages* (special variable).
• *warn-on-untranslated-messages* (special variable).
• backend-translate (generic function).
• format-translation (function).
• resolve-plist (function).

---

4.1.15 djula/src/util.lisp

Dependency

packages.lisp (file).

Source

djula.asd.

Parent Component

src (module).

Public Interface

• template-print-object (generic function).
• url-encode (function).
• url-encode-path (function).

Internals

• accum (macro).
• escape-for-html (function).
• join (function).
• truncate-characters (function).

---

4.1.16 djula/src/variables.lisp

Dependencies

• specials.lisp (file).
• util.lisp (file).

Source

djula.asd.

Parent Component

src (module).

Public Interface

• *auto-escape* (special variable).
• unparsed-variable (function).
• variable (function).

Internals

• apply-keys/indexes (function).
• escape-string-split (function).
• get-variable (function).
• integer-or-keyword (function).
• parse-filter-string (function).
• parse-variable-clause (function).
• parse-variable-phrase (function).
• resolve-variable-phrase (function).

---

6.1.1 Special variables

Special Variable: *allow-include-roots* ¶

A list of folder names that are allowed to be included by SSI.

Package

djula.

Source

specials.lisp.

Special Variable: *auto-escape* ¶

Controls auto escaping.

Package

djula.

Source

variables.lisp.

Special Variable: *catch-template-errors-p* ¶

When enabled, caught errors during the rendering of the template are written to the output instead of being handled by the lisp listener.

Package

djula.

Source

specials.lisp.

Special Variable: *current-compiler* ¶

The current template compiler.

Package

djula.

Source

compiler.lisp.

Special Variable: *current-language* ¶

Package

djula.

Source

specials.lisp.

Special Variable: *current-store* ¶

The currently in-use template store. Defaults to a FILESYSTEM-TEMPLATE-STORE.

Package

djula.

Source

template-store.lisp.

Special Variable: *default-language* ¶

The default i18n language. English is the default.

Package

djula.

Source

specials.lisp.

Special Variable: *default-template-arguments* ¶

List of arguments available for all templates. Add arguments to this list if you want them to be available in every template. This is a plist, so use getf to add arguments, like: (setf (getf djula:*default-template-arguments* :foo) ’some-value)

Package

djula.

Source

specials.lisp.

Special Variable: *djula-emptyp* ¶

Change this to customize how djula decides if some value is empty or not

Package

djula.

Source

tags.lisp.

Special Variable: *djula-execute-package* ¶

The package in which template expressions are evaluated.

Package

djula.

Source

specials.lisp.

Special Variable: *elision-string* ¶

The string to be used by ‘truncatechars’ at the end of truncated strings.

Package

djula.

Source

specials.lisp.

Special Variable: *error-template* ¶

The error template used by ‘render-error-template’.

Package

djula.

Source

specials.lisp.

Special Variable: *fancy-debug-p* ¶

When enabled, displays fancy html based debugging information for the {% debug %} tag.

Package

djula.

Source

specials.lisp.

Special Variable: *fancy-error-template-p* ¶

When enabled, show a fancy template when an error ocurrs.

Package

djula.

Source

specials.lisp.

Special Variable: *recompile-templates-on-change* ¶

When enabled, templates are recompiled if they have changed on disk, before they are rendered.
This is the default and convenient for development. For production, this can be turned off and the filesystem check is bypassed.

Package

djula.

Source

compiler.lisp.

Special Variable: *translation-backend* ¶

The translation backend. One of :locale, :gettext

Package

djula.

Source

translation.lisp.

Special Variable: *verbose-errors-p* ¶

When enabled, errors are displayed more verbosely. Good for debugging.

Package

djula.

Source

specials.lisp.

---

6.1.2 Macros

Macro: def-filter (name args &body body) ¶

Define a Djula filter.
NAME is the name of the filter.
ARGS is the list of arguments of the filter. BODY is the implementation of the filter.

Package

djula.

Source

pipeline.lisp.

Macro: def-tag-compiler (name args &body body) ¶

Define a Djula tag compiler.
NAME is the name of the tag.
ARGS is the list of arguments required. BODY is the tag compilation implementation.

Package

djula.

Source

pipeline.lisp.

---

6.1.3 Ordinary functions

Function: add (it n) ¶

Package

djula.filters.

Source

filters.lisp.

Function: add-template-directory (directory &optional template-store) ¶

Adds DIRECTORY to the search path of the TEMPLATE-STORE.

Package

djula.

Source

template-store.lisp.

Function: addslashes (it) ¶

Package

djula.filters.

Source

filters.lisp.

Function: almost-parsed-ifequal (&rest arg-list0) ¶

Package

djula.token-processors.

Source

tags.lisp.

Function: almost-parsed-ifnotequal (&rest arg-list0) ¶

Package

djula.token-processors.

Source

tags.lisp.

Function: autoescape (&rest arg-list0) ¶

Package

djula.tag-processors.

Source

tags.lisp.

Function: block (&rest arg-list0) ¶

Package

djula.tag-processors.

Source

tags.lisp.

Function: capfirst (it) ¶

Package

djula.filters.

Source

filters.lisp.

Function: comment (&rest arg-list0) ¶

:COMMENT tokens are removed by PROCESS-TOKENS

Package

djula.token-processors.

Source

parser.lisp.

Function: comment (&rest arg-list0) ¶

Package

djula.tag-processors.

Source

tags.lisp.

Function: comment-tag (&rest arg-list0) ¶

Package

djula.token-processors.

Source

tags.lisp.

Function: compile-template* (name) ¶

Compiles template NAME with compiler in *CURRENT-COMPILER*.

Package

djula.

Source

compiler.lisp.

Function: cut (it charstring) ¶

Package

djula.filters.

Source

filters.lisp.

Function: cycle (&rest arg-list0) ¶

Package

djula.tag-compilers.

Source

tags.lisp.

Function: date (it &optional format) ¶

Package

djula.filters.

Source

filters.lisp.

Function: datetime (it &optional format) ¶

Package

djula.filters.

Source

filters.lisp.

Function: debug (&rest arg-list0) ¶

Package

djula.tag-compilers.

Source

tags.lisp.

Function: default (it default) ¶

Package

djula.filters.

Source

filters.lisp.

Function: directory-translate-strings (dir &key recurse) ¶

given a directory of djula html template files find all the strings to be translated

Package

djula.locale.

Source

locale.lisp.

Function: divisibleby (it number) ¶

Package

djula.filters.

Source

filters.lisp.

Function: emit-js (&rest arg-list0) ¶

Package

djula.tag-compilers.

Source

tags.lisp.

Function: endautoescape (&rest arg-list26) ¶

Package

djula.tag-compilers.

Source

tags.lisp.

Function: endblock (&rest arg-list26) ¶

Package

djula.tag-compilers.

Source

tags.lisp.

Function: endcomment (&rest arg-list26) ¶

Package

djula.tag-compilers.

Source

tags.lisp.

Function: endfilter (&rest arg-list26) ¶

Package

djula.tag-compilers.

Source

tags.lisp.

Function: endfor (&rest arg-list26) ¶

Package

djula.tag-compilers.

Source

tags.lisp.

Function: endif (&rest arg-list26) ¶

Package

djula.tag-compilers.

Source

tags.lisp.

Function: endifchanged (&rest arg-list26) ¶

Package

djula.tag-compilers.

Source

tags.lisp.

Function: endifequal (&rest arg-list26) ¶

Package

djula.tag-compilers.

Source

tags.lisp.

Function: endifnotequal (&rest arg-list26) ¶

Package

djula.tag-compilers.

Source

tags.lisp.

Function: endjs-script (&rest arg-list26) ¶

Package

djula.tag-compilers.

Source

tags.lisp.

Function: escape (it) ¶

Package

djula.filters.

Source

filters.lisp.

Function: extends (&rest arg-list0) ¶

Package

djula.tag-processors.

Source

tags.lisp.

Function: fetch-template* (key) ¶

Return the text of a template fetched from the *CURRENT-STORE*.

Package

djula.

Source

template-store.lisp.

Function: file-template-translate-strings (file) ¶

given a djula html template file, find all the strings to be translated

Package

djula.locale.

Source

locale.lisp.

Function: filter (&rest arg-list0) ¶

Package

djula.unparsed-tag-processors.

Source

tags.lisp.

Function: find-template* (name &optional error-p) ¶

Find template with name NAME in *CURRENT-STORE*.
If the template is not found, an error is signaled depending on ERROR-P argument value.

Package

djula.

Source

template-store.lisp.

Function: first (it) ¶

Package

djula.filters.

Source

filters.lisp.

Function: firstof (&rest arg-list0) ¶

Package

djula.tag-compilers.

Source

tags.lisp.

Function: for (&rest arg-list0) ¶

Package

djula.tag-processors.

Source

tags.lisp.

Function: force-escape (it) ¶

Package

djula.filters.

Source

filters.lisp.

Function: format (it fmt) ¶

Package

djula.filters.

Source

filters.lisp.

Function: if (&rest arg-list0) ¶

Package

djula.tag-processors.

Source

tags.lisp.

Function: ifchanged (&rest arg-list0) ¶

Package

djula.tag-processors.

Source

tags.lisp.

Function: ifequal (&rest arg-list0) ¶

Package

djula.unparsed-tag-processors.

Source

tags.lisp.

Function: ifnotequal (&rest arg-list0) ¶

Package

djula.unparsed-tag-processors.

Source

tags.lisp.

Function: include (&rest arg-list0) ¶

when compiled, :INCLUDE tags first compile the template pointed to by ‘PATH’ then they compile into a function that simply calls this function with *TEMPLATE-ARGUMENTS*

‘PARAMETERS’ should have the form (:param1 value1 :param2 value2 ...). If given, they are prepended to *TEMPLATE-ARGUMENTS*

Package

djula.tag-compilers.

Source

tags.lisp.

Function: join (it sep) ¶

Package

djula.filters.

Source

filters.lisp.

Function: js (&rest arg-list0) ¶

Package

djula.unparsed-tag-processors.

Source

tags.lisp.

Function: js-script (&rest arg-list0) ¶

Package

djula.tag-processors.

Source

tags.lisp.

Function: last (it) ¶

Package

djula.filters.

Source

filters.lisp.

Function: length (it) ¶

Package

djula.filters.

Source

filters.lisp.

Function: length_is (it length) ¶

Package

djula.filters.

Source

filters.lisp.

Function: linebreaks (it) ¶

Package

djula.filters.

Source

filters.lisp.

Function: linebreaksbr (it) ¶

Package

djula.filters.

Source

filters.lisp.

Function: lisp (it &optional lisp-string) ¶

Package

djula.filters.

Source

filters.lisp.

Function: lisp (&rest arg-list0) ¶

Package

djula.unparsed-tag-processors.

Source

tags.lisp.

Function: list-asdf-system-templates (asdf-system component) ¶

List djula templates in ASDF-SYSTEM at COMPONENT. A list of template PATHNAMEs is returned.

Package

djula.

Source

template-store.lisp.

Function: locale-list (message-file translate-strings) ¶

return an augmented dictionary of a cl-locale message file with the translate strings. Does not update the file.

Package

djula.locale.

Source

locale.lisp.

Function: lower (it) ¶

Package

djula.filters.

Source

filters.lisp.

Function: make_list (it) ¶

Package

djula.filters.

Source

filters.lisp.

Function: parsed-autoescape (&rest arg-list0) ¶

Package

djula.token-compilers.

Source

tags.lisp.

Function: parsed-block (&rest arg-list0) ¶

Package

djula.token-compilers.

Source

tags.lisp.

Function: parsed-filter (&rest arg-list0) ¶

Package

djula.token-compilers.

Source

tags.lisp.

Function: parsed-for (&rest arg-list0) ¶

Package

djula.token-compilers.

Source

tags.lisp.

Function: parsed-if (&rest arg-list0) ¶

:PARSED-IF tags are compiled into a function that executes the {% if %} clause

Package

djula.token-compilers.

Source

tags.lisp.

Function: parsed-ifchanged (&rest arg-list0) ¶

Package

djula.token-compilers.

Source

tags.lisp.

Function: parsed-ifequal (&rest arg-list0) ¶

Package

djula.token-compilers.

Source

tags.lisp.

Function: parsed-js (&rest arg-list0) ¶

Package

djula.token-compilers.

Source

tags.lisp.

Function: parsed-js-script (&rest arg-list0) ¶

Package

djula.token-compilers.

Source

tags.lisp.

Function: parsed-lisp (&rest arg-list0) ¶

Package

djula.token-compilers.

Source

tags.lisp.

Function: parsed-set (&rest arg-list0) ¶

Package

djula.token-compilers.

Source

tags.lisp.

Function: render-template* (template &optional stream &rest *template-arguments*) ¶

Render TEMPLATE into STREAM passing *TEMPLATE-ARGUMENTS*.

Package

djula.

Source

compiler.lisp.

Function: replace (it regex) ¶

Package

djula.filters.

Source

filters.lisp.

Function: rest (list) ¶

Package

djula.filters.

Source

filters.lisp.

Function: reverse (it) ¶

Package

djula.filters.

Source

filters.lisp.

Function: safe (it) ¶

Package

djula.filters.

Source

filters.lisp.

Function: scan (it regex) ¶

Package

djula.filters.

Source

filters.lisp.

Function: semi-parsed-filter (&rest arg-list0) ¶

Package

djula.tag-processors.

Source

tags.lisp.

Function: semi-parsed-if (&rest arg-list0) ¶

:SEMI-PARSED-IF tags are parsed into :PARSED-IF tags. a :PARSED-IF tag looks more ike a traditional IF statement [a test, an "if" branch, and an "else" branch], so :SEMI-PARSED-IF has to look for the :ELSE token to split up ‘CLAUSE’

Package

djula.token-processors.

Source

tags.lisp.

Function: semi-parsed-ifequal (&rest arg-list0) ¶

Package

djula.tag-processors.

Source

tags.lisp.

Function: semi-parsed-ifnotequal (&rest arg-list0) ¶

Package

djula.tag-processors.

Source

tags.lisp.

Function: semi-parsed-js-script (&rest arg-list0) ¶

Package

djula.token-processors.

Source

tags.lisp.

Function: set (&rest arg-list0) ¶

Package

djula.unparsed-tag-processors.

Source

tags.lisp.

Function: set-language (&rest arg-list0) ¶

:SET-LANGUAGE tags are compiled into a function that set *CURRENT-LANGUAGE* to the keyword version of ‘NAME’ [or NIL if ‘NAME’ is not supplied]

Package

djula.tag-compilers.

Source

tags.lisp.

Function: set-package (&rest arg-list0) ¶

:SET-PACKAGE tags are compiled into a function that set *DJULA-EXECUTE-PACKAGE* to the the package value of find package on the keyword ‘PACKAGE-NAME’ or the package ‘common-lisp-user’ if the package for ‘PACKAGE-NAME’ is not found. This is useful to determine the package in which :LISP tags are executed

Package

djula.tag-compilers.

Source

tags.lisp.

Function: show-language (&rest arg-list0) ¶

:SHOW-LANGUAGE tags are compiled into a function that just shows the values of *CURRENT-LANGUAGE* or *DEFAULT-LANGUAGE* if there is no current language

Package

djula.tag-compilers.

Source

tags.lisp.

Function: slice (it &rest slices) ¶

Package

djula.filters.

Source

filters.lisp.

Function: sort (it &optional predicate key) ¶

Package

djula.filters.

Source

filters.lisp.

Function: ssi (&rest arg-list0) ¶

Server Side Includes.
If ‘PATH’ lives in a folder reckognized by *ALLOW-INCLUDE-ROOTS*, then :SSI tag compiles into a function that returns the contents of the file pointed to by the template-path ‘PATH’.
If ‘PARSE’ is T then the function renders ‘PATH’ as a template.

Package

djula.tag-compilers.

Source

tags.lisp.

Function: string (&rest arg-list0) ¶

adjacent :STRING tokens are concatenated together by PROCESS-TOKENS as a small optimization

Package

djula.token-processors.

Source

parser.lisp.

Function: string (&rest arg-list0) ¶

:STRING tokens compile into a function that simply returns the string

Package

djula.token-compilers.

Source

compiler.lisp.

Function: super (&rest arg-list0) ¶

Package

djula.tag-compilers.

Source

tags.lisp.

Function: tag (&rest arg-list0) ¶

:TAG tokens are sometimes parsed into some other tokens by PROCESS-TOKENS

Package

djula.token-processors.

Source

tag.lisp.

Function: tag (&rest arg-list0) ¶

Package

djula.token-compilers.

Source

tag.lisp.

Function: templatetag (&rest arg-list0) ¶

:SHOW-FILE tags compile into a function that return the html-escaped contents of the file pointed to by the template-path ‘PATH’

Package

djula.tag-compilers.

Source

tags.lisp.

Function: time (it &optional format) ¶

Package

djula.filters.

Source

filters.lisp.

Function: trans (it &rest args) ¶

Package

djula.filters.

Source

translation.lisp.

Function: trans (&rest arg-list0) ¶

Package

djula.unparsed-tag-processors.

Source

translation.lisp.

Function: translate (string &optional args language backend) ¶

Translate STRING using Djula transaltion backend.
LANGUAGE is the language to translate to. The default is to use either *CURRENT-LANGUAGE* or *DEFAULT-LANGUAGE*, in that order. BACKEND is the translation backend to use. Default is *TRANSLATION-BACKEND*.

Package

djula.

Source

translation.lisp.

Function: translation (&rest arg-list0) ¶

Package

djula.token-compilers.

Source

translation.lisp.

Function: truncatechars (it n) ¶

Package

djula.filters.

Source

filters.lisp.

Function: unparsed-tag (&rest arg-list0) ¶

Package

djula.token-processors.

Source

tag.lisp.

Function: unparsed-translation (&rest arg-list0) ¶

Package

djula.token-processors.

Source

translation.lisp.

Function: unparsed-variable (&rest arg-list0) ¶

:PARSED-VARIABLE tokens are parsed into :VARIABLE tokens by PROCESS-TOKENS

Package

djula.token-processors.

Source

variables.lisp.

Function: update-caveman-project (project) ¶

update the cl-locale dictionary files with the djula translate strings. Project should coincide with project (asdf) name of the caveman project. This assumes the project uses the standard caveman2 directory structure. It does not depend on any caveman source code and
caveman or your project need not be loaded.

Package

djula.locale.

Source

locale.lisp.

Function: update-locale-list (message-file translate-strings) ¶

update a cl-locale message file with the list of translate strings

Package

djula.locale.

Source

locale.lisp.

Function: update-project (template-dir locale-dir) ¶

update a djula project informing the template directory and the directory of subdirectories holding the cl-locale dictionary files

Package

djula.locale.

Source

locale.lisp.

Function: upper (it) ¶

Package

djula.filters.

Source

filters.lisp.

Function: url-encode (string) ¶

URL-encodes a string using the external format EXTERNAL-FORMAT.

Package

djula.

Source

util.lisp.

Function: url-encode-path (path) ¶

URL encode the url path PATH.

Package

djula.

Source

util.lisp.

Function: urlencode (it) ¶

Package

djula.filters.

Source

filters.lisp.

Function: variable (&rest arg-list0) ¶

Package

djula.token-compilers.

Source

variables.lisp.

Function: verbatim (&rest arg-list0) ¶

Package

djula.token-compilers.

Source

lexer.lisp.

Function: with (it replace) ¶

Package

djula.filters.

Source

filters.lisp.

---

6.1.4 Generic functions

Generic Function: compile-template (compiler name &optional error-p) ¶

Provides a hook to customize template compilation.

Package

djula.

Source

compiler.lisp.

Methods

Method: compile-template ((compiler toplevel-compiler) name &optional error-p) ¶

Method: compile-template ((compiler compiler) name &optional error-p) ¶

Generic Function: fetch-template (store key) ¶

Return the text of the template identified by the given key.

Package

djula.

Source

template-store.lisp.

Methods

Method: fetch-template ((store filesystem-template-store) name) ¶

Method: fetch-template ((store memory-template-store) name) ¶

Generic Function: find-template (store name &optional error-p) ¶

Return a hashable key that uniquely identifies the named template.

Package

djula.

Source

template-store.lisp.

Methods

Method: find-template ((store memory-template-store) name &optional error-p) ¶

Method: find-template ((store filesystem-template-store) name &optional error-p) ¶

Algorithm that finds a template in a filesystem-template-store.

Generic Reader: fragment-compiler (object) ¶

Package

djula.

Methods

Reader Method: fragment-compiler ((toplevel-compiler toplevel-compiler)) ¶

automatically generated reader method

Source

compiler.lisp.

Target Slot

fragment-compiler.

Generic Function: template-print-object (object) ¶

Print an object in a template. Customize this function to implement custom printers for your objects.

Package

djula.

Source

util.lisp.

Methods

Method: template-print-object ((timestamp timestamp)) ¶

Method: template-print-object ((true (eql t))) ¶

Method: template-print-object (object) ¶

---

6.1.5 Standalone methods

Method: initialize-instance :after ((compiled-template compiled-template) &rest initargs) ¶

Source

compiler.lisp.

Method: print-object ((compiled-template compiled-template) stream) ¶

Source

compiler.lisp.

---

6.1.6 Classes

Class: compiler ¶

Abstract class. Top-level class for template compilers.

Package

djula.

Source

compiler.lisp.

Direct subclasses

toplevel-compiler.

Direct methods

compile-template.

Class: filesystem-template-store ¶

Searches for template files on disk according to the given search path.

Package

djula.

Source

template-store.lisp.

Direct superclasses

template-store.

Direct subclasses

memory-template-store.

Direct methods

• fetch-template.
• find-template.
• (setf search-path).
• search-path.

Direct slots

Slot: current-path ¶

The location of the most-recently fetched template.

Type

(or null string pathname)

Slot: search-path ¶

User-provided list of template locations.

Type

list

Initargs

:search-path

Readers

search-path.

Writers

(setf search-path).

Class: memory-template-store ¶

A template store with a memory cache.
This store works like FILESYSTEM-TEMPLATE-STORE, but when a template is compiled it saves the template contents in memory and templates are rendered from memory after. This is useful for building standalone binaries, as there’s no need to ship template files once they have been compiled (they are stored in the lisp image memory). You need to set Djula’s *current-store* to a MEMORY-TEMPLATE-STORE instance before compiling templates.
See the section on building standalong binaries in Djula manual.

Package

djula.

Source

template-store.lisp.

Direct superclasses

filesystem-template-store.

Direct methods

• fetch-template.
• find-template.

Direct slots

Slot: templates-contents ¶

A hash-table cache that maps pathnames and template names to template sources.

Initform

(make-hash-table :test (quote equalp))

Slot: templates ¶

Initform

(make-hash-table :test (quote equalp))

Class: template-store ¶

Package

djula.

Source

template-store.lisp.

Direct subclasses

filesystem-template-store.

Class: toplevel-compiler ¶

The default Djula template compiler.

Package

djula.

Source

compiler.lisp.

Direct superclasses

compiler.

Direct methods

• compile-template.
• fragment-compiler.

Direct slots

Slot: fragment-compiler ¶

Initform

(make-instance (quote djula:compiler))

Initargs

:fragment-compiler

Readers

fragment-compiler.

Writers

This slot is read-only.

---

6.2.1 Constants

Constant: +whitespace+ ¶

Whitespace characters.

Package

djula.locale.

Source

locale.lisp.

---

6.2.2 Special variables

Special Variable: *accumulated-javascript-strings* ¶

Package

djula.

Source

specials.lisp.

Special Variable: *block-alist* ¶

Package

djula.

Source

specials.lisp.

Special Variable: *current-block* ¶

Package

djula.

Source

specials.lisp.

Special Variable: *current-template* ¶

Package

djula.

Source

specials.lisp.

Special Variable: *eval-lisp-tags* ¶

Enable/disable Lisp evaluation in templates.

Package

djula.

Source

specials.lisp.

Special Variable: *gettext-domain* ¶

Package

djula.

Source

translation.lisp.

Special Variable: *linked-templates* ¶

Package

djula.

Source

specials.lisp.

Special Variable: *template-arguments* ¶

Package

djula.

Source

specials.lisp.

Special Variable: *untranslated-messages* ¶

Package

djula.

Source

translation.lisp.

Special Variable: *warn-on-untranslated-messages* ¶

Package

djula.

Source

translation.lisp.

---

6.2.3 Macros

Macro: accum (accfn &body body) ¶

Package

djula.

Source

util.lisp.

Macro: def-delimited-tag (starttag endtag delimited-name) ¶

Package

djula.

Source

pipeline.lisp.

Macro: def-tag-processor (name args rest-var &body body) ¶

Package

djula.

Source

pipeline.lisp.

Macro: def-token-compiler (name args &body body) ¶

Package

djula.

Source

pipeline.lisp.

Macro: def-token-processor (name args rest-var &body body) ¶

Package

djula.

Source

pipeline.lisp.

Macro: def-unparsed-tag-processor (name args rest-var &body body) ¶

Package

djula.

Source

pipeline.lisp.

Macro: with-file-handler ((string-var template-path) &body body) ¶

evaluates ‘BODY’ with ‘STRING-VAR’ bound to a string representing the contents of the file pointed to be the template-path ‘TEMPLATE-PATH’, returning it’s results. if there is an error while binding ‘STRING-VAR’ and *CATCH-TEMPLATE-ERRORS-P* is T then it returns a function that is suitable output for the body of a DEF-TOKEN-COMPILER form that returns some debugging info.

Package

djula.

Source

tags.lisp.

Macro: with-template-error (recovery-form &body body) ¶

Package

djula.

Source

conditions.lisp.

---

6.2.4 Ordinary functions

Function: alter-pathname (pathname &rest options) ¶

alter pathname as specified in the options

Package

djula.locale.

Source

locale.lisp.

Function: and-bterm (boolexp) ¶

Package

djula.

Source

tags.lisp.

Function: apply-filters (value filters) ¶

Package

djula.

Source

filters.lisp.

Function: apply-keys/indexes (thing keys/indexes) ¶

Package

djula.

Source

variables.lisp.

Function: backup-file (file) ¶

backup the file by copying it from filename.ext to filename-n.ext where n is the next available number.

Package

djula.locale.

Source

locale.lisp.

Function: bliteral () ¶

Package

djula.

Source

tags.lisp.

Function: boolean-comparison () ¶

Package

djula.

Source

tags.lisp.

Function: boolexp-factor (boolexp) ¶

Package

djula.

Source

tags.lisp.

Function: boolexp-parser () ¶

Package

djula.

Source

tags.lisp.

Function: bterm (boolexp) ¶

Package

djula.

Source

tags.lisp.

Function: comparison-operator-parser () ¶

Package

djula.

Source

tags.lisp.

Function: compile-boolexp (bexp) ¶

Package

djula.

Source

tags.lisp.

Function: compile-logical-statement (statement) ¶

takes a "logical statement" like you would give {% if %} that has been parsed
into a list of keywords [eg: ’(:not :foo) or ’(:foo :and :baz) or
‘(:foo.bar :or :list.1)] and turns them into a thunk predicate for dispatching the conditional branching of the {% if %} tag. when called, the function returns two values:

1. the value returned by resolving the phrase
2. an error message string if something went wrong [ie, an invalid variable]. [note: if return value 2 is present, then its probably not safe to consider return value 1 useful]

Package

djula.

Source

tags.lisp.

Function: compile-string (string) ¶

Compile the template in STRING. Returns a funcallable template.

Package

djula.

Source

compiler.lisp.

Function: compile-token (token) ¶

Package

djula.

Source

compiler.lisp.

Function: djula-emptyp (val) ¶

The default truth decider function for if expressions.

This is Django documentation for if expressions:

The {% if %} tag evaluates a variable, and if that variable is “true” (i.e. exists, is not empty, and is not a false boolean value)

Package

djula.

Source

tags.lisp.

Function: escape-for-html (string) ¶

Escapes the characters #\<, #\>, #\’, #\", and #\& for HTML output.

Package

djula.

Source

util.lisp.

Function: escape-string-split (char string &optional escape quotes) ¶

Package

djula.

Source

variables.lisp.

Function: find-end-tag (tag-name tokens) ¶

returns NIL if a :TAG token with the name ‘TAG-NAME’ can’t be found in ‘TOKENS’. Otherwise returns three values:

1. a list of all the tokens up to that token
2. a list of all tokens after that token
3. T, indicating that ‘TAG-NAME’ was found

Package

djula.

Source

tag.lisp.

Function: find-end-tag-nested (endtag tag tokens) ¶

Find end tag ENDTAG taking into account possible nested tags of type TAG.

Like FIND-END-TAG, but taking into account control structures nesting.

Returns NIL if a :TAG token with the name ‘TAG-NAME’ can’t be found in ‘TOKENS’. Otherwise returns three values:

1. a list of all the tokens up to that token
2. a list of all tokens after that token
3. T, indicating that ‘TAG-NAME’ was found

Package

djula.

Source

tag.lisp.

Function: find-filter (name) ¶

Return the filter by the name of NAME.

Package

djula.

Source

pipeline.lisp.

Function: find-tag-compiler (name) ¶

Return the tag compiler by the name of NAME.

Package

djula.

Source

pipeline.lisp.

Function: find-tag-processor (name) ¶

Return the tag processor by the name of NAME.

Package

djula.

Source

pipeline.lisp.

Function: find-token-compiler (name) ¶

Return the token processor by the name of NAME.

Package

djula.

Source

pipeline.lisp.

Function: find-token-processor (name) ¶

Return the token processor by the name of NAME.

Package

djula.

Source

pipeline.lisp.

Function: find-unparsed-tag-processor (tag-name) ¶

Return the unparsed tag processor by the name of TAG-NAME.

Package

djula.

Source

pipeline.lisp.

Function: format-translation (string &rest args) ¶

Package

djula.

Source

translation.lisp.

Function: get-closing-delimiter (type) ¶

Return the string that closes the corresponding token TYPE.

Package

djula.

Source

lexer.lisp.

Function: get-variable (name) ¶

takes a variable ‘NAME’ and returns:
1. the value of ‘NAME’
2. any error string generated by the lookup (if there is an error string then the lookup was unsuccessful)

Package

djula.

Source

variables.lisp.

Function: in-list (parser) ¶

Package

djula.

Source

tags.lisp.

Function: integer-or-keyword (string) ¶

If the STRING is an integer return an integer, otherwise return STRING as a keyword.

Package

djula.

Source

variables.lisp.

Function: join (separator list) ¶

Join the strings in LIST, using SEPARATOR in between the elements.

Similar to Python’s str.join

Package

djula.

Source

util.lisp.

Function: next-tag (string start) ¶

Return the position of the start of next tag in STRING starting from START.

Package

djula.

Source

lexer.lisp.

Function: not-bfactor (boolexp) ¶

Package

djula.

Source

tags.lisp.

Function: or-bterm (boolexp) ¶

Package

djula.

Source

tags.lisp.

Function: parse-filter-string (string) ¶

Package

djula.

Source

variables.lisp.

Function: parse-if-clause (args clause-tokens) ¶

Parse if clause taking into account else and elif tokens in body. Returns a :parsed-if clause.

Package

djula.

Source

tags.lisp.

Function: parse-rest-of-tag (string start) ¶

Package

djula.

Source

tag.lisp.

Function: parse-tag (string current-position) ¶

Return the lexer token and the index where the tag ended.

Package

djula.

Source

lexer.lisp.

Function: parse-template-string (template) ¶

Transform the TEMPLATE into a list of lexer tokens

Package

djula.

Source

lexer.lisp.

Function: parse-template-string (string) ¶

Package

djula.locale.

Source

locale.lisp.

Function: parse-variable-clause (unparsed-string) ¶

Package

djula.

Source

variables.lisp.

Function: parse-variable-phrase (string) ¶

Package

djula.

Source

variables.lisp.

Function: print-debugging-information (out) ¶

Package

djula.

Source

tags.lisp.

Function: print-fancy-debugging-information (stream) ¶

Package

djula.

Source

tags.lisp.

Function: process-ifequal-args (unparsed-string) ¶

Package

djula.

Source

tags.lisp.

Function: process-token (token rest-token-list) ¶

Package

djula.

Source

parser.lisp.

Function: process-tokens (tokens) ¶

Package

djula.

Source

parser.lisp.

Function: remove-first (item sequence &key test key) ¶

Removes the first ocurrence of item in sequence

Package

djula.

Source

tags.lisp.

Function: render-error-template (error backtrace &optional template stream) ¶

Render the *ERROR-TEMPLATE* with the ERROR, the BACKTRACE and the TEMPLATE where the error ocurred.

Package

djula.

Source

conditions.lisp.

Function: resolve-plist (plist) ¶

Package

djula.

Source

translation.lisp.

Function: resolve-variable-phrase (list) ¶

takes a list starting wise a variable and ending with 0 or more keys or indexes [this is a direct translation from the dot (.) syntax] and returns two values:

1. the result [looking up the var and applying index/keys]
2. an error string if something went wrond [note: if there is an error string then the result probably shouldn’t be considered useful.

Package

djula.

Source

variables.lisp.

Function: semi-parse-tag (string) ¶

Package

djula.

Source

tag.lisp.

Function: split-if-clause (clause-tokens) ¶

returns two values:

1. all clause tokens that appear _before_ the first :ELSE token 2. all clause tokens that appear _after_ the first :ELSE token

Package

djula.

Source

tags.lisp.

Function: string-string-p (s) ¶

test if s is a string that contains a string representation

Package

djula.locale.

Source

locale.lisp.

Function: string-translate-strings (string) ¶

given a djula html template string, find all the substrings to be translated

Package

djula.locale.

Source

locale.lisp.

Function: template-error (msg &rest args) ¶

Package

djula.

Source

conditions.lisp.

Function: template-error* (error msg &rest args) ¶

Package

djula.

Source

conditions.lisp.

Function: template-error-string (fmt &rest args) ¶

Package

djula.

Source

conditions.lisp.

Function: template-error-string* (error fmt &rest args) ¶

Package

djula.

Source

conditions.lisp.

Function: token-type (char) ¶

Return the token-type for CHAR.

Package

djula.

Source

lexer.lisp.

Function: transform (transform) ¶

Parser: transform and return the result, when the transformation applies (not null)

Package

djula.

Source

tags.lisp.

Function: trim-whitespace (string) ¶

STRING without whitespace at ends.

Package

djula.locale.

Source

locale.lisp.

Function: truncate-characters (string max-length &optional elision-string) ¶

If the STRING is larger than MAX-LENGTH, truncate it and append the ELISION-STRING so that the total length is MAX-LENGTH. Otherwise return the STRING unmodified. If the truncation is impossible to accomplish, return nil.

Package

djula.

Source

util.lisp.

---