` - `<metadata><keywords><indexterm>` - For search indexing - `<metadata><keywords><keyword>` - For tagging and classification **Example**: ```xml <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd"> <topic id="topic

` elements with IDs for major topic divisions - **Parameters**: Use `` elements within objects for video configuration ### Link Patterns External links to Oxygen documentation: ```xml Link text ``` Internal cross-references: ```xml ``` ### Code Sample Formatting Use `outputclass="language-xml"` for XML code blocks: ```xml <element>content</element> ``` ## Key Definitions Use these key references in content: - `` → "Oxygen XML Editor" - `` → "WebAuthor" ## Subject Classification Topics can be classified using the subject scheme defined in `classification/blog-subject-scheme.ditamap`: - `blog-dita` - DITA XML topics - `blog-dita-learning` - Learning resources - `blog-dita-publishing` - Publishing customizations - `blog-dita-customizing` - Editing customizations - `blog-migrate` - Migration topics - `blog-sdk` - SDK/Plugin/Framework development ## Validation Rules 1. **All topics must be valid DITA 1.3** 2. **Include DOCTYPE declaration**: `` 3. **Prolog with author and created date is mandatory** 4. **Use proper element nesting** according to DITA specification 5. **External links must include `format="html"` and `scope="external"`** 6. **Image references should use relative paths** from the topic location ## Custom Framework Features The project uses a custom DITA extension framework (`dita-blog.exf`) that includes: - Custom CSS styling (`frameworks/dita-extension/css/custom.css`) - Custom Schematron validation rules (`frameworks/dita-extension/schematron/`) - Custom dictionaries for spell checking (`frameworks/dita-extension/dicts/`) - Additional frameworks directory: `${pd}/frameworks` - Spell check configuration: - Automatic spell checking enabled for XML content types - Ignores specific elements: `codeblock`, `codeph`, `filepath`, `screen` - English language default with acronym and digit ignoring - Custom dictionary loading from additional folder ## Publishing Configuration - **Output formats**: WebHelp Responsive (primary), PDF, EPUB - **Publishing template**: `publishing/webhelpBlogTemplate/` with custom CSS and XSLT - **Build system**: DITA-OT with project file (`blog-project.xml`) and transformation scenarios - **WebHelp customizations**: - Custom template: `Oxygen XML Blog WebHelp Template.opt` - Custom CSS: `custom.css`, `oxygen.css` - HTML fragments in `html-fragments/` directory - XSLT customizations in `xslt/` directory - **Deployment**: GitHub Actions for validation, Netlify for hosting - **Build parameters**: - `force-unique="true"` for unique output filenames - `clean.temp="no"` for debugging - Custom figure/table link styles set to "TITLE" - WebHelp sticky TOC disabled ## AI-Specific Considerations ### When Creating New Topics: 1. Place in `topics/` directory with descriptive filename 2. Include complete prolog with author and date 3. Add shortdesc for better search/navigation 4. Use appropriate topic type (topic, concept, task, reference) 5. Include indexterms for searchability 6. Follow existing naming patterns ### When Editing Existing Topics: 1. Preserve existing structure and metadata 2. Maintain consistent formatting with project style 3. Keep DOCTYPE and topic ID unchanged 4. Update only the content body unless metadata changes are needed ### When Adding Cross-References: 1. Use relative paths for internal links 2. Include proper attributes for external links 3. Verify target topics exist in the project 4. Use key references where defined ## Common Topic Patterns ### AI/Positron Topics Topics about AI features typically include: - Installation and licensing overview (subscription vs enterprise models) - Feature descriptions with examples and video embeds - Links to official documentation and external resources - Practical use cases and workflows - Code samples showing XPath functions (`ai:transform-content`, `ai:verify-content`) or custom actions - Integration with XML technologies (Schematron, XSLT) - Batch processing capabilities and refactoring actions - Visual image recognition features - Custom action development examples ### Migration Topics Migration articles typically include: - Source format description - Step-by-step procedures - Tool recommendations - Best practices and tips - Before/after examples ### SDK/Development Topics Development topics typically include: - Technical prerequisites - Code samples (Java, XSLT, XQuery) - API references - Framework extension examples - Plugin development patterns ## File References When referencing project files in content: - Use `${pd}` for project directory variable - Use `${pdu}` for project directory URL variable - Use relative paths from topic location for images and other resources ## Quality Standards - **Completeness**: Topics should be self-contained with sufficient context - **Accuracy**: Verify all technical details and code samples - **Clarity**: Use clear headings, lists, and structure - **Examples**: Include practical examples where applicable - **Links**: Ensure all external links are valid and use HTTPS - **Consistency**: Follow established patterns from existing topics ## Project-Specific Patterns ### Relationship Tables The main map includes a `` for establishing related links between topics: - Links related diagram topics (PlantUML, Mermaid, task diagrams) - Connects Google structured data topics (tasks and FAQ) - Creates cross-references without explicit linking in topics ### Topic Hierarchies Content is organized in logical hierarchies: - **AI topics**: Grouped under "Artificial intelligence (AI)" topichead - **Migration topics**: Under dedicated migration section with key="migrate" - **Development topics**: Separate topichead for development content - **Miscellaneous**: Catch-all section for various topics ### Map References Extensive use of `` and `` for modular organization: - Subject scheme maps for classification - Dedicated submaps for major topic areas - Processing role attributes for resource-only content ### Metadata Patterns - WebHelp menu hiding: `` - Navigation titles: `` for custom navigation labels - Print exclusions: `print="no"` for web-only content - Scope and format attributes: Consistent use for external HTML references --- **Last Updated**: Enhanced with project structure analysis **Project Repository**: https://github.com/oxygenxml/blog **Generated**: For AI Positron Assistant configuration