Settings of this group in the settings files of Exponential 6.0.15 that this page does not describe:
| Setting
| File
| Default
| Description
|
| Enabled
|
settings/exphelp.ini
|
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
|
| CachePhpBinary
|
settings/exphelp.ini
|
(empty)
|
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.
|
| CacheSiteAccessList
|
settings/exphelp.ini
|
(empty)
|
The siteaccesses whose help cache exp:velocity deploy fills, besides those that have used it (var/<site>/cache/exphelp/content/siteaccesses.json)
|
| ParentNode
|
settings/exphelp.ini
|
media
|
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.
|
| Audiences
|
settings/exphelp.ini
|
Visitors; Members; Editors; Administrators; Developers; Project managers; Sales & marketing; Partners; Advocates; Designers; Hosting companies; Application creators; Website creators; Supporters; Sponsors; Customers; Governments; Businesses; Press, media and influencers; Trainers; Community; Ecosyst
|
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.
|
| PublicAudiences
|
settings/exphelp.ini
|
Visitors
|
The audiences whose topics are public (section help_public, readable without login when Released)
|
| Platforms
|
settings/exphelp.ini
|
Web; Admin; Mobile
|
The platform options (only append)
|
| Areas
|
settings/exphelp.ini
|
account; content; media; search; users; setup; privacy; help; doc
|
The areas of help_ids (area.topic[.variant]); the validator warns about any other
|
| AudienceMap
|
settings/exphelp.ini
|
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; website creators=websit
|
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.
|
| ContextHelpIds
|
settings/exphelp.ini
|
content/edit=content.publish-article; content/history=content.versions
|
Context help by help_id: the "?" Help control of these pages opens the Released topic (keys as [ContextHelp] Map[])
|
| AnonymousContextHelp
|
settings/exphelp.ini
|
disabled
|
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.
|
| EbooksOnRelease
|
settings/exphelp.ini
|
enabled
|
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.
|
| ReviewMaxDays
|
settings/exphelp.ini
|
14
|
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).
|
| ReviewListLimit
|
settings/exphelp.ini
|
10
|
At most this many overdue topics on the dashboard (the rest are counted)
|
| ReleaseByAuthor
|
settings/exphelp.ini
|
disabled
|
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.
|
| SentenceWordsPublic
|
settings/exphelp.ini
|
20
|
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).
|
| SentenceWordsTechnical
|
settings/exphelp.ini
|
25
|
|
| ParagraphSentencesPublic
|
settings/exphelp.ini
|
4
|
|
| PlainLanguageAudiences
|
settings/exphelp.ini
|
Visitors; Members
|
|
| ReviewMonths
|
settings/exphelp.ini
|
12
|
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.
|
| ShortReviewMonths
|
settings/exphelp.ini
|
6
|
|
| ShortReviewAreas
|
settings/exphelp.ini
|
privacy; account
|
|
| Feedback
|
settings/exphelp.ini
|
enabled
|
"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.
|
| FeedbackKeepDays
|
settings/exphelp.ini
|
730
|
|
| AnonymousFeedback
|
settings/exphelp.ini
|
disabled
|
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.
|
| EpubCheckCommand
|
settings/exphelp.ini
|
(empty)
|
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
|
| AceCommand
|
settings/exphelp.ini
|
(empty)
|
|
| BookChecks
|
settings/exphelp.ini
|
report
|
report: run the configured checks and report them; required: an e-book that fails one is not stored; disabled
|
| DitaHistoryDirectory
|
settings/exphelp.ini
|
(empty)
|
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.
|
| DitaHistoryLogin
|
settings/exphelp.ini
|
admin
|
|
| DitaHistoryAuthor
|
settings/exphelp.ini
|
(empty)
|
|
| SurplusNode
|
settings/site.ini
|
3
|
Node where all new related objects are default placed OBSOLETE: See content.ini for more advanced settings
|
| StaticCacheHandler
|
settings/site.ini
|
eZStaticCache
|
Sets a Cache Handler
|
| ContentClassEditHandler
|
settings/site.ini
|
eZContentClassEditHandler
|
Handler responsible of storing changes made on a content class when objects exist and require an update. This might be a huge task that can lead to time out, you may consider using the 'eZContentClassEditDeferredHandler' provided with the eZ Script Monitor extension.
|
| ContentObjectNameLimit
|
settings/site.ini
|
150
|
Length limit on contentObjectName, must be between 1 and 255.
|
| ContentObjectNameLimitSequence
|
settings/site.ini
|
...
|
End sequence for object name when reaching length limit.
|
| DatatypeBlackListForExternal
|
settings/site.ini
|
ezuser
|
List of datatypes that should not expose their content through external calls (Ajax/REST)
|
| RedirectAfterPublish
|
settings/site.ini
|
parentNode
|
Use this setting to change the redirection after publishing a node. It can contain the following values: - parentNode - redirect to the parent of the edited object's main node (default value) - node - redirect to the edited object's main node - rootNode - redirect to siteaccess root node (ie. content.ini/NodeSettings/rootNode ) - uri - redirect to a specific URI (see RedirectAfterPublishUri settings below)
|
Comments
Add a comment