honeymoose
/
hapi-fhir
mirror of https://github.com/hapifhir/hapi-fhir.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Start splitting docs into separate project

This commit is contained in:
James Agnew 2019-09-22 08:58:17 -04:00
parent f4252cdeaa
commit 58b7e3a923
11 changed files with 222 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
hapi-deployable-pom/pom.xml
View File

@ -143,10 +143,15 @@
<groupId>org.checkerframework</groupId>
<artifactId>checker-compat-qual</artifactId>
</dependency>
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>ooxml-schemas</artifactId>
</dependency>
</ignoredDependencies>
<ignoredResourcePatterns>
<ignoredResourcePattern>.*\.txt$</ignoredResourcePattern>
<ignoredResourcePattern>.*\.html$</ignoredResourcePattern>
<ignoredResourcePattern>schemaorg_apache_xmlbeans.*</ignoredResourcePattern>
<ignoredResource>javac.bat</ignoredResource>
<ignoredResource>about.html</ignoredResource>
<ignoredResource>changelog.xml</ignoredResource>
@ -181,6 +186,7 @@
</links>
<additionalparam>-Xdoclint:none</additionalparam>
<additionalJOption>-Xdoclint:none</additionalJOption>
<source>8</source>
</configuration>
</reportSet>
</reportSets>
@ -204,12 +210,13 @@
<verbose>false</verbose>
<debug>false</debug>
<additionalJOption>-Xdoclint:none</additionalJOption>
<source>8</source>
</configuration>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>jar</goal>
<goal>aggregate-jar</goal>
</goals>
</execution>
</executions>

20
hapi-fhir-docs/pom.xml Normal file
View File

@ -0,0 +1,20 @@
<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">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>ca.uhn.hapi.fhir</groupId>
<artifactId>hapi-deployable-pom</artifactId>
<version>4.1.0-SNAPSHOT</version>
<relativePath>../hapi-deployable-pom/pom.xml</relativePath>
</parent>
<artifactId>hapi-fhir-docs</artifactId>
<packaging>jar</packaging>
<name>HAPI FHIR - Docs</name>
<dependencies>
</dependencies>
</project>

25
hapi-fhir-docs/src/main/java/DocsMarker.java Normal file
View File

@ -0,0 +1,25 @@
/*-
* #%L
* HAPI FHIR - Docs
* %%
* Copyright (C) 2014 - 2019 University Health Network
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
/**
* This is just here to force a javadoc to be built in order to keep
* Maven Central happy
*/
public class DocsMarker {
}

3
hapi-fhir-docs/src/main/resources/ca/uhn/hapi/fhir/changelog/V4_1_0/A-test.yaml Normal file
View File

@ -0,0 +1,3 @@
---
type: add
title: feature

4
hapi-fhir-docs/src/main/resources/ca/uhn/hapi/fhir/docs/files.properties Normal file
View File

@ -0,0 +1,4 @@
section.introduction.title=Welcome to Smile CDR
page.introduction.table_of_contents=Table of Contents
page.introduction.changelog=Changelog

50
hapi-fhir-docs/src/main/resources/ca/uhn/hapi/fhir/docs/introduction/changelog.md Normal file
View File

@ -0,0 +1,50 @@
# Changelog
<th:block th:each="version : ${changelog.versions}">
# Smile CDR <th:block th:text="${version}"/> <th:block th:if="${changelog.changes.get(version).codename} != null" th:text="' (' + ${changelog.changes.get(version).codename} + ')'"/>
## Release Information
<th:block th:if="${changelog.changes.get(version).releaseDate} != null">
**Released:** <th:block th:text="${changelog.changes.get(version).releaseDate.getValueAsString()}"/>
</th:block>
<th:block th:if="${changelog.changes.get(version).codename} != null">
**Codename:** <th:block th:text="'(' + ${changelog.changes.get(version).codename} + ')'"/>
</th:block>
<th:block th:if="${changelog.changes.get(version).upgrade} != null">
## Upgrade Instructions
[(${changelog.changes.get(version).upgrade})]
</th:block>
## Changes
<table class="table">
<tr th:each="change : ${changelog.changes.get(version)}">
<td>
<a th:name="'change' + ${version} + '-' + ${change.id}"></a>
<span style="color: #129c49; font-size: 1.1em;" th:if="${change.type} == 'add'">
<i class="fa fa-plus"></i>
</span>
<span style="color: #129c49; font-size: 1.1em;" th:if="${change.type} == 'change'">
<i class="fa fa-cogs"></i>
</span>
<span style="color: #ee2324; font-size: 1.1em;" th:if="${change.type} == 'fix'">
<i class="fa fa-bug"></i>
</span>
<span style="color: #64c2d1; font-size: 1.1em;" th:if="${change.type} == 'perf'">
<i class="fa fa-rocket"></i>
</span>
<span style="color: #ee2324; font-size: 1.1em;" th:if="${change.type} == 'security'">
<i class="fa fa-shield-alt"></i>
</span>
</td>
<td>
<th:block th:utext="${change.title}"/>
</td>
</tr>
</table>
</th:block>

