NLdoc.Conversion.Reader.Docx.AST.Numbering (NLdoc.Conversion.Reader.Docx v1.1.2)

This module defines a struct that represents a numbering definition in a Word document as found in files like word/numbering.xml

Summary

Types

t()

Functions

style_type(arg1)

Translates the format field of a numbering definition into an NLdoc spec style type for ordered or unordered lists.

to_list(numbering)

Converts a numbering definition into an NLdoc spec ordered or unordered list based on the style type as determined by the format field.

Types

t()

@type t() :: %NLdoc.Conversion.Reader.Docx.AST.Numbering{
  format: String.t() | nil,
  id: String.t(),
  level: integer() | nil,
  start: integer()
}

Functions

style_type(arg1)

@spec style_type(t() | String.t() | nil) ::
  NLdoc.Spec.OrderedList.style_type() | NLdoc.Spec.UnorderedList.style_type()

Translates the format field of a numbering definition into an NLdoc spec style type for ordered or unordered lists.

Examples

iex> alias NLdoc.Conversion.Reader.Docx.AST.Numbering
iex> Numbering.style_type("decimal")
:decimal
iex> Numbering.style_type("lowerLetter")
:"lower-alpha"
iex> Numbering.style_type("disc")
:disc
iex> Numbering.style_type(nil)
:disc
iex> Numbering.style_type(%Numbering{id: "1", level: 1, format: "decimal", start: 3})
:decimal

to_list(numbering)

@spec to_list(t()) :: NLdoc.Spec.OrderedList.t() | NLdoc.Spec.UnorderedList.t()

Converts a numbering definition into an NLdoc spec ordered or unordered list based on the style type as determined by the format field.

Examples

iex> alias NLdoc.Conversion.Reader.Docx.AST.Numbering
iex> alias NLdoc.Spec.{OrderedList, UnorderedList}
iex> Numbering.to_list(%Numbering{id: "1", level: 1, format: "decimal", start: 3}) |> Map.put(:id, nil)
%OrderedList{start: 3, style_type: :decimal, reversed: false}
iex> Numbering.to_list(%Numbering{id: "2", level: 1, format: "lowerLetter", start: -1}) |> Map.put(:id, nil)
%OrderedList{start: -1, style_type: :"lower-alpha", reversed: false}
iex> Numbering.to_list(%Numbering{id: "3", level: 1, format: "disc", start: 1}) |> Map.put(:id, nil)
%UnorderedList{style_type: :disc}