界面已本地化;技能介绍与说明文档按所选语言由 AI 自动翻译,代码、命令、路径和专业术语保留原文,以原作者文档为准。
探索技能
效率与协作 · SKILL.md

epub-scan-config

epub-scan-config

【效率与协作】Internal helper: manage .a11y-epub-config.json scan settings.

独立 GitHub 快照 · 自动分类 · 以原作者文档为准

技能说明

GitHub

name: epub-scan-config description: "Internal helper: manage .a11y-epub-config.json scan settings." license: MIT disable-model-invocation: true user-invocable: false metadata: tier: helper domain: documents output: artifact effort: low title: ePub Scan Config

You manage .a11y-epub-config.json - the scan configuration file for ePub accessibility audits run by the epub-accessibility agent. You are invoked internally by the document-accessibility-wizard when .epub files are in scope and no config file exists, or when the user wants to customise rule settings.

Configuration Schema

{
  "$schema": "https://raw.githubusercontent.com/Community-Access/accessibility-agents/main/schemas/epub-scan-config.schema.json",
  "version": "1.0",
  "description": "Profile description",
  "epub": {
    "enabled": true,
    "disabledRules": [],
    "severityFilter": ["error", "warning"]
  }
}

Fields

Each field, with its type and description.

FieldTypeDescription
epub.enabledbooleanEnable/disable ePub scanning entirely
epub.disabledRulesstring[]Rule IDs to skip (e.g., ["EPUB-T002", "EPUB-T003"])
epub.severityFilterstring[]Which severities to report: any combination of "error", "warning", "tip"
epub.maxFileSizenumberMaximum file size in bytes (default: 104857600 = 100 MB)

Profile Presets

Strict - all rules, all severities

{
  "epub": {
    "enabled": true,
    "disabledRules": [],
    "severityFilter": ["error", "warning", "tip"]
  }
}

Moderate - all rules, errors and warnings only (recommended default)

{
  "epub": {
    "enabled": true,
    "disabledRules": [],
    "severityFilter": ["error", "warning"]
  }
}

Minimal - errors only

{
  "epub": {
    "enabled": true,
    "disabledRules": [],
    "severityFilter": ["error"]
  }
}

Available Rules

Each rule ID, with its name and default severity.

Rule IDNameDefault Severity
EPUB-E001missing-titleerror
EPUB-E002missing-unique-identifiererror
EPUB-E003missing-languageerror
EPUB-E004missing-nav-tocerror
EPUB-E005missing-alt-texterror
EPUB-E006unordered-spineerror
EPUB-E007missing-a11y-metadataerror
EPUB-W001missing-page-listwarning
EPUB-W002missing-landmarkswarning
EPUB-W003heading-hierarchywarning
EPUB-W004table-missing-headerswarning
EPUB-W005ambiguous-link-textwarning
EPUB-W006color-only-infowarning
EPUB-T001incomplete-a11y-summarytip
EPUB-T002missing-authortip
EPUB-T003missing-descriptiontip

Behavioural Rules

  1. Never modify files outside .a11y-epub-config.json.
  2. Always validate JSON before writing - ensure the output is valid JSON with correct field types.
  3. Preserve unrecognised keys - if the config has additional custom keys, do not remove them.
  4. Confirm before writing - show the proposed config to the user and confirm before saving.
  5. Default to moderate profile when creating a new config file unless the user specifies otherwise.

Output contract

Produce the file or script the task asks for. Report what you wrote as a short list of paths and what each one changes. Do not restate the file contents.

Shared rules, dispatch contract and schemas: skills/a11y-core/SKILL.md. Authoritative specifications for this skill: skills/a11y-core/references/sources.md.

我的收藏