Skip to content

Commit

Permalink
Merge branch 'release/0.3.3'
Browse files Browse the repository at this point in the history
  • Loading branch information
ColinMaudry committed Jan 6, 2016
2 parents f99905a + b0787ef commit d52b932
Show file tree
Hide file tree
Showing 13 changed files with 57 additions and 28 deletions.
4 changes: 2 additions & 2 deletions .gitignore
Expand Up @@ -8,8 +8,8 @@ test*
dita2rdf/demo/information/
dita2rdf/demo/docsrc
dita2rdf/demo/out/*
dita2rdf/src/customization/*.properties
!dita2rdf/src/customization/build_template.properties
**/*.properties
!**/*_template.properties
dita2rdf/src/view
*.rdf
*.list
Expand Down
14 changes: 13 additions & 1 deletion README.md
@@ -1,14 +1,26 @@
The DITA RDF project
The DITA RDF project 0.3.3
====================

The objective of this project is to develop an ontology to describe [DITA XML](http://docs.oasis-open.org/dita/v1.2/os/spec/DITA1.2-spec.html) objects and to publish tools to generate [RDF](http://www.w3.org/TR/rdf11-primer/) triples based on that ontology. In the end, it enables the publication of the metadata of a DITA documentation set to the Semantic Web and consequently its linking with other data types (product, people, sales, non-DITA document metadata, etc.).

The documentation of the project and its deliverables is published at [http://purl.org/dita/ditardf-project](http://purl.org/dita/ditardf-project).

## Change log

#### 0.3.3

- Realized I didn't have a change log
- DITA OT plugin: Upload to triple store is skipped is build.properties is not available
- DITA OT plugin: Externalized basic configuration to .properties file
- Documentation: Updated contact info
- Improved publishdoc script

##Public domain

The DITA RDF ontology, the DITA RDF plugin and all the code included in the DITA RDF project are free and released into the public domain, excepted the parts that were reused from the pdf2 DITA-OT plugin, developed by Idiom Inc.

See [UNLICENSE](UNLICENSE) for the whole shebang.

If you find the DITA RDF project useful, I would be grateful if you tweet about it (something like "Kudos to @CMaudry for the #DITA RDF project! http://purl.org/dita/ditardf-project #ditardf") or if you mention the origin and the author of this software in the documentation of your product.


18 changes: 11 additions & 7 deletions build_publishdoc.xml
Expand Up @@ -2,32 +2,36 @@
<project basedir="." name="build-documentation" default="package-zip-copy-plugin">
<property file="publishdoc.properties"/>
<!-- The Piwik tracking code and the link to Github in the top right corner of the page -->
<loadresource property="piwik-code">
<file file="documentation/codepiwik.txt"/>
</loadresource>
<condition property="piwik-code-available">
<available file="documentation/piwik-code.txt"/>
</condition>
<target name="copy-doc-to-documentation">
<copy todir="documentation/" failonerror="false">
<file file="documentation/src/out/chm/dita-rdf.chm"/>
<file file="documentation/src/out/pdf/dita-rdf.pdf"/>
<fileset dir="documentation/src/out/webhelp/" includes="**/*"/>
</copy>
<delete dir="documentation/install/"/>
<delete dir="documentation/src/out/"/>
<!--<delete dir="documentation/src/out/"/>-->
<delete dir="documentation/src/temp/"/>
<delete file="dita2rdf/demo/ditardf-project.zip"/>
</target>
<target name="piwik-code">
<target name="piwik-code" if="piwik-code-available">
<condition property="hasCode">
<resourcecontains substring="piwik" resource="documentation/index.html"/>
</condition>
<antcall target="insert-piwik-code"/>
</target>
<target name="insert-piwik-code" unless="hasCode">
<loadresource property="piwik-code">
<file file="documentation/codepiwik.txt"/>
</loadresource>
<echo message="Adding Piwik code to index.html..." level="info"/>
<replace file="documentation/index.html" token="&lt;/body>" value="${piwik-code}"/>
</target>
<target name="ftp-webhelp" depends="copy-doc-to-documentation,piwik-code">
<scp todir="${sftp.user}:${sftp.password}@${sftp.server}:${sftp.path}" trust="yes" verbose="yes" sftp="true">
<fileset dir="documentation/" includes="*/**" excludes="dita-rdf.html, *.pdf, *.chm, src/"/>
<scp todir="${sftp.user}:${sftp.password}@${sftp.server}:${sftp.path}" trust="yes" verbose="yes" sftp="true" failonerror="true">
<fileset dir="documentation/" includes="**/*" excludes="dita-rdf.html, *.pdf, *.chm, src/"/>
</scp>
</target>
<target name="package-zip-copy-plugin" depends="ftp-webhelp">
Expand Down
20 changes: 10 additions & 10 deletions dita2rdf/build_demo.xml
Expand Up @@ -2,8 +2,8 @@
<project name="build.dita-rdf.dita-ot.plugin" default="package-zip-copy-plugin-demo" basedir=".">

