lib/Core/AdNoctem.Substrate.Documents.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>AdNoctem.Substrate.Documents</name> </assembly> <members> <member name="T:AdNoctem.Substrate.Documents.AuthoringElement"> <summary>Top-level or nested content of an authoring template.</summary> </member> <member name="T:AdNoctem.Substrate.Documents.AuthoringInstruction"> <summary>Visible author guidance in a control with an instruction tag. Readers skip it; it is never published.</summary> </member> <member name="T:AdNoctem.Substrate.Documents.AuthoringField"> <summary>One content control of an authoring template, with a stable tag and a localized title.</summary> <remarks>Prompt is placeholder text that Word shows while the field is empty and restores when it is cleared. Content is prefilled wording saved into documents created from the template. Locked controls can be edited but not deleted.</remarks> </member> <member name="M:AdNoctem.Substrate.Documents.AuthoringField.Table(System.String,System.String,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.Collections.Generic.IEnumerable{System.Collections.Generic.IEnumerable{AdNoctem.Substrate.Documents.DocumentInline}}},System.Int32,System.Boolean)"> <remarks>Column titles form a repeated header row, which readers skip. Empty rows give authors room to type.</remarks> </member> <member name="T:AdNoctem.Substrate.Documents.AuthoringTemplate"> <summary>Declares an authoring template: content in document order, document properties and optional styling source.</summary> <remarks>Styles, theme, fonts and page size are copied from the style source; its content, headers and metadata are not. The proofing language replaces language settings in the copied styles.</remarks> </member> <member name="T:AdNoctem.Substrate.Documents.AuthoringTemplateBuilder"> <summary>Writes macro-free Word authoring templates (.dotx) or documents from a declaration.</summary> <remarks>Output is reproducible for the same declaration: control identifiers and placeholder names derive from tags. No core or application metadata, macros, external links or attached-template paths are written.</remarks> </member> <member name="F:AdNoctem.Substrate.Documents.FieldKind.PlainText"> <summary>One paragraph of text. Authored marks are ignored because the field's role owns its presentation.</summary> </member> <member name="F:AdNoctem.Substrate.Documents.FieldKind.RichText"> <summary>Paragraphs with supported marks, and optionally links and lists.</summary> </member> <member name="F:AdNoctem.Substrate.Documents.FieldKind.Table"> <summary>One table with a fixed column count and one paragraph per cell.</summary> </member> <member name="F:AdNoctem.Substrate.Documents.FieldKind.Group"> <summary>A container whose content must be held by its declared child fields.</summary> </member> <member name="T:AdNoctem.Substrate.Documents.FieldDefinition"> <summary>Declares one content-control tag, its kind, cardinality and permitted content.</summary> <remarks>Every field occurs at most once. A required child is required only when its group is present and not empty.</remarks> </member> <member name="M:AdNoctem.Substrate.Documents.FieldDefinition.Table(System.String,System.Int32,System.Boolean,System.Boolean)"> <remarks>Cells may hold marks and, when allowed, links. Header rows marked to repeat are author captions and are skipped.</remarks> </member> <member name="T:AdNoctem.Substrate.Documents.ContentSchema"> <summary>The fields recognized in a document. Tags with the prefix that are not declared are reported as unknown.</summary> <remarks>Controls tagged with an instruction tag hold template guidance only; they are skipped and never extracted. Controls with other tags, or none, are transparent containers.</remarks> </member> <member name="T:AdNoctem.Substrate.Documents.FieldContent"> <summary>Extracted value of one field.</summary> </member> <member name="P:AdNoctem.Substrate.Documents.TextFieldContent.Text"> <summary>The verbatim text; deliberate line breaks are line feeds.</summary> </member> <member name="P:AdNoctem.Substrate.Documents.TableFieldContent.Rows"> <summary>Data rows in source order; each row has the declared number of cells.</summary> </member> <member name="P:AdNoctem.Substrate.Documents.GroupFieldContent.Children"> <summary>Present, nonempty children by tag.</summary> </member> <member name="T:AdNoctem.Substrate.Documents.ContentExtraction"> <summary>The result of reading a source document against a schema.</summary> <remarks>Fields holds present, nonempty top-level fields. Absent or genuinely empty optional fields are omitted. When Succeeded is false, callers must not publish output derived from Fields.</remarks> </member> <member name="T:AdNoctem.Substrate.Documents.TextMarks"> <summary>Authored emphasis. Presentation roles such as a bold heading are not marks.</summary> </member> <member name="T:AdNoctem.Substrate.Documents.DocumentInline"> <summary>Inline content of a paragraph, list item or table cell.</summary> </member> <member name="T:AdNoctem.Substrate.Documents.TextInline"> <summary>Literal Unicode text with significant whitespace. Never markup.</summary> </member> <member name="T:AdNoctem.Substrate.Documents.LineBreakInline"> <summary>A deliberate line break inside a paragraph; not a paragraph boundary.</summary> </member> <member name="T:AdNoctem.Substrate.Documents.HyperlinkInline"> <summary>An external link whose destination is independent of its visible content.</summary> <remarks>Destinations are absolute http, https or mailto URIs. Content holds text and line breaks only.</remarks> </member> <member name="T:AdNoctem.Substrate.Documents.DocumentBlock"> <summary>Block content of a rich-text field.</summary> </member> <member name="T:AdNoctem.Substrate.Documents.ListBlock"> <summary>An ordered sequence of items. Start is the first item's number; it is 1 for bullets.</summary> </member> <member name="T:AdNoctem.Substrate.Documents.ListItem"> <summary>One list paragraph and an optional nested list.</summary> </member> <member name="T:AdNoctem.Substrate.Documents.Inlines"> <summary>Helpers for canonical inline sequences.</summary> </member> <member name="M:AdNoctem.Substrate.Documents.Inlines.ToPlainText(System.Collections.Generic.IEnumerable{AdNoctem.Substrate.Documents.DocumentInline})"> <summary>Concatenates the visible text, using a line feed for line breaks.</summary> </member> <member name="M:AdNoctem.Substrate.Documents.Inlines.Normalize(System.Collections.Generic.IEnumerable{AdNoctem.Substrate.Documents.DocumentInline})"> <summary>Merges adjacent text with identical marks, so run fragmentation never changes the model.</summary> </member> <member name="T:AdNoctem.Substrate.Documents.DocumentDiagnosticCode"> <summary>Stable diagnostic identities. Names are a compatibility contract; messages are explanatory text only.</summary> </member> <member name="T:AdNoctem.Substrate.Documents.DocumentDiagnostic"> <summary>An actionable finding about a source document, with no document text beyond a short excerpt.</summary> <remarks>Field is the content-control tag, when one applies. Location is a logical position such as "paragraph 3" or "row 2", never an XML path. Remedy tells the author how to correct the source.</remarks> </member> <member name="T:AdNoctem.Substrate.Documents.DocumentFailureReason"> <summary>Stable classifications for template-pack and writer failures.</summary> </member> <member name="T:AdNoctem.Substrate.Documents.DocumentException"> <summary>A document-generation failure caused by an invalid pack, template or release contract.</summary> <remarks>Caller argument faults use standard argument exceptions, and filesystem faults remain IO exceptions. This exception identifies failures that callers may report without inspecting messages.</remarks> </member> <member name="T:AdNoctem.Substrate.Documents.HtmlTemplate"> <summary>A parsed HTML template with validated value slots and optional section regions.</summary> <remarks>Markers are <c>{{name}}</c>, <c>{{#section}}</c> and <c>{{/section}}</c>. Sections do not nest. Every optional region declared by the pack must appear, and no unknown marker is accepted. Literal template markup is trusted; generated values are inserted only through explicit, validated slots.</remarks> </member> <member name="T:AdNoctem.Substrate.Documents.PressReleaseTags"> <summary>Content-control tags and document properties of the press-release authoring schema, version 1.</summary> </member> <member name="M:AdNoctem.Substrate.Documents.PressReleaseTags.CompanyDescription(System.String)"> <summary>The tag of a company description block, such as pr.about.example for the identifier "example".</summary> </member> <member name="T:AdNoctem.Substrate.Documents.PressReleaseSchema"> <summary>The accepted variant of the press-release schema: languages, template versions and company description blocks.</summary> <remarks>These values come from the selected template pack. The library defines no languages, organizations or wording.</remarks> </member> <member name="M:AdNoctem.Substrate.Documents.PressReleaseSchema.#ctor(System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String})"> <param name="languages">Accepted language codes, such as "de" or "en".</param> <param name="templateVersions">Accepted authoring-template versions; each document must declare one of them.</param> <param name="companyDescriptionIds">Optional company description blocks in publication order.</param> </member> <member name="T:AdNoctem.Substrate.Documents.PressReleaseSection"> <summary>A heading and blocks, such as the fact box.</summary> </member> <member name="T:AdNoctem.Substrate.Documents.SpecificationRow"> <summary>One technical specification. The label is published exactly as authored, including any colon.</summary> </member> <member name="T:AdNoctem.Substrate.Documents.CompanyDescription"> <summary>A company description block declared by the template pack, with the wording saved in the source.</summary> </member> <member name="T:AdNoctem.Substrate.Documents.PressRelease"> <summary>A validated press release, independent of any source document or output format.</summary> <remarks>Sections are presented in the fixed order defined by the output layout, regardless of source order. Null optional sections are absent and must be omitted, never filled from defaults.</remarks> </member> <member name="T:AdNoctem.Substrate.Documents.PressReleaseDocxWriter"> <summary>Writes a validated press release into a tagged Word layout from a template pack.</summary> <remarks>The base document supplies page setup, headers and styles. The writer fills the recognized content controls, removes their wrappers, and rebuilds hyperlinks and numbering from the semantic model. A base document must be a macro-free DOCX that contains exactly the controls the layout requires.</remarks> </member> <member name="T:AdNoctem.Substrate.Documents.PressReleaseHtmlWriter"> <summary>Writes a validated press release as a standalone HTML document from a template pack.</summary> <remarks>The writer selects the release language, rejects sections the pack does not map, and fills only the template's validated slots. Authored text and link destinations are encoded for their output context; an authored value is never treated as template markup.</remarks> </member> <member name="T:AdNoctem.Substrate.Documents.PressReleaseReadResult"> <summary>Release is null whenever an error diagnostic exists; warnings never prevent a result.</summary> </member> <member name="T:AdNoctem.Substrate.Documents.PressReleaseReader"> <summary>Reads and validates a press release authored from a template of the press-release/1 schema.</summary> <remarks>Language and template version come from the document's custom properties, never from its filename. An expected language is an assertion: a mismatch fails instead of overriding the document.</remarks> </member> <member name="T:AdNoctem.Substrate.Documents.PressReleaseSectionKind"> <summary>Output sections that a template pack can expose.</summary> </member> <member name="T:AdNoctem.Substrate.Documents.TemplateLanguage"> <summary>One language of a loaded template pack, including validated layout inputs.</summary> </member> <member name="T:AdNoctem.Substrate.Documents.TemplatePack"> <summary>A versioned, validated template pack loaded from a pack.json manifest and its referenced files.</summary> <remarks>The pack defines schema compatibility, languages, localized fixed labels, output section mappings and the layout inputs. All referenced files are read and hashed before a pack is returned.</remarks> </member> <member name="M:AdNoctem.Substrate.Documents.TemplatePack.Load(AdNoctem.Substrate.IO.FileSystemPath)"> <summary>Loads and validates the pack rooted at the supplied directory.</summary> <exception cref="T:AdNoctem.Substrate.Documents.DocumentException">The manifest, a referenced file or the HTML template is invalid.</exception> </member> <member name="T:AdNoctem.Substrate.Documents.WordContentReader"> <summary>Extracts schema-declared content controls from a Word package into the semantic content model.</summary> <remarks>The source is copied into memory and opened read-only; it is never saved, and no fields, links or external content are refreshed. Author-correctable problems are returned as diagnostics, as many as can be safely collected. Headers, footers and pictures outside fields are template decoration and are not extracted. Comments are reported and excluded; tracked changes block extraction.</remarks> </member> <member name="P:AdNoctem.Substrate.Documents.WordContentReader.AllowTemplates"> <summary>When true, Word templates (.dotx) are accepted, for example to inspect an authoring template.</summary> </member> <member name="M:AdNoctem.Substrate.Documents.WordContentReader.Read(AdNoctem.Substrate.IO.FileSystemPath,AdNoctem.Substrate.Documents.ContentSchema,System.Threading.CancellationToken)"> <remarks>The file is opened for reading with read sharing. IO failures, including a locked file, are exceptions.</remarks> </member> <member name="M:AdNoctem.Substrate.Documents.WordContentReader.Read(System.IO.Stream,AdNoctem.Substrate.Documents.ContentSchema,System.Threading.CancellationToken)"> <remarks>Reads the stream from its current position to the end. The stream is not closed.</remarks> </member> <member name="M:AdNoctem.Substrate.Documents.WordStyles.Numbering(DocumentFormat.OpenXml.Wordprocessing.Paragraph)"> <summary>Numbering identity and level from direct paragraph properties or the paragraph-style chain.</summary> </member> <member name="M:AdNoctem.Substrate.Documents.WordNumbering.Next(System.Int32,System.Int32)"> <summary>Advances the counter for one numbered paragraph. Null means the numbering reference is broken.</summary> </member> </members> </doc> |