Skip to content

Commit 5c340c1

Browse files
JennnRamirezJennnRamirez
committed
modelling guide set up
1 parent 637d7b6 commit 5c340c1

File tree

4 files changed

+371
-0
lines changed

4 files changed

+371
-0
lines changed

‎cityehr-modelling-guide/pom.xml

Lines changed: 345 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,345 @@
1+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
2+
<modelVersion>4.0.0</modelVersion>
3+
4+
<parent>
5+
<groupId>com.seveninformatics.cityehr.documentation</groupId>
6+
<artifactId>cityehr-documentation-parent</artifactId>
7+
<version>1.0.0-SNAPSHOT</version>
8+
<relativePath>../cityehr-documentation-parent</relativePath>
9+
</parent>
10+
11+
<artifactId>cityehr-modelling-guide</artifactId>
12+
<packaging>pom</packaging>
13+
14+
<name>cityEHR Modelling Guide</name>
15+
<description>The cityEHR Modelling Guide Document</description>
16+
17+
<scm>
18+
<connection>scm:git:https://github.com/cityehr/cityehr-documentation.git</connection>
19+
<developerConnection>scm:git:https://github.com/cityehr/cityehr-documentation.git</developerConnection>
20+
<url>scm:git:https://github.com/cityehr/cityehr-documentation.git</url>
21+
</scm>
22+
23+
<properties>
24+
<lwdita.src>src/main/lwdita/modelling-guide</lwdita.src>
25+
<fo.generated-resources>${project.build.directory}/generated-resources/fo</fo.generated-resources>
26+
<html.generated-resources>${project.build.directory}/generated-resources/html</html.generated-resources>
27+
<website.output.folder>${project.build.directory}/website</website.output.folder>
28+
29+
<petal.api-url>https://petal.evolvedbinary.com</petal.api-url>
30+
<petal.github-org-name>evolvedbinary</petal.github-org-name>
31+
<petal.github-repo-name>cityehr-documentation</petal.github-repo-name>
32+
<petal.github-branch>develop</petal.github-branch>
33+
<petal.referrer-base-url>https://evolvedbinary.github.io/cityehr-documentation</petal.referrer-base-url>
34+
</properties>
35+
36+
<build>
37+
<resources>
38+
<resource>
39+
<directory>src/main/lwdita</directory>
40+
<filtering>false</filtering>
41+
</resource>
42+
</resources>
43+
44+
<plugins>
45+
<plugin>
46+
<groupId>org.apache.maven.plugins</groupId>
47+
<artifactId>maven-resources-plugin</artifactId>
48+
<executions>
49+
<execution>
50+
<phase>process-resources</phase>
51+
<goals>
52+
<goal>resources</goal>
53+
</goals>
54+
</execution>
55+
</executions>
56+
</plugin>
57+
58+
<plugin>
59+
<groupId>org.codehaus.mojo</groupId>
60+
<artifactId>xml-maven-plugin</artifactId>
61+
<executions>
62+
<execution>
63+
<id>validate-lwdita</id>
64+
<phase>validate</phase>
65+
<goals>
66+
<goal>validate</goal>
67+
</goals>
68+
<configuration>
69+
<catalogHandling>strict</catalogHandling>
70+
<catalogs>
71+
<catalog>src/main/catalog/catalog.xml</catalog>
72+
</catalogs>
73+
<validationSets>
74+
<validationSet>
75+
<validating>true</validating>
76+
<dir>src/main/lwdita</dir>
77+
<includes>
78+
<include>**/*.dita*</include>
79+
</includes>
80+
</validationSet>
81+
</validationSets>
82+
</configuration>
83+
</execution>
84+
<execution>
85+
<id>validate-xslt</id>
86+
<phase>validate</phase>
87+
<goals>
88+
<goal>validate</goal>
89+
</goals>
90+
<configuration>
91+
<catalogHandling>strict</catalogHandling>
92+
<catalogs>
93+
<catalog>src/main/catalog/catalog.xml</catalog>
94+
</catalogs>
95+
<validationSets>
96+
<validationSet>
97+
<schemaLanguage>http://www.w3.org/2001/XMLSchema</schemaLanguage>
98+
<publicId>http://www.w3.org/1999/XSL/Transform</publicId>
99+
<dir>src/main/xslt</dir>
100+
<includes>
101+
<include>*.xslt</include>
102+
</includes>
103+
</validationSet>
104+
</validationSets>
105+
</configuration>
106+
</execution>
107+
<execution>
108+
<id>generate-modelling-guide-fo</id>
109+
<phase>generate-resources</phase>
110+
<goals>
111+
<goal>transform</goal>
112+
</goals>
113+
<configuration>
114+
<transformationSets>
115+
<transformationSet>
116+
<dir>${lwdita.src}</dir>
117+
<includes>modelling-guide.ditamap</includes>
118+
<stylesheet>src/main/xslt/create-map-pdf.xslt</stylesheet>
119+
<parameters>
120+
<parameter>
121+
<name>version</name>
122+
<value>${project.version}</value>
123+
</parameter>
124+
<parameter>
125+
<name>revision</name>
126+
<value>${maven.build.timestamp}</value>
127+
</parameter>
128+
</parameters>
129+
<outputDir>${fo.generated-resources}</outputDir>
130+
<fileMappers>
131+
<fileMapper implementation="org.codehaus.plexus.components.io.filemappers.FileExtensionMapper">
132+
<targetExtension>.fo</targetExtension>
133+
</fileMapper>
134+
</fileMappers>
135+
</transformationSet>
136+
</transformationSets>
137+
</configuration>
138+
</execution>
139+
</executions>
140+
</plugin>
141+
142+
<plugin>
143+
<groupId>io.xspec.maven</groupId>
144+
<artifactId>xspec-maven-plugin</artifactId>
145+
<version>2.2.0</version>
146+
<dependencies>
147+
<dependency>
148+
<groupId>net.sf.saxon</groupId>
149+
<artifactId>Saxon-HE</artifactId>
150+
<!-- Not yet compatible with Saxon 12, see: https://github.com/xspec/xspec-maven-plugin-1/issues/79 -->
151+
<version>10.9</version>
152+
</dependency>
153+
<dependency>
154+
<!-- Not yet compatible with XSpec 3, see: https://github.com/xspec/xspec-maven-plugin-1/issues/79 -->
155+
<groupId>io.xspec</groupId>
156+
<artifactId>xspec</artifactId>
157+
<version>2.3.2</version>
158+
</dependency>
159+
<dependency>
160+
<!-- See: https://github.com/xspec/xspec-maven-plugin-1/issues/73 -->
161+
<groupId>commons-io</groupId>
162+
<artifactId>commons-io</artifactId>
163+
<version>2.11.0</version>
164+
</dependency>
165+
</dependencies>
166+
<executions>
167+
<execution>
168+
<id>xspec-tests</id>
169+
<phase>test</phase>
170+
<goals><goal>run-xspec</goal></goals>
171+
</execution>
172+
</executions>
173+
</plugin>
174+
175+
<plugin>
176+
<groupId>org.codehaus.mojo</groupId>
177+
<artifactId>exec-maven-plugin</artifactId>
178+
<executions>
179+
<execution>
180+
<id>generate-modelling-guide-pdf</id>
181+
<phase>compile</phase>
182+
<goals>
183+
<goal>exec</goal>
184+
</goals>
185+
<configuration>
186+
<addOutputToClasspath>false</addOutputToClasspath>
187+
<addResourcesToClasspath>false</addResourcesToClasspath>
188+
<includeProjectDependencies>false</includeProjectDependencies>
189+
<includePluginDependencies>true</includePluginDependencies>
190+
<executable>java</executable>
191+
<arguments>
192+
<argument>-classpath</argument>
193+
<classpath/>
194+
<argument>-Djavax.xml.transform.TransformerFactory=net.sf.saxon.TransformerFactoryImpl</argument>
195+
<argument>org.apache.fop.cli.Main</argument>
196+
<argument>-fo</argument>
197+
<argument>${fo.generated-resources}/modelling-guide.fo</argument>
198+
<argument>-pdf</argument>
199+
<argument>${project.build.directory}/modelling-guide.pdf</argument>
200+
</arguments>
201+
</configuration>
202+
</execution>
203+
</executions>
204+
<dependencies>
205+
<dependency>
206+
<groupId>org.apache.xmlgraphics</groupId>
207+
<artifactId>fop</artifactId>
208+
<version>2.10</version>
209+
</dependency>
210+
<dependency>
211+
<groupId>org.slf4j</groupId>
212+
<artifactId>slf4j-simple</artifactId>
213+
<version>2.0.16</version>
214+
</dependency>
215+
<dependency>
216+
<groupId>net.sf.saxon</groupId>
217+
<artifactId>Saxon-HE</artifactId>
218+
<version>${saxon.version}</version>
219+
</dependency>
220+
<dependency>
221+
<groupId>com.evolvedbinary.thirdparty.xerces</groupId>
222+
<artifactId>xercesImpl</artifactId>
223+
<version>2.12.2.1</version>
224+
</dependency>
225+
</dependencies>
226+
</plugin>
227+
</plugins>
228+
</build>
229+
230+
<profiles>
231+
<profile>
232+
<id>modelling-guide-website</id>
233+
<build>
234+
<plugins>
235+
<plugin>
236+
<groupId>org.codehaus.mojo</groupId>
237+
<artifactId>xml-maven-plugin</artifactId>
238+
<executions>
239+
<execution>
240+
<id>generate-modelling-guide-html</id>
241+
<phase>generate-resources</phase>
242+
<goals>
243+
<goal>transform</goal>
244+
</goals>
245+
<configuration>
246+
<transformationSets>
247+
<transformationSet>
248+
<dir>${lwdita.src}</dir>
249+
<includes>modelling-guide.ditamap</includes>
250+
<stylesheet>src/main/xslt/create-map-html.xslt</stylesheet>
251+
<parameters>
252+
<parameter>
253+
<name>version</name>
254+
<value>${project.version}</value>
255+
</parameter>
256+
<parameter>
257+
<name>revision</name>
258+
<value>${maven.build.timestamp}</value>
259+
</parameter>
260+
<parameter>
261+
<name>download-pdf-filename</name>
262+
<value>modelling-guide.pdf</value>
263+
</parameter>
264+
<parameter>
265+
<name>output-folder</name>
266+
<value>${html.generated-resources}</value>
267+
</parameter>
268+
<parameter>
269+
<name>petal-api-url</name>
270+
<value>${petal.api-url}</value>
271+
</parameter>
272+
<parameter>
273+
<name>petal-github-org-name</name>
274+
<value>${petal.github-org-name}</value>
275+
</parameter>
276+
<parameter>
277+
<name>petal-github-repo-name</name>
278+
<value>${petal.github-repo-name}</value>
279+
</parameter>
280+
<parameter>
281+
<name>petal-github-branch</name>
282+
<value>${petal.github-branch}</value>
283+
</parameter>
284+
<parameter>
285+
<name>petal-referrer-base-url</name>
286+
<value>${petal.referrer-base-url}</value>
287+
</parameter>
288+
</parameters>
289+
<outputDir>${html.generated-resources}</outputDir>
290+
<fileMappers>
291+
<fileMapper implementation="org.codehaus.plexus.components.io.filemappers.RegExpFileMapper">
292+
<pattern>modelling-guide.ditamap</pattern>
293+
<replacement>index.html</replacement>
294+
</fileMapper>
295+
<fileMapper implementation="org.codehaus.plexus.components.io.filemappers.FileExtensionMapper">
296+
<targetExtension>.html</targetExtension>
297+
</fileMapper>
298+
</fileMappers>
299+
</transformationSet>
300+
</transformationSets>
301+
</configuration>
302+
</execution>
303+
</executions>
304+
</plugin>
305+
306+
<plugin>
307+
<groupId>org.apache.maven.plugins</groupId>
308+
<artifactId>maven-resources-plugin</artifactId>
309+
<executions>
310+
<execution>
311+
<id>package-modelling-guide-html</id>
312+
<phase>package</phase>
313+
<goals>
314+
<goal>copy-resources</goal>
315+
</goals>
316+
<configuration>
317+
<outputDirectory>${website.output.folder}</outputDirectory>
318+
<resources>
319+
<resource>
320+
<directory>${html.generated-resources}</directory>
321+
<filtering>false</filtering>
322+
</resource>
323+
<resource>
324+
<directory>${lwdita.src}/images</directory>
325+
<filtering>false</filtering>
326+
<targetPath>images</targetPath>
327+
</resource>
328+
<resource>
329+
<directory>${project.build.directory}</directory>
330+
<filtering>false</filtering>
331+
<includes>
332+
<include>modelling-guide.pdf</include>
333+
</includes>
334+
</resource>
335+
</resources>
336+
</configuration>
337+
</execution>
338+
</executions>
339+
</plugin>
340+
</plugins>
341+
</build>
342+
</profile>
343+
</profiles>
344+
345+
</project>

‎cityehr-modelling-guide/src/main/lwdita/modelling-guide/introduction.dita

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE topic PUBLIC "-//OASIS//DTD LIGHTWEIGHT DITA Topic//EN" "topic.dtd">
3+
<topic id="introduction">
4+
<title>Introduction</title>
5+
<shortdesc>This document describes the basic modelling for cityEHR</shortdesc>
6+
<body>
7+
<p>Coming soon! </p>
8+
9+
</body>
10+
</topic>
11+

‎cityehr-modelling-guide/src/main/lwdita/modelling-guide/modelling-guide.ditamap

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE map
3+
PUBLIC "-//OASIS//DTD LIGHTWEIGHT DITA Map//EN" "map.dtd">
4+
<map id="topic_vkq_6nv_vcc">
5+
<topicmeta>
6+
<navtitle>Modelling Guide</navtitle>
7+
<othermeta name="SPDX-License-Identifier" content="CC-BY-NC-SA-4.0"/>
8+
<othermeta name="dcterms:license" content="Creative Commons Attribution NonCommercial ShareAlike 4.0"/>
9+
<othermeta name="dcterms:license" content="https://creativecommons.org/licenses/by-nc-sa/4.0/"/>
10+
<othermeta name="dcterms:rights" content="Copyright 2023 Seven Informatics Limited"/>
11+
<othermeta name="dcterms:rightsHolder" content="https://seveninformatics.com"/>
12+
</topicmeta>
13+
<topicref href="introduction.dita"/>
14+
</map>

‎pom.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
<modules>
2424
<module>cityehr-documentation-parent</module>
2525
<module>cityehr-quick-start-guide</module>
26+
<module>cityehr-modelling-guide</module>
2627
</modules>
2728

2829
</project>

0 commit comments

Comments
 (0)