<!-- User properties -->
<!-- Enter the location of you DITA OT directory here: -->
<property name="ditaot.dir" value="C:/Users/colin/programs/dita-ot-2.1.0/"/>
<property file="build_demo.properties"/>

<condition property="executable" value="dita.bat" else="dita">
<os family="windows"/>
</condition>
Expand Down Expand Up @@ -42,7 +42,7 @@
<property name="plugin-id" value="com.github.colinmaudry.dita2rdf"></property>
<property name="temp.plugin.dir" location="temp"/>
<property name="dita-rdf-ot-plugin-dir" value="dita-ot"/>
<property name="ditaot.classpath" value="${ditaot.dir}\lib;${ditaot.dir}lib/dost.jar;${ditaot.dir}lib/commons-codec-1.4.jar;${ditaot.dir}lib/resolver.jar;${ditaot.dir}lib/icu4j.jar;${ditaot.dir}lib/xercesImpl.jar;${ditaot.dir}lib/xml-apis.jar;${ditaot.dir}lib/saxon/saxon9.jar;${ditaot.dir}lib/saxon/saxon9-dom.jar;"/>
<property name="ditaot.classpath" value="${ditaot.dir}/lib;${ditaot.dir}lib/dost.jar;${ditaot.dir}/lib/commons-codec-1.4.jar;${ditaot.dir}/lib/resolver.jar;${ditaot.dir}/lib/icu4j.jar;${ditaot.dir}/lib/xercesImpl.jar;${ditaot.dir}/lib/xml-apis.jar;${ditaot.dir}/lib/saxon/saxon9.jar;${ditaot.dir}/lib/saxon/saxon9-dom.jar;"/>
<target name="package-zip-copy-plugin" depends="package-zip,copy-plugin-dita-ot">
<zip destfile="demo/ditardf-project.zip">
<fileset dir="../documentation/src/" includes="**/*.dita*"/>
Expand All @@ -66,8 +66,8 @@
</target>

<target name="copy-plugin-dita-ot" description="Copy the DITA RDF plugin to the DITA OT">
<delete dir="${ditaot.dir}plugins/${plugin-id}"/>
<copy todir="${ditaot.dir}plugins">
<delete dir="${ditaot.dir}/plugins/${plugin-id}"/>
<copy todir="${ditaot.dir}/plugins">
<fileset dir="${temp.plugin.dir}" includes="${plugin-id}/**/*"></fileset>
</copy>
<antcall target="run-integrator"/>
Expand All @@ -85,27 +85,27 @@
</target>
<target name="demo">

<delete includeemptydirs="true" verbose="yes">
<delete includeemptydirs="true" verbose="yes" failonerror="false">
<fileset dir="demo/out" includes="**" excludes="*.rdf"/>
</delete>
<antcall target="download-oxygen-userguide"/>
<mkdir dir="${temp.demo.dir}"/>
<mkdir dir="${demo.input.dir}"/>
<unzip src="${demo.zip}" dest="${demo.input.dir}"/>
<move file="${demo.input.dir}/${demo.input.path}${demo.input.filename}" tofile="${demo.input}"/>
<exec dir="${ditaot.dir}" executable="${ditaot.dir}bin/${executable}" searchpath="true">
<exec dir="${ditaot.dir}" executable="${ditaot.dir}/bin/${executable}">
<env key="DITA_DIR" value="${ditaot.dir}"/>
<env key="CLASSPATH" value="${ditaot.classpath}"/>
<arg prefix="-Djavax.xml.transform.TransformerFactory=" value="net.sf.saxon.TransformerFactoryImpl"/>
<arg line="-input ${demo.input}"/>
<arg line="-output ${demo.dir}/out"/>
<arg line="-output ${output.dir}"/>
<arg line="-temp ${temp.demo.dir}/${demo-set}"/>
<arg prefix="-Dclean.temp=" value="no"/>
<arg prefix="-Dclean.temp=" value="${clean.temp}"/>
<arg line="-format rdf"/>
<arg line="-verbose"/>
<arg prefix="-Dargs.debug=" value="0"/>
<!--<arg line="-filter ${demo.input.dir}${demo.input.path}editor.ditaval"/>-->
<arg prefix="-Dargs.buildBrowser=" value="1"/>
<arg prefix="-Dargs.buildBrowser=" value="${build.browser}"/>
</exec>
</target>

