Changeset 32289 in project


Ignore:
Timestamp:
03/21/15 00:49:39 (5 years ago)
Author:
svnwiki
Message:

Anonymous wiki edit for IP [73.34.242.162]: Updated version history for v0.3.2.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/coq-au-vin

    r30412 r32289  
    1313=== Requirements
    1414
    15 [[utf8]], [[uri-common]], [[sql-de-lite]], [[civet]], [[lowdown]], [[crypt]], [[random-bsd]]
     15[[utf8]], [[uri-common]], [[sql-de-lite]], [[civet]], [[lowdown]], [[crypt]],
     16    [[random-bsd]], [[intarweb]], [[matchable]], [[fastcgi]]
    1617
    1718=== Introduction
     
    2627included in this egg. Additional databases will be supported in separate eggs.
    2728
    28 The body text of articles should be written in Markdown syntax.
    29 
    30 Please note that the current release does not implement any form of HTTP request
    31 handling. However, there is an
     29Blog posts are processed as Markdown, using the [[lowdown]] egg.
     30
     31The current version supports request handing via FastCGI. Future versions will also
     32support [[spiffy]]. All secured content must be accessed via HTTPS, though this
     33constraint may be disabled for testing purposes.
     34
     35For more detailed information, you may wish to look at the
    3236[[https://github.com/mgushee/coq-au-vin-examples|examples collection]], which
    3337includes several toy examples and one real web application.
     
    4145
    4246=== Scheme API
     47
     48Please note that this document does not cover all symbols exported by the egg. However,
     49those that are not documented should be considered experimental and [more] likely to
     50change.
    4351
    4452==== Initialization & Configuration
     
    8795==== Content API
    8896
    89 <procedure>(get-article-page/html ID/ALIAS #!key (out (current-output-port)) (date-format #f))</procedure>
    90 
    91 Generate an HTML page that displays the full text of one article. ID/ALIAS may be
    92 either the article's node id or its alias, if defined.
    93 
    94 
    95 <procedure>(get-article-list-page/html #!key (out (current-output-port)) (criterion 'all) (sort '(created desc))
    96                                              (date-format #f) (limit 10) (offset 0) (show 'teaser))</procedure>
     97===== Common Parameters
     98
     99Many of the procedures below take the following parameters:
     100
     101* {{ID/ALIAS}}  The identifier for a blog post. ID is a system-generated value; ALIAS is an
     102    optional string that may be specified by the user to allow for "friendly" URLs [not yet
     103    implemented as of version 0.3].
     104
     105* {{OUT}}  An output port, defaulting to {{(current-output-port)}}. If you change this,
     106    expect problems.
     107
     108* {{LOGGED-IN}}  A boolean indicating whether the user is logged in or not. Note that this
     109    parameter is ''not'' used to grant or deny access to secured resources; it is intended as
     110    a convenient way to determine whether to display certain page items related to the user's
     111    logged-in status (e.g. a "LOGIN" or "LOGOUT" link).
     112
     113
     114<procedure>(get-article-page/html ID/ALIAS #!key (out (current-output-port)) (date-format #f)
     115                                                 (logged-in #f))</procedure>
     116
     117Generate an HTML page that displays the full text of one article.
     118
     119
     120<procedure>(get-article-list-page/html #!key (out (current-output-port)) (criterion 'all)
     121                                             (sort '(created desc)) (date-format #f) (limit 10)
     122                                             (offset 0) (show 'teaser) (logged-in #f))</procedure>
    97123
    98124Generate an HTML page displaying a list of articles. The list may be filtered using the
    99125CRITERION argument; currently supported values are {{'all}}, {{'(tag TAG)}}, {{'(author AUTHOR)}},
    100 {{'(series SERIES-TITLE)}}, {{'(category CATEGORY)}}. As of version 0.1, the SHOW and SORT arguments
     126{{'(series SERIES-TITLE)}}, {{'(category CATEGORY)}}. As of version 0.3, the SHOW and SORT arguments
    101127are unimplemented.
    102128
    103129
    104 <procedure>(get-meta-list-page/html SUBJECT #!optional (out (current-output-port)))</procedure>
     130<procedure>(get-meta-list-page/html SUBJECT #!optional (out (current-output-port)) (logged-in #f))</procedure>
    105131
    106132Generate an HTML page listing all items of a particular type. SUBJECT must be one of {{'tags}},
     
    115141<procedure>(get-article-edit-form/html ID/ALIAS #!optional (out (current-output-port)))</procedure>
    116142
    117 Generate an HTML form for editing an existing article, specified by ID/ALIAS.
     143Generate an HTML form for editing an existing article.
    118144
    119145
     
    166192is a directory where article content files will be stored.
    167193
     194
     195==== FastCGI Interface
     196
     197<procedure>(run LISTEN-PORT #!optional (testing #f))</procedure>
     198
     199Runs the FastCGI server on LISTEN-PORT, which may be either a TCP port (integer) or a
     200unix socket (string). See the [[fastcgi]] documentation for more information. The TESTING
     201parameter disables the HTTPS-only requirement for secured resources.
    168202
    169203=== In case of bugs
     
    178212=== License
    179213
    180 Copyright (c) 2013, Matthew C. Gushee
     214Copyright (c) 2013-2014, Matthew C. Gushee
    181215All rights reserved.
    182216
     
    216250=== Version History
    217251
    218 ;0.2.3:     Fixed bug that prevented series titles from being updated.
     252;0.3.2:     Fixed 'logged-in' function; removed IP address checking for session-valid?; added JSON combo menu handler.
     253
     254;0.3:       Integrated FastCGI support; modified HTTP response generation to use [[intarweb]]; improved security by enforcing strict TLS and making session cookies 'Secure' and 'HttpOnly'.
     255
     256;0.2.3:     Fixed bug that prevented series title from being updated.
    219257
    220258;0.2.2:     Removed a debugging command that caused errors.
Note: See TracChangeset for help on using the changeset viewer.