Vale CMS Need more than a rule playground? Explore
Package Explorer

AsciiDocDITA

A Vale-compatible implementation of select DITA transformation guidelines for transforming existing AsciiDoc files into a DITA-compatible format.

Source style

Getting started

Add it to your .vale.ini, then run vale sync.

Packages = AsciiDocDITA

[*.md]
BasedOnStyles = Vale, AsciiDocDITA

Rules 43

6 error29 warning8 suggestion
  • AsciiDocDITA.AdmonitionTitle warning script scope: raw Style guide

    Admonition titles are not supported in DITA.

  • AsciiDocDITA.AssemblyContents warning script scope: raw Style guide

    Content other than additional resources cannot follow include directives.

  • AsciiDocDITA.AttributeDefinition suggestion existence scope: raw Style guide

    %s

  • AsciiDocDITA.AttributeReference suggestion existence scope: raw Style guide

    %s

  • AsciiDocDITA.AuthorLine warning script scope: raw Style guide

    Author lines are not supported for topics.

  • AsciiDocDITA.BlockTitle warning script scope: raw Style guide

    Block titles can only be assigned to examples, figures, and tables in DITA.

  • AsciiDocDITA.CalloutList warning script scope: raw

    Callouts are not supported in DITA.

  • AsciiDocDITA.ConceptLink warning script scope: raw Style guide

    Move all links and cross references to Additional resources.

  • AsciiDocDITA.ConditionalCode suggestion script scope: raw Style guide

    %s

  • AsciiDocDITA.ContentType warning occurrence scope: raw Style guide

    The '_mod-docs-content-type' attribute definition is missing.

  • AsciiDocDITA.DiscreteHeading warning script scope: raw Style guide

    Discrete headings are not supported in DITA.

  • AsciiDocDITA.DocumentId warning script scope: raw Style guide

    The document ID assigned to the level 0 (=) heading is missing.

  • AsciiDocDITA.DocumentTitle warning script scope: raw Style guide

    The document title (=) is missing.

  • AsciiDocDITA.EntityReference error script scope: raw Style guide

    HTML character entity references are not supported in DITA.

  • AsciiDocDITA.EquationFormula warning script scope: raw Style guide

    Equations and formulas are not implemented.

  • AsciiDocDITA.ExampleBlock error script scope: raw Style guide

    Example blocks can not be inside of other blocks in DITA.

  • AsciiDocDITA.IgnoredFile suggestion existence scope: raw Style guide

    %s

  • AsciiDocDITA.IncludeDirective suggestion existence scope: raw Style guide

    %s

  • AsciiDocDITA.IntrinsicAttribute suggestion existence scope: raw Style guide

    %s

  • AsciiDocDITA.LineBreak warning script scope: raw Style guide

    Hard line breaks are not supported in DITA.

  • AsciiDocDITA.MapChunk warning script scope: raw Style guide

    The chunk="to-content" attribute cannot be nested.

  • AsciiDocDITA.MapContents warning script scope: raw Style guide

    Maps only support document titles, IDs, include directives, and attribute definitions.

  • AsciiDocDITA.MapFilename warning script scope: raw Style guide

    Use only lowercase alphanumeric characters and hyphens (a-z, 0-9, and -) in file names.

  • AsciiDocDITA.MapLevel warning script scope: raw Style guide

    Invalid leveloffset value.

  • AsciiDocDITA.MapSize warning script scope: raw Style guide

    The number of include directives exceeds 200.

  • AsciiDocDITA.MapToc warning script scope: raw Style guide

    The toc="no" attribute is missing.

  • AsciiDocDITA.MismatchedId error script scope: raw Style guide

    The quotes in the ID are mismatched.

  • AsciiDocDITA.NestedSection error script scope: raw Style guide

    Level 2, 3, 4, and 5 sections (=== and deeper) are not supported in DITA.

  • AsciiDocDITA.PageBreak warning script scope: raw Style guide

    Page breaks are not supported in DITA.

  • AsciiDocDITA.RelatedLinks warning script scope: raw Style guide

    Content other than links cannot be mapped to DITA related-links.

  • AsciiDocDITA.ShortDescription warning script scope: raw Style guide

    Assign [role="_abstract"] to a paragraph to use it as <shortdesc> in DITA.

  • AsciiDocDITA.SidebarBlock warning script scope: raw Style guide

    Sidebars are not supported in DITA.

  • AsciiDocDITA.SnippetLink suggestion script scope: raw Style guide

    %s

  • AsciiDocDITA.TableFooter warning script scope: raw Style guide

    Table footers are not supported in DITA.

  • AsciiDocDITA.TagDirective suggestion existence scope: raw Style guide

    %s

  • AsciiDocDITA.TaskContents warning script scope: raw Style guide

    The '.Procedure' block title is missing.

  • AsciiDocDITA.TaskDuplicate warning script scope: raw Style guide

    Duplicate titles cannot be mapped to DITA tasks.

  • AsciiDocDITA.TaskExample error script scope: raw Style guide

    Examples are allowed only once in DITA tasks.

  • AsciiDocDITA.TaskInclude warning script scope: raw Style guide

    The included file may introduce content that cannot be mapped to DITA steps.

  • AsciiDocDITA.TaskSection error script scope: raw Style guide

    Sections (==) are not allowed in DITA tasks.

  • AsciiDocDITA.TaskStep warning script scope: raw Style guide

    Content other than a single list cannot be mapped to DITA steps.

  • AsciiDocDITA.TaskTitle warning script scope: raw Style guide

    Unsupported titles cannot be mapped to DITA tasks.

  • AsciiDocDITA.ThematicBreak warning script scope: raw Style guide

    Thematic breaks are not supported in DITA.