exphelp.ini [ContentSettings] #

The block [ContentSettings] of settings/exphelp.ini, with 31 setting(s).

Never edit settings/exphelp.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

• settings/override/exphelp.ini.append.php for every siteaccess,
• settings/siteaccess/<siteaccess>/exphelp.ini.append.php for one siteaccess,
• extension/<extension>/settings/exphelp.ini.append.php in an extension (read when the extension is active).

Enabled #

Help maintained as content (doc/eng-us/features/6.0/help-content.md): topics, manuals, figures and the glossary as content
of the site, created by ./console exp:help:content. Nothing here matters until that command ran.
disabled: exphelp/topic, exphelp/manual and exphelp/context are 404 and the help shows no topics

Default: enabled.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
Enabled=enabled
*/ ?>

CachePhpBinary #

The rows of help content are kept in var/<site>/cache/exphelp/content. A web request never reads every help object
(an emptied cache): it starts "php bin/php/exphelpcontent.php cache -s <siteaccess>" in the background and shows no
help content until that is done. The PHP command line binary for it; empty: found next to the running PHP.

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
CachePhpBinary=
*/ ?>

CacheSiteAccessList #

The siteaccesses whose help cache exp:velocity deploy fills, besides those that have used it
(var/<site>/cache/exphelp/content/siteaccesses.json)

Default: an empty list.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
# an empty "CacheSiteAccessList[]" first replaces the shipped list; without it the items are added
CacheSiteAccessList[]
*/ ?>

ParentNode #

Where the folder "Help" (remote_id help-root) is created: media (default), content, users, or a remote_id. Not in
the site's content tree: help must not show up in its menus, listings and feeds.

Default: media.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
ParentNode=media
*/ ?>

Audiences #

The audience options of the help_* classes, in their stored order. ONLY APPEND: ezselection stores the position of
an option, so a reordered list gives every topic another audience. The command appends missing ones.
The other audiences of the help ([AudienceSettings] AudienceNames[]), so the manuals built from the Markdown help
(exp:help:content build-manuals) keep who each page is for

Default: a list of 42: Visitors, Members, Editors, Administrators, Developers, Project managers, Sales & marketing, Partners, Advocates, Designers, Hosting companies, Application creators ....

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
# an empty "Audiences[]" first replaces the shipped list; without it the items are added
Audiences[]
Audiences[]=Visitors
Audiences[]=Members
Audiences[]=Editors
Audiences[]=Administrators
Audiences[]=Developers
Audiences[]=Project managers
Audiences[]=Sales & marketing
Audiences[]=Partners
Audiences[]=Advocates
Audiences[]=Designers
Audiences[]=Hosting companies
Audiences[]=Application creators
Audiences[]=Website creators
Audiences[]=Supporters
Audiences[]=Sponsors
Audiences[]=Customers
Audiences[]=Governments
Audiences[]=Businesses
Audiences[]=Press, media and influencers
Audiences[]=Trainers
# ... 22 more in the shipped file
*/ ?>

PublicAudiences #

The audiences whose topics are public (section help_public, readable without login when Released)

Default: a list of 1: Visitors.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
# an empty "PublicAudiences[]" first replaces the shipped list; without it the items are added
PublicAudiences[]
PublicAudiences[]=Visitors
*/ ?>

Platforms #

The platform options (only append)

Default: a list of 3: Web, Admin, Mobile.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
# an empty "Platforms[]" first replaces the shipped list; without it the items are added
Platforms[]
Platforms[]=Web
Platforms[]=Admin
Platforms[]=Mobile
*/ ?>

Areas #

The areas of help_ids (area.topic[.variant]); the validator warns about any other
the pages of the Markdown help as topics (exp:help:content build-manuals): doc.<path of the page>

Default: a list of 9: account, content, media, search, users, setup, privacy, help, doc.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
# an empty "Areas[]" first replaces the shipped list; without it the items are added
Areas[]
Areas[]=account
Areas[]=content
Areas[]=media
Areas[]=search
Areas[]=users
Areas[]=setup
Areas[]=privacy
Areas[]=help
Areas[]=doc
*/ ?>

AudienceMap #

The help's audience (editor, admin, developer, user ...) of each audience option, in lower case. build-manuals
gives a page of the help audience X the first option that maps to X.

Default: a hash of 42: visitors=user, members=user, editors=editor, administrators=admin, developers=developer, project managers=project-manager, sales & marketing=sales-marketing, partners=partner, advocates=advocate, designers=designer, hosting companies=hosting, application creators=app-creator ....

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
# an empty "AudienceMap[]" first replaces the shipped list; without it the items are added
AudienceMap[]
AudienceMap[visitors]=user
AudienceMap[members]=user
AudienceMap[editors]=editor
AudienceMap[administrators]=admin
AudienceMap[developers]=developer
AudienceMap[project managers]=project-manager
AudienceMap[sales & marketing]=sales-marketing
AudienceMap[partners]=partner
AudienceMap[advocates]=advocate
AudienceMap[designers]=designer
AudienceMap[hosting companies]=hosting
AudienceMap[application creators]=app-creator
AudienceMap[website creators]=website-creator
AudienceMap[supporters]=supporter
AudienceMap[sponsors]=sponsor
AudienceMap[customers]=customer
AudienceMap[governments]=government
AudienceMap[businesses]=businesses
AudienceMap[press, media and influencers]=press
AudienceMap[trainers]=trainer
# ... 22 more in the shipped file
*/ ?>

ContextHelpIds #

Context help by help_id: the "?" Help control of these pages opens the Released topic (keys as [ContextHelp] Map[])

