docs/webdesign.txt

   1 ========================
   2 django.contrib.webdesign
   3 ========================
   4
   5 The ``django.contrib.webdesign`` package, part of the `"django.contrib" add-ons`_,
   6 provides various Django helpers that are particularly useful to Web *designers*
   7 (as opposed to developers).
   8
   9 At present, the package contains only a single template tag. If you have ideas
  10 for Web-designer-friendly functionality in Django, please `suggest them`_.
  11
  12 .. _"django.contrib" add-ons: ../add_ons/
  13 .. _suggest them: ../contributing/
  14
  15 Template tags
  16 =============
  17
  18 To use these template tags, add ``'django.contrib.webdesign'`` to your
  19 ``INSTALLED_APPS`` setting. Once you've done that, use
  20 ``{% load webdesign %}`` in a template to give your template access to the tags.
  21
  22
  23 lorem
  24 =====
  25
  26 Displays random "lorem ipsum" Latin text. This is useful for providing sample
  27 data in templates.
  28
  29 Usage::
  30
  31     {% lorem [count] [method] [random] %}
  32
  33 The ``{% lorem %}`` tag can be used with zero, one, two or three arguments.
  34 The arguments are:
  35
  36     ===========  =============================================================
  37     Argument     Description
  38     ===========  =============================================================
  39     ``count``    A number (or variable) containing the number of paragraphs or
  40                  words to generate (default is 1).
  41     ``method``   Either ``w`` for words, ``p`` for HTML paragraphs or ``b``
  42                  for plain-text paragraph blocks (default is ``b``).
  43     ``random``   The word ``random``, which if given, does not use the common
  44                  paragraph ("Lorem ipsum dolor sit amet...") when generating
  45                  text.
  46     ===========  =============================================================
  47
  48 Examples:
  49
  50     * ``{% lorem %}`` will output the common "lorem ipsum" paragraph.
  51     * ``{% lorem 3 p %}`` will output the common "lorem ipsum" paragraph
  52       and two random paragraphs each wrapped in HTML ``<p>`` tags.
  53     * ``{% lorem 2 w random %}`` will output two random Latin words.