Skip to content

Commit c941d34

Browse files
adamretteradamretter
committed
Use consistent naming for 'quick-start-guide'
1 parent f18f9be commit c941d34

File tree

205 files changed

+20
-2655
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

205 files changed

+20
-2655
lines changed

‎README.md‎

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

1212
## Documents
1313

14-
| Title | Source Location | Renderings |
15-
|-------------------|------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
16-
| 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) |
17-
| 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) |
14+
| Title | Source Location | Renderings |
15+
|-------------------|-----------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
16+
| Quick Start Guide | [cityehr-quick-start-guide/src/main/lwdita/quick-start-guide](cityehr-quick-start-guide/src/main/lwdita/quick-start-guide) | [HTML](https://cityehr.github.io/cityehr-documentation/quick-start-guide/index.html) / [PDF](https://cityehr.github.io/cityehr-documentation/quick-start-guide/quick-start-guide.pdf) |
17+
| 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/modelling-guide/index.html) / [PDF](https://cityehr.github.io/cityehr-documentation/modelling-guide/modelling-guide.pdf) |
1818

1919

2020
## Developing the Documentation
@@ -42,7 +42,7 @@ $ mvn clean package -Dcityehr-documentation-website=true
4242

4343
You can find the rendered versions of the documentation in the `target/` sub-folder of each module. For example:
4444
* `cityehr-documentation-website/target/website/index.html`
45-
* `cityehr-quick-start-guide/target/quickstart-guide.pdf`
45+
* `cityehr-quick-start-guide/target/quick-start-guide.pdf`
4646
* `cityehr-quick-start-guide/target/website/index.html`
4747
* `cityehr-modelling-guide/target/modelling-guide.pdf`
4848
* `cityehr-modelling-guide/target/website/index.html`

‎cityehr-documentation-common/src/main/xslt/split-topic-to-multiple-files.xslt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
<xsl:template match="topic">
2323
<!-- Generate an LwDITA Map -->
24-
<xsl:result-document href="{$output-folder}/quickstart-guide.ditamap" omit-xml-declaration="no" indent="yes" doctype-public="-//OASIS//DTD LIGHTWEIGHT DITA Map//EN" doctype-system="map.dtd">
24+
<xsl:result-document href="{$output-folder}/quick-start-guide.ditamap" omit-xml-declaration="no" indent="yes" doctype-public="-//OASIS//DTD LIGHTWEIGHT DITA Map//EN" doctype-system="map.dtd">
2525
<map id="{@id}">
2626
<topicmeta>
2727
<navtitle><xsl:value-of select="title"/></navtitle>

‎cityehr-documentation-common/src/test/xspec/create-topic-html.xspec‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,26 +14,26 @@
1414

1515
<x:scenario label="Scenario for testing the petal-edit-url function with source file from local filesytem">
1616
<x:call function="htop:petal-edit-url">
17-
<x:param name="petal-source-file-uri" as="xs:string">file:/Users/aretter/code/evolvedbinary/customers/cityehr/cityehr-documentation/cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular/verify-install.dita</x:param>
17+
<x:param name="petal-source-file-uri" as="xs:string">file:/Users/aretter/code/evolvedbinary/customers/cityehr/cityehr-documentation/cityehr-quick-start-guide/src/main/lwdita/quick-start-guide/verify-install.dita</x:param>
1818
<x:param name="petal-api-url" as="xs:string">https://petal.evolvedbinary.com</x:param>
1919
<x:param name="petal-github-org-name" as="xs:string">evolvedbinary</x:param>
2020
<x:param name="petal-github-repo-name" as="xs:string">cityehr-documentation</x:param>
2121
<x:param name="petal-github-branch" as="xs:string">develop</x:param>
2222
<x:param name="petal-referrer-base-url" as="xs:string">https://evolvedbinary.github.io/cityehr-documentation</x:param>
2323
</x:call>
24-
<x:expect label="Correct Petal Edit URL" select="'https://petal.evolvedbinary.com?ghrepo=evolvedbinary/cityehr-documentation&amp;source=cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular/verify-install.dita&amp;branch=develop&amp;referer=https://evolvedbinary.github.io/cityehr-documentation/verify-install.html'"/>
24+
<x:expect label="Correct Petal Edit URL" select="'https://petal.evolvedbinary.com?ghrepo=evolvedbinary/cityehr-documentation&amp;source=cityehr-quick-start-guide/src/main/lwdita/quick-start-guide/verify-install.dita&amp;branch=develop&amp;referer=https://evolvedbinary.github.io/cityehr-documentation/verify-install.html'"/>
2525
</x:scenario>
2626

2727
<x:scenario label="Scenario for testing the petal-edit-url function with source file in GitHub Action container">
2828
<x:call function="htop:petal-edit-url">
29-
<x:param name="petal-source-file-uri" as="xs:string">file:/home/runner/work/cityehr-documentation/cityehr-documentation/cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular/verify-install.dita</x:param>
29+
<x:param name="petal-source-file-uri" as="xs:string">file:/home/runner/work/cityehr-documentation/cityehr-documentation/cityehr-quick-start-guide/src/main/lwdita/quick-start-guide/verify-install.dita</x:param>
3030
<x:param name="petal-api-url" as="xs:string">https://petal.evolvedbinary.com</x:param>
3131
<x:param name="petal-github-org-name" as="xs:string">evolvedbinary</x:param>
3232
<x:param name="petal-github-repo-name" as="xs:string">cityehr-documentation</x:param>
3333
<x:param name="petal-github-branch" as="xs:string">develop</x:param>
3434
<x:param name="petal-referrer-base-url" as="xs:string">https://evolvedbinary.github.io/cityehr-documentation</x:param>
3535
</x:call>
36-
<x:expect label="Correct Petal Edit URL" select="'https://petal.evolvedbinary.com?ghrepo=evolvedbinary/cityehr-documentation&amp;source=cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular/verify-install.dita&amp;branch=develop&amp;referer=https://evolvedbinary.github.io/cityehr-documentation/verify-install.html'"/>
36+
<x:expect label="Correct Petal Edit URL" select="'https://petal.evolvedbinary.com?ghrepo=evolvedbinary/cityehr-documentation&amp;source=cityehr-quick-start-guide/src/main/lwdita/quick-start-guide/verify-install.dita&amp;branch=develop&amp;referer=https://evolvedbinary.github.io/cityehr-documentation/verify-install.html'"/>
3737
</x:scenario>
3838

3939
</x:description>

‎cityehr-documentation-website/src/main/website/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ <h1>Documents Available</h1>
3333
<article typeof="cc:Work"><time datetime="${maven.build.timestamp}" pubdate="pubdate"></time><h2 property="dct:title">Quick Start Guide</h2>
3434
<ul>
3535
<li><div id="view-html-version"><a href="quick-start-guide/index.html">View online version...</a></div></li>
36-
<li><div id="download-pdf-version"><a href="quick-start-guide/quickstart-guide.pdf">Download PDF version</a></div></li>
36+
<li><div id="download-pdf-version"><a href="quick-start-guide/quick-start-guide.pdf">Download PDF version</a></div></li>
3737
</ul>
3838
</article>
3939
</li>

‎cityehr-quick-start-guide/pom.xml‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121
</scm>
2222

2323
<properties>
24-
<lwdita.src>src/main/lwdita/quickstart-guide-modular</lwdita.src>
25-
<images.basedir>${project.build.outputDirectory}/quickstart-guide-modular/images</images.basedir>
24+
<lwdita.src>src/main/lwdita/quick-start-guide</lwdita.src>
25+
<images.basedir>${project.build.outputDirectory}/quick-start-guide/images</images.basedir>
2626
<fo.generated-resources>${project.build.directory}/generated-resources/fo</fo.generated-resources>
2727
<html.generated-resources>${project.build.directory}/generated-resources/html</html.generated-resources>
2828
<website.output.folder>${project.build.directory}/website</website.output.folder>
@@ -118,7 +118,7 @@
118118
<transformationSets>
119119
<transformationSet>
120120
<dir>${lwdita.src}</dir>
121-
<includes>quickstart-guide.ditamap</includes>
121+
<includes>quick-start-guide.ditamap</includes>
122122
<stylesheet>${common.create-map-pdf.xslt.path}</stylesheet>
123123
<parameters>
124124
<parameter>
@@ -169,9 +169,9 @@
169169
<argument>-Djavax.xml.transform.TransformerFactory=net.sf.saxon.TransformerFactoryImpl</argument>
170170
<argument>org.apache.fop.cli.Main</argument>
171171
<argument>-fo</argument>
172-
<argument>${fo.generated-resources}/quickstart-guide.fo</argument>
172+
<argument>${fo.generated-resources}/quick-start-guide.fo</argument>
173173
<argument>-pdf</argument>
174-
<argument>${project.build.directory}/quickstart-guide.pdf</argument>
174+
<argument>${project.build.directory}/quick-start-guide.pdf</argument>
175175
</arguments>
176176
</configuration>
177177
</execution>
@@ -227,7 +227,7 @@
227227
<transformationSets>
228228
<transformationSet>
229229
<dir>${lwdita.src}</dir>
230-
<includes>quickstart-guide.ditamap</includes>
230+
<includes>quick-start-guide.ditamap</includes>
231231
<stylesheet>${common.create-map-html.xslt.path}</stylesheet>
232232
<parameters>
233233
<parameter>
@@ -240,7 +240,7 @@
240240
</parameter>
241241
<parameter>
242242
<name>download-pdf-filename</name>
243-
<value>quickstart-guide.pdf</value>
243+
<value>quick-start-guide.pdf</value>
244244
</parameter>
245245
<parameter>
246246
<name>output-folder</name>
@@ -270,7 +270,7 @@
270270
<outputDir>${html.generated-resources}</outputDir>
271271
<fileMappers>
272272
<fileMapper implementation="org.codehaus.plexus.components.io.filemappers.RegExpFileMapper">
273-
<pattern>quickstart-guide.ditamap</pattern>
273+
<pattern>quick-start-guide.ditamap</pattern>
274274
<replacement>index.html</replacement>
275275
</fileMapper>
276276
<fileMapper implementation="org.codehaus.plexus.components.io.filemappers.FileExtensionMapper">
@@ -310,7 +310,7 @@
310310
<directory>${project.build.directory}</directory>
311311
<filtering>false</filtering>
312312
<includes>
313-
<include>quickstart-guide.pdf</include>
313+
<include>quick-start-guide.pdf</include>
314314
</includes>
315315
</resource>
316316
</resources>

0 commit comments

Comments
 (0)