Default: a hash of 2: content/edit=content.publish-article, content/history=content.versions.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
# an empty "ContextHelpIds[]" first replaces the shipped list; without it the items are added
ContextHelpIds[]
ContextHelpIds[content/edit]=content.publish-article
ContextHelpIds[content/history]=content.versions
*/ ?>

AnonymousContextHelp #

The help_ids other clients open (a mobile app, a site's JavaScript), so "exp:help:content check" reports one that no
topic has or whose topic is not Released (client.help-id-unknown, client.help-id-not-released). None by default.
ClientHelpIds[]
ClientHelpIds[]=account.log-in
enabled: the roles step of exp:help:content also gives Anonymous exphelp/context, so the JSON of public, Released
topics can be read without login. Off by default: a security-relevant choice of each site.

Default: disabled.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
AnonymousContextHelp=disabled
*/ ?>

EbooksOnRelease #

enabled: when an object of the help is set to Released, the e-books (EPUB, PDF) of every Released manual that
contains it are built again and stored as file objects below E-books (remote_id help-ebooks), a new version when
the book changed (expHelpContentEbooks::onStateAssign(), called when states are assigned).
disabled: only ./console exp:help:content ebooks stores them.

Default: enabled.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
EbooksOnRelease=enabled
*/ ?>

ReviewMaxDays #

Overdue reviews, listed on the help's dashboard to who can edit the topic or assign its state, and by
./console exp:help:content review: a topic whose review date has passed, or that has been in Review longer than
ReviewMaxDays days since it last changed (the kernel keeps no date of a state change).

Default: 14.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
ReviewMaxDays=14
*/ ?>

ReviewListLimit #

At most this many overdue topics on the dashboard (the rest are counted)

Default: 10.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
ReviewListLimit=10
*/ ?>

ReleaseByAuthor #

The review workflow (Draft, Review, Released): the person who wrote a topic's current version does not release it,
whatever their roles (the Object states tab, the content job and the help's buttons alike). enabled allows it, for a
site with a single editor. The command line (seed-topics --release, build-manuals --release) is not limited.

Default: disabled.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
ReleaseByAuthor=disabled
*/ ?>

SentenceWordsPublic #

The style guide's plain language (section 3), checked as NOTICE by exp:help:content check and on the topic's page:
words per sentence for the audiences of PlainLanguageAudiences[] and for the others, sentences per paragraph for the
plain ones. 0 switches a check off. A site with readers who need shorter limits sets them here (15 and 3).

Default: 20.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
SentenceWordsPublic=20
*/ ?>

SentenceWordsTechnical #

Default: 25.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
SentenceWordsTechnical=25
*/ ?>

ParagraphSentencesPublic #

Default: 4.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
ParagraphSentencesPublic=4
*/ ?>

PlainLanguageAudiences #

Default: a list of 2: Visitors, Members.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
# an empty "PlainLanguageAudiences[]" first replaces the shipped list; without it the items are added
PlainLanguageAudiences[]
PlainLanguageAudiences[]=Visitors
PlainLanguageAudiences[]=Members
*/ ?>

ReviewMonths #

The longest a review date may be away (style guide section 8: release + 12 months; the areas of ShortReviewAreas[]

• 6 months); a date further away is a WARNING (review-date.too-far). 0 switches it off.

Default: 12.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
ReviewMonths=12
*/ ?>

ShortReviewMonths #

Default: 6.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
ShortReviewMonths=6
*/ ?>

ShortReviewAreas #

Default: a list of 2: privacy, account.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
# an empty "ShortReviewAreas[]" first replaces the shipped list; without it the items are added
ShortReviewAreas[]
ShortReviewAreas[]=privacy
ShortReviewAreas[]=account
*/ ?>

Feedback #

"Was this helpful?" under each Released topic: yes, or no with a reason from a fixed list, counted per topic (table
exphelp_feedback). Nothing about who answered is kept: no user, no address, no free text; one answer per topic and
session counts. Answers older than FeedbackKeepDays are removed by the cronjob part exphelp.

Default: enabled.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
Feedback=enabled
*/ ?>

FeedbackKeepDays #

Default: 730.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
FeedbackKeepDays=730
*/ ?>

AnonymousFeedback #

enabled: the roles step of exp:help:content also gives Anonymous exphelp/feedback, for a site that shows its help
publicly (the templates of the extension exphelpsite). Off by default.

Default: disabled.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
AnonymousFeedback=disabled
*/ ?>

EpubCheckCommand #

The checks of an EPUB (epubcheck, Ace by DAISY) are not shipped; a site that has them names their commands. The
EPUB file is added as the last argument; Ace gets --outdir <dir> --force first. Empty: the check is skipped.
EpubCheckCommand=java -jar /opt/epubcheck/epubcheck.jar
AceCommand=ace

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
EpubCheckCommand=
*/ ?>

AceCommand #

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
AceCommand=
*/ ?>

BookChecks #

report: run the configured checks and report them; required: an e-book that fails one is not stored; disabled

Default: report.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
BookChecks=report
*/ ?>

DitaHistoryDirectory #

The history of the help in git (delivery path 4): the cronjob part exphelp writes the DITA export of every manual
into this directory (outside the web root) and commits what changed; the first run makes it a git repository. Empty:
off. The export holds the Released objects that DitaHistoryLogin may read. DitaHistoryAuthor: "Name <mail>" of the
commits, else the repository's git configuration.

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
DitaHistoryDirectory=
*/ ?>

DitaHistoryLogin #

Default: admin.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
DitaHistoryLogin=admin
*/ ?>

DitaHistoryAuthor #

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/exphelp.ini.append.php
[ContentSettings]
DitaHistoryAuthor=
*/ ?>

Related #

• All blocks of exphelp.ini
• All INI files
• The settings page

Generated by ./console exp:help:examples from settings/exphelp.ini. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.