Skip to main content

A Stacks application for generating static HTML pages.

Project description

# stacks-page

A Stacks application for generating static HTML pages. Stacks is an in-development, open-source initiative of WGBH (http://www.wgbh.org/)

## Dependencies

* `django-versatileimagefield` >= 1.0.2
* `django-textplusstuff` >= 0.4

## Release Notes

### 0.2.1

* Added new `STACKSPAGE_TEMPLATES` setting.
* Added "Can edit Stacks Page 'Live URL' values" permission.

### 0.2

* Added 'keywords' field to `StacksPage` model.

### 0.1.1

* Including templates in pypi release.

### 0.1

* Initial open source release

## Required Settings

### `STACKSPAGE_TEMPLATES`

Default:

```
STACKSPAGE_TEMPLATES = (
('stacks_page/default_page_template.html', 'Default Page Template'),
)
```

A list of templates you can select for a page.

Example:

```
STACKSPAGE_TEMPLATES = (
('path/to/template_file.html', 'Human Readable Template Name'),
('path/to/another/template_file.html', 'Human Readable Template Name #2'),
)
```

### `STACKSPAGE_STATIC_PUBLISH_SERVERS`

Used to define servers where pages can be published to.

```
STACKSPAGE_STATIC_PUBLISH_SERVERS = {
'staging': {
'server': 'user@staging_server',
'webroot_folder': '/absolute/path/to/webroot/on/server',
'base_url': 'http://staging.somesite.com'
},
'production': {
'server': 'user@prod_server',
'webroot_folder': '/absolute/path/to/webroot/on/server',
'base_url': 'http://www.somesite.com'
}
}
```

TODO: Document 'path_processor'!

### `STACKSPAGE_BUILD_DIRECTORY`

A path on local disc where statically generated StacksPage instances
should be saved-to.

```
STACKSPAGE_BUILD_DIRECTORY = '/path/to/folder'
```

For local development, you'll probably want to set this dynamically. The following code will create a directory named `stackspage_build` at the same level as your project's settings file:

```
import os
BASE_DIR = os.path.dirname(os.path.dirname(__file__)
STACKSPAGE_BUILD_DIRECTORY = os.path.join(BASE_DIR, 'stackspage_build')
```

### `STACKSPAGE_URL_PREFIX`

The path your Stacks application is running from, defaults to '/'.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stacks-page-0.2.1.tar.gz (13.6 kB view hashes)

Uploaded Source

Built Distribution

stacks_page-0.2.1-py2.py3-none-any.whl (20.8 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page