Skip to content

Commit 2fd6a87

Browse files
adamretteradamretter
committed
Rearrange common assets
1 parent 5c340c1 commit 2fd6a87

33 files changed

Lines changed: 430 additions & 130 deletions

‎.github/workflows/pages.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,14 @@ jobs:
3131
- name: Generate website (XSLT)
3232
id: generate
3333
# Override Maven properties for the Petal button url
34-
run: mvn -B -Dpetal.api-url=https://petal.evolvedbinary.com -Dpetal.github-org-name=evolvedbinary -Dpetal.github-repo-name=cityehr-documentation -Dpetal.github-branch=develop -Dpetal.referrer-base-url=https://evolvedbinary.github.io/cityehr-documentation package -Pquick-start-guide-website
34+
run: mvn -B -Dpetal.api-url=https://petal.evolvedbinary.com -Dpetal.github-org-name=evolvedbinary -Dpetal.github-repo-name=cityehr-documentation -Dpetal.github-branch=develop -Dpetal.referrer-base-url=https://evolvedbinary.github.io/cityehr-documentation package -Dcityehr-documentation-website=true
3535
- name: Setup Pages
3636
uses: actions/configure-pages@v5
3737
- name: Upload pages artifact
3838
id: deployment
3939
uses: actions/upload-pages-artifact@v3
4040
with:
41-
path: cityehr-quick-start-guide/target/website/
41+
path: cityehr-documentation-website/target/website/
4242
deploy:
4343
environment:
4444
name: github-pages

‎README.md‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,10 @@ When the source code of a document is updated in GitHub, we use GitHub Actions t
99

1010
## Documents
1111

12-
| Title | Source Location | Renderings |
13-
|---|---|---|
12+
| Title | Source Location | Renderings |
13+
|-------------------|------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
1414
| Quick Start Guide | [cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular](cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular) | [HTML](https://cityehr.github.io/cityehr-documentation/) / [PDF](https://cityehr.github.io/cityehr-documentation/quickstart-guide.pdf) |
15+
| Modelling Guide | [cityehr-modelling-guide/src/main/lwdita/modelling-guide](cityehr-modelling-guide/src/main/lwdita/modelling-guide) | [HTML](https://cityehr.github.io/cityehr-documentation/) / [PDF](https://cityehr.github.io/cityehr-documentation/modelling-guide.pdf) |
1516

1617

1718
## Developing the Documentation
@@ -34,9 +35,12 @@ $ cd cityehr-documentation
3435

3536
3. Run the following command to have Maven (mvn) render a new PDF and HTML version of the documentation:
3637
```bash
37-
$ mvn clean package -Pquick-start-guide-website
38+
$ mvn clean package -Dcityehr-documentation-website=true
3839
```
3940

4041
You can find the rendered versions of the documentation in the `target/` sub-folder of each module. For example:
42+
* `cityehr-documentation-website/target/website/index.html`
4143
* `cityehr-quick-start-guide/target/quickstart-guide.pdf`
4244
* `cityehr-quick-start-guide/target/website/index.html`
45+
* `cityehr-modelling-guide/target/modelling-guide.pdf`
46+
* `cityehr-modelling-guide/target/website/index.html`

‎cityehr-documentation-common/pom.xml‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
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-documentation-common</artifactId>
12+
<packaging>pom</packaging>
13+
14+
<name>cityEHR Documentation Common Files</name>
15+
<description>Common Files for cityEHR documentation projects</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+
<build>
24+
<plugins>
25+
<plugin>
26+
<groupId>org.codehaus.mojo</groupId>
27+
<artifactId>xml-maven-plugin</artifactId>
28+
<executions>
29+
<execution>
30+
<id>validate-xslt</id>
31+
<phase>validate</phase>
32+
<goals>
33+
<goal>validate</goal>
34+
</goals>
35+
<configuration>
36+
<catalogHandling>strict</catalogHandling>
37+
<catalogs>
38+
<catalog>${common.catalog.path}</catalog>
39+
</catalogs>
40+
<validationSets>
41+
<validationSet>
42+
<schemaLanguage>http://www.w3.org/2001/XMLSchema</schemaLanguage>
43+
<publicId>http://www.w3.org/1999/XSL/Transform</publicId>
44+
<dir>src/main/xslt</dir>
45+
<includes>
46+
<include>*.xslt</include>
47+
</includes>
48+
</validationSet>
49+
</validationSets>
50+
</configuration>
51+
</execution>
52+
</executions>
53+
</plugin>
54+
55+
<plugin>
56+
<groupId>io.xspec.maven</groupId>
57+
<artifactId>xspec-maven-plugin</artifactId>
58+
<version>2.2.0</version>
59+
<dependencies>
60+
<dependency>
61+
<groupId>net.sf.saxon</groupId>
62+
<artifactId>Saxon-HE</artifactId>
63+
<!-- Not yet compatible with Saxon 12, see: https://github.com/xspec/xspec-maven-plugin-1/issues/79 -->
64+
<version>10.9</version>
65+
</dependency>
66+
<dependency>
67+
<!-- Not yet compatible with XSpec 3, see: https://github.com/xspec/xspec-maven-plugin-1/issues/79 -->
68+
<groupId>io.xspec</groupId>
69+
<artifactId>xspec</artifactId>
70+
<version>2.3.2</version>
71+
</dependency>
72+
<dependency>
73+
<!-- See: https://github.com/xspec/xspec-maven-plugin-1/issues/73 -->
74+
<groupId>commons-io</groupId>
75+
<artifactId>commons-io</artifactId>
76+
<version>2.11.0</version>
77+
</dependency>
78+
</dependencies>
79+
<executions>
80+
<execution>
81+
<id>xspec-tests</id>
82+
<phase>test</phase>
83+
<goals><goal>run-xspec</goal></goals>
84+
</execution>
85+
</executions>
86+
</plugin>
87+
88+
</plugins>
89+
</build>
90+
91+
</project>

cityehr-quick-start-guide/src/main/catalog/catalog.xml renamed to cityehr-documentation-common/src/main/catalog/catalog.xml

File renamed without changes.

cityehr-quick-start-guide/src/main/catalog/lwdita/lw-common.ent renamed to cityehr-documentation-common/src/main/catalog/lwdita/lw-common.ent

File renamed without changes.

cityehr-quick-start-guide/src/main/catalog/lwdita/lw-common.mod renamed to cityehr-documentation-common/src/main/catalog/lwdita/lw-common.mod

File renamed without changes.

cityehr-quick-start-guide/src/main/catalog/lwdita/lw-emphasisDomain.mod renamed to cityehr-documentation-common/src/main/catalog/lwdita/lw-emphasisDomain.mod

File renamed without changes.

cityehr-quick-start-guide/src/main/catalog/lwdita/lw-highlightDomain.mod renamed to cityehr-documentation-common/src/main/catalog/lwdita/lw-highlightDomain.mod

File renamed without changes.

cityehr-quick-start-guide/src/main/catalog/lwdita/lw-map.dtd renamed to cityehr-documentation-common/src/main/catalog/lwdita/lw-map.dtd

File renamed without changes.

cityehr-quick-start-guide/src/main/catalog/lwdita/lw-map.mod renamed to cityehr-documentation-common/src/main/catalog/lwdita/lw-map.mod

File renamed without changes.

0 commit comments

Comments
 (0)