26
hapi-fhir-docs/src/main/resources/ca/uhn/hapi/fhir/docs/introduction/table_of_contents.md Normal file
View File

@ -0,0 +1,26 @@
# Table of Contents
Welcome to HAPI FHIR!
---
<table class="helpTocTable">
<th:block th:each="chapter : ${chapters}">
<tr class="helpTocChapter">
<td th:text="${chapter.sectionNumber} + '.0.0'" class="helpTocChapter"></td>
<td th:text="${chapter.title}" class="helpTocChapter"></td>
</tr>
<th:block th:each="page : ${chapter.pages}">
<tr>
<td th:text="${page.sectionNumber} + '.0'"></td>
<td class="helpTocPage"><a th:href="${page.link}" th:text="${page.title}"></a></td>
</tr>
<th:block th:each="section : ${page.sections}">
<tr>
<td th:text="${section.sectionNumber}"></td>
<td class="helpTocSection"><a th:href="${page.link} + ${section.anchor}" th:text="${section.title}"></a></td>
</tr>
</th:block>
</th:block>
</th:block>
</table>

17
hapi-fhir-structures-dstu3/pom.xml
View File

@ -82,6 +82,16 @@
<skipUpdateLicense>true</skipUpdateLicense>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<includeDependencySources>true</includeDependencySources>
<dependencySourceIncludes>
<include>ca.uhn.hapi.fhir:org.hl7.fhir.dstu3</include>
</dependencySourceIncludes>
</configuration>
</plugin>
</plugins>
</build>
@ -160,6 +170,13 @@
<artifactId>xpp3</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.antlr</groupId>
<artifactId>ST4</artifactId>
<version>4.1</version>
<optional>true</optional>
</dependency>
<!--
<dependency>
<groupId>xpp3</groupId>

34
hapi-fhir-structures-r4/pom.xml
View File

@ -94,6 +94,30 @@
<optional>true</optional>
</dependency>
<!--
Optional dependencies used by org.hl7.fhir.r4
We include these here to get the aggregate JavaDoc to work
-->
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi</artifactId>
<version>4.0.1</version>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-ooxml</artifactId>
<version>4.0.1</version>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>ooxml-schemas</artifactId>
<version>1.4</version>
<optional>true</optional>
</dependency>
<!-- Testing -->
<dependency>
<groupId>org.xmlunit</groupId>
@ -329,6 +353,16 @@
</instructions>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<includeDependencySources>true</includeDependencySources>
<dependencySourceIncludes>
<include>ca.uhn.hapi.fhir:org.hl7.fhir.r4</include>
</dependencySourceIncludes>
</configuration>
</plugin>
</plugins>
</build>

33
hapi-fhir-structures-r5/pom.xml
View File

@ -94,6 +94,29 @@
<optional>true</optional>
</dependency>
<!--
Optional dependencies used by org.hl7.fhir.r4
We include these here to get the aggregate JavaDoc to work
-->
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi</artifactId>
<version>4.0.1</version>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-ooxml</artifactId>
<version>4.0.1</version>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>ooxml-schemas</artifactId>
<version>1.4</version>
<optional>true</optional>
</dependency>
<!-- Testing -->
<dependency>
<groupId>org.xmlunit</groupId>
@ -323,6 +346,16 @@
</instructions>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<includeDependencySources>true</includeDependencySources>
<dependencySourceIncludes>
<include>ca.uhn.hapi.fhir:org.hl7.fhir.r5</include>
</dependencySourceIncludes>
</configuration>
</plugin>
</plugins>
</build>

3
pom.xml
View File

@ -1552,7 +1552,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.1.0</version>
<version>3.1.1</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@ -2361,6 +2361,7 @@
<module>hapi-fhir-bom</module>
<module>hapi-deployable-pom</module>
<module>hapi-fhir-base</module>
<module>hapi-fhir-docs</module>
<module>hapi-fhir-test-utilities</module>
<module>hapi-tinder-plugin</module>
<module>hapi-tinder-test</module>