dita-bootstrap.ast/plugin.xml at develop · dita-bootstrap/dita-bootstrap.ast · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
<?xml version="1.0" encoding="UTF-8"?>
<?xml-model href="https://www.dita-ot.org/rng/plugin.rnc" type="application/relax-ng-compact-syntax"?>
<plugin id="org.dita-bootstrap.ast">
  <require plugin="org.dita.base"/>

  <!-- extension points -->
  <extension-point
    id="dita.xsl.ast-bootstrap"
    name="Bootstrap AST XSLT import"
  />

  <!-- Offers two additional extension points for dependent plug-ins -->
  <extension-point
    id="ast-bootstrap.process.pre"
    name="Custom AST Bootstrap pre-processing"
  />
  <extension-point
    id="ast-bootstrap.process.post"
    name="Custom AST Bootstrap post-processing"
  />

  <transtype
    name="ast-bootstrap"
    desc="Serializes the DITA topic/map tree as a JSON react-bootstrap component tree"
  >
    <param
      name="args.ast.toc"
      desc="Specifies the base name of the merged TOC/nav JSON file."
      type="string"
    />
    <param
      name="args.hdr"
      desc="Specifies an XML file that contains content for a running header."
      type="file"
    />
    <param
      name="args.ftr"
      desc="Specifies an XML file that contains content for a running footer."
      type="file"
    />
    <param
      name="args.breadcrumbs"
      desc="Specifies whether to include a meta.breadcrumbs title/href trail in each topic's AST."
      type="enum"
    >
      <val>yes</val>
      <val default="true">no</val>
    </param>
    <!-- same param names/values as dita-bootstrap's html5-bootstrap transtype; not all modes are
         rendered by react-harness yet, but the value threads through to toc.json either way -->
    <param
      name="nav-toc"
      type="enum"
      desc="Value passed through to toc.json's navToc field for the frontend to interpret."
    >
      <val desc="No TOC">none</val>
      <val desc="Partial TOC that shows the current topic">partial</val>
      <val desc="Full TOC">full</val>
      <val
        desc="Bootstrap styled partial TOC with descendents in a list-group"
      >list-group-partial</val>
      <val
        desc="Bootstrap styled full TOC using a list-group"
      >list-group-full</val>
      <val
        desc="Bootstrap styled partial TOC with descendents in nav-pills"
      >nav-pill-partial</val>
      <val
        desc="Bootstrap styled full ToC using indented nav-pills"
      >nav-pill-full</val>
      <val
        default="true"
        desc="Bootstrap styled collapsible menu"
      >collapsible</val>
    </param>
    <param
      name="scrollspy-toc"
      type="enum"
      desc="Value passed through to toc.json's scrollspyToc field for the frontend to interpret."
    >
      <val default="true">none</val>
      <val>list</val>
      <val desc="Scrollspy menu using a list-group">list-group</val>
      <val desc="Scrollspy menu using indented nav-pills">nav-pill</val>
    </param>
    <param
      name="menubar-toc.include"
      type="enum"
      desc="Specifies whether to include a menu bar at the top of the page"
    >
      <val>yes</val>
      <val default="true">no</val>
    </param>
  </transtype>

  <transtype
    name="ast-chrome"
    desc="Creates a chrome template file for the AST renderer and chat-bot"
  >
    <param
      name="args.docs-page.hdr"
      desc="Specifies an XML file for the docs page header content."
      type="file"
    />
    <param
      name="args.docs-page.card"
      desc="Specifies an XML file for the docs page content."
      type="file"
    />
    <param
      name="args.chat-bot.hdr"
      desc="Specifies an XML file for the chat-bot header content."
      type="file"
    />
    <param
      name="args.chat-bot.card"
      desc="Specifies an XML file for the chat-bot content."
      type="file"
    />
    <param
      name="args.footer"
      desc="Specifies an XML file for footer content."
      type="file"
    />
  </transtype>

  <feature extension="ant.import" file="build_dita2ast-bootstrap.xml"/>
  <feature extension="dita.xsl.strings" file="cfg/common/vars/strings.xml"/>

  <!-- Add template files to enable overrides to use extension points -->
  <template file="build_dita2ast-bootstrap_template.xml"/>
  <template file="xsl/dita2ast-bootstrapImpl_template.xsl"/>
</plugin>