Expand Down
14 changes: 14 additions & 0 deletions dita2rdf/build_demo_template.properties
@@ -0,0 +1,14 @@
#Parameters to upload to run the text/demo script resulting XML to a repository

#The directory where your DITA OT is installed
ditaot.dir=/home/colin/programs/dita-ot-2.1.0
#ditaot.dir=c:/Users/colin/programs/dita-ot-2.1.0

#The directory where you want to store the result
output.dir=${ditaot.dir}/out

#Whether or not you want the temporary folder to be deleted at the end of the process (yes/no)
clean.temp=no

#Whether or not you want to build the DITA Darwin browser. To build the browser, the upload of the RDF to a triple store must be configured in customization/build.properties.
build.browser=no
Binary file modified dita2rdf/demo/ditardf-project.zip
Binary file not shown.
Binary file modified dita2rdf/dita2rdf-ditaot-plugin.zip
Binary file not shown.
2 changes: 1 addition & 1 deletion dita2rdf/src/build.xml
Expand Up @@ -181,7 +181,7 @@
<equals arg1="${repository.http.method}" arg2="PUT"/>
</condition>

<target name="publish.repository">
<target name="publish.repository" unless="skipUpload">
<tstamp/>
<xmlproperty file="${xmlConfigPath}"/>
<xmlproperty file="${dita.temp.dir}\docmeta.xml"/>
Expand Down
Binary file modified documentation/dita-rdf.pdf
Binary file not shown.
5 changes: 2 additions & 3 deletions documentation/src/concept/background.dita
Expand Up @@ -16,8 +16,7 @@

<p>Finally, since the challenges we faced were most likely similar to the ones faced by other DITA-enabled organizations, I decided to share my findings.</p>

<p><xref format="html" href="http://twitter.com/wohnjalker" scope="external">John Walker</xref> and Tim Nelissen, from NXP CDS, have since then founded <xref format="html"
href="http://semaku.com/" scope="external">Semaku</xref>, a consultancy and software company dedicated to helping organizations to solve their data and content silo issues
using the <xref format="html" href="http://linkeddata.org/" scope="external">linked data</xref> principles. I joined them in April 2014.</p>
<p>Since April 2015, I'm an independent consultant based in Rennes, France (<xref format="html"
href="http://colin.maudry.com" scope="external">my website</xref>).</p>
</conbody>
</concept>
5 changes: 3 additions & 2 deletions documentation/src/concept/contact-troubleshooting.dita
Expand Up @@ -21,11 +21,12 @@
<title>Contact</title>
<p>I fluently speak French, English and Spanish.</p>
<ul id="ul_vjj_kvr_3p">
<li>My website: <xref format="html"
href="http://colin.maudry.com" scope="external">http://colin.maudry.com</xref></li>
<li>Twitter: <xref format="html" href="https://twitter.com/CMaudry" scope="external">@CMaudry</xref> (you can also follow the hash tag <xref format="html"
href="https://twitter.com/hashtag/ditardf" scope="external">#ditardf</xref>)
</li>
<li>Email: <xref href="mailto:colin@maudry.com" scope="external" format="html">colin@maudry.com</xref>, or <xref href="mailto:colin.maudry@semaku.com" scope="external" format="html">colin.maudry@semaku.com</xref> for tailored
service</li>
<li>Email: <xref href="mailto:colin@maudry.com" scope="external" format="html">colin@maudry.com</xref></li>
<li>LinkedIn: <xref format="html" href="https://nl.linkedin.com/in/colinmaudry/en" scope="external">Colin Maudry</xref></li>
<li>Skype: colin.maudry</li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion documentation/src/concept/going-further.dita
Expand Up @@ -18,7 +18,7 @@
<li>etc...</li>
</ul>
<p>You could automate the creation of data feeds and reports that would give you the pulse of your organization and help you to take decisions based on tangible facts. </p>
<p>If you are interested in connecting your DITA metadata graph to more data, you can email me at <xref href="mailto:colin.maiudry@semaku.com" scope="external" format="html">colin.maudry@semaku.com</xref>,
<p>If you are interested in connecting your DITA metadata graph to more data, you can email me at <xref href="mailto:colin@maudry.com" scope="external" format="html">colin@maudry.com</xref>,
and, together, we will study your requirements.</p>
</conbody>
</concept>
1 change: 0 additions & 1 deletion documentation/src/concept/welcome.dita
Expand Up @@ -2,7 +2,6 @@
<concept id="concept_gfw_qhr_3p" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="urn:oasis:names:tc:dita:xsd:concept.xsd">
<title>Welcome to the <keyword keyref="project-name"/></title>
<shortdesc></shortdesc>
<prolog>
<author>Colin Maudry</author>
</prolog>
Expand Down

0 comments on commit d52b932

Please sign in to comment.