ACCS
Overview
ACCS is a feature for handling multiple articles as a
series.
The name comes from the original PureBuilder project, which
started as separate software called ACCS. Today, it exists as a
feature within PureBuilder Simply.
Currently, the role of ACCS is quite minimal: it generates an
index.html file that lists articles.
PureBuilder Simply typically processes documents on a
per-directory basis, and ACCS provides an
index.html listing the articles within that
directory.
Configuring ACCS
Template
The ACCS index page is generated based on
.accsindex.erb located in the document source
root.
This file is included in each theme.
When using the default .accsindex.erb, you can
control the order of articles via the accs_order
setting in .pbsimply.yaml.
- The only supported value is
desc(for descending order).
- If not specified, articles are listed in ascending order.
Within .accsindex.erb, the following variables
are available (all are Hash objects):
| Key | Description |
|---|---|
@config |
The applied project configuration |
@index |
Values defined in .accs.yaml |
@indexes |
Contents of the index database |
ACCS Configuration File
ACCS is enabled or disabled on a per-directory basis.
If a directory contains a .accs.yaml file, that
directory is treated as an ACCS directory, and
ACCS will be invoked as a post-processing step when generating
documents for that directory.
The contents of .accs.yaml act as the
frontmatter for .accsindex.erb.
At minimum, it must be a Hash that includes a title
key.