Changeset 20910 in project


Ignore:
Timestamp:
10/20/10 18:04:08 (11 years ago)
Author:
Moritz Heidkamp
Message:

hyde: update docs for 0.11

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/hyde

    r20872 r20910  
    147147    * index.wiki -> index.xml
    148148
     149=== Available Options
     150
     151The {{hyde}} executable understands the following options:
     152
     153; {{-e}} : Sets the hyde environment to execute the command in (see [[#available-commands|Available Commands]] for which commands respect this option and [[#define-hyde-environment|define-hyde-environment]] on how to define environments).
    149154
    150155
     
    155160; {{hyde init}} : Initializes a site in the current directory.
    156161; {{hyde new <page-type> [<title> ...]}} : Creates a new page with the given page type and title. The page's filename will be inferred from the given title by downcasing it and replacing spaces with dashes.
    157 ; {{hyde serve}} : Serves the current site with [[spiffy]], (re-)compiling the site on each request (useful for development).
    158 ; {{hyde}} : Compiles the current site.
     162; {{hyde serve}} : Serves the current site with [[spiffy]], (re-)compiling the site on each request (useful for development). This command respects the {{-e}} option.
     163; {{hyde}} : Compiles the current site. This command respects the {{-e}} option.
    159164
    160165=== Configuration Parameters
     
    215220
    216221An alist which maps either (ir)regexps or procedures to
    217 page-vars. Each page has its {{page-path}} matched against the
     222page-vars. Each page has its {{page-source-path}} matched against the
    218223(ir)regexps or is passed to the procedure. If it matches or returns
    219224non-{{#f}}, the respective page-vars are appended to the page's local
     
    223228
    224229The following {{default-page-vars}} would set the {{layouts}} page-var
    225 to {{("page.sxml" "default.sxml")}} for all .html pages below
    226 {{/pages}} and the page-vars {{tags}} to {{(awful)}} for all pages
     230to {{("page.sxml" "default.sxml")}} for all {{.sxml}} pages below
     231{{pages}} and the page-vars {{tags}} to {{(awful)}} for all pages
    227232containing the word "cool":
    228233
    229234<enscript language="scheme">
    230 (default-page-vars `(((: bos "/pages/" (+ any) ".html" eos)
     235(default-page-vars `(((: bos "pages/" (+ any) ".sxml" eos)
    231236                      (layouts "page.sxml" "default.sxml"))
    232237
     
    259264{{hyde.scm}}.
    260265
     266==== uri-path-prefix
     267
     268<parameter>(uri-path-prefix [path])</parameter>
     269
     270A string that is prepended to all pages' {{page-path}}. Default: {{""}}.
     271
     272
    261273=== Helpers
    262274
    263275These procedures and macros are mainly intended for use in the
    264276{{hyde.scm}} or in extension modules.
     277
     278==== define-hyde-environment
     279
     280<syntax>(define-hyde-environment name body ...)</syntax>
     281
     282Defines an environment {{name}}. The {{body}} expressions are only
     283evaluated when {{hyde}} is executed with {{-e [name]}}. This is useful
     284to set different parameters for different scenarios or deployment
     285locations. If no {{-e}} option is set, the {{default}} environment is
     286used. Just {{(define-hyde-environment default ...)}} to override
     287it. See [[#available-commands|Available Commands]] for which commands
     288respect environments.
     289
     290==== make-external-translator
    265291
    266292<syntax>(make-external-translator name)</syntax>
     
    362388=== Change Log
    363389
     390; 0.11 : Change {{default-page-vars}} irregex keys to match against {{page-source-path}} instead of {{page-path}}. Add environments. Add {{uri-path-prefix}}.
    364391; 0.10 : Add colorize support to svnwiki pages. Implement more powerful {{default-page-vars}}. Add {{make-external-translator}} (thanks to Christian Kellermann for the patch). Only recompile requested pages instead of the whole site with {{hyde serve}}.
    365392; 0.9 : Print usage for unknown commands (thanks to Christian Kellermann). Add current-page binding and make it the default argument for all page record field accessors.
Note: See TracChangeset for help on using the changeset viewer.