suggestions on how to make the process of creating documentation easier would be very welcome :)
cheers, reto On Mon, Sep 6, 2010 at 5:20 PM, Tommaso Teofili <[email protected]> wrote: > Hi Reto, > thank you very much for pointing it out, I read it some time ago but to do > documentation I took inspiration from other Clerezza modules (and the Hudson > job) :-) > I will go through it and get back doing the right changes. > Cheers, > Tommaso > > 2010/9/6 Reto Bachmann-Gmuer <[email protected]> > >> Hi tommaso, >> >> did you read the section "Writing Documentation" in /documentation of >> a running clerezza instance? >> >> apart from the online documentation it should also be possible to use >> the org.apache.clerezza.maven-pladoc-plugin - maven plugin to add the >> documentation as reposrt to he maven site (I have to admit its a long >> time since I last used this plugin so I'm not sure its still working). >> Ideally you have a replacement for xsite and online documentation. >> >> Cheers, >> reto >> >> On Mon, Sep 6, 2010 at 11:22 AM, <[email protected]> wrote: >> > Author: tommaso >> > Date: Mon Sep 6 09:22:38 2010 >> > New Revision: 992980 >> > >> > URL: http://svn.apache.org/viewvc?rev=992980&view=rev >> > Log: >> > added site generation with a few doc hints >> > >> > Added: >> > >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/org.apache.clerezza.uima.metadata-generator/src/site/ >> > >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/org.apache.clerezza.uima.metadata-generator/src/site/resources/ >> > >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/org.apache.clerezza.uima.metadata-generator/src/site/site.xml >> > >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/org.apache.clerezza.uima.metadata-generator/src/site/xsite/ >> > >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/org.apache.clerezza.uima.metadata-generator/src/site/xsite/content/ >> > >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/org.apache.clerezza.uima.metadata-generator/src/site/xsite/content/sitemap.xml >> > >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/org.apache.clerezza.uima.metadata-generator/src/site/xsite/content/usage.xhtml >> > >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/org.apache.clerezza.uima.metadata-generator/src/site/xsite/template/ >> > >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/org.apache.clerezza.uima.metadata-generator/src/site/xsite/template/skin.html >> > >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/src/ >> > >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/src/site/ >> > >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/src/site/resources/ >> > >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/src/site/site.xml >> > >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/src/site/xsite/ >> > >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/src/site/xsite/content/ >> > >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/src/site/xsite/content/sitemap.xml >> > >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/src/site/xsite/content/usage.xhtml >> > >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/src/site/xsite/template/ >> > >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/src/site/xsite/template/skin.html >> > >> > Added: >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/org.apache.clerezza.uima.metadata-generator/src/site/site.xml >> > URL: >> http://svn.apache.org/viewvc/incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/org.apache.clerezza.uima.metadata-generator/src/site/site.xml?rev=992980&view=auto >> > >> ============================================================================== >> > --- >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/org.apache.clerezza.uima.metadata-generator/src/site/site.xml >> (added) >> > +++ >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/org.apache.clerezza.uima.metadata-generator/src/site/site.xml >> Mon Sep 6 09:22:38 2010 >> > @@ -0,0 +1,30 @@ >> > +<?xml version="1.0" encoding="UTF-8"?> >> > + >> > +<!-- >> > +/* >> > + * Licensed to the Apache Software Foundation (ASF) under one >> > + * or more contributor license agreements. See the NOTICE file >> > + * distributed with this work for additional information >> > + * regarding copyright ownership. The ASF licenses this file >> > + * to you 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. >> > + */ >> > +--> >> > + >> > +<project> >> > + <body> >> > + <menu name="Documentation"> >> > + <item name="Usage" >> href="documentation/usage.xhtml"/> >> > + </menu> >> > + </body> >> > +</project> >> > >> > Added: >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/org.apache.clerezza.uima.metadata-generator/src/site/xsite/content/sitemap.xml >> > URL: >> http://svn.apache.org/viewvc/incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/org.apache.clerezza.uima.metadata-generator/src/site/xsite/content/sitemap.xml?rev=992980&view=auto >> > >> ============================================================================== >> > --- >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/org.apache.clerezza.uima.metadata-generator/src/site/xsite/content/sitemap.xml >> (added) >> > +++ >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/org.apache.clerezza.uima.metadata-generator/src/site/xsite/content/sitemap.xml >> Mon Sep 6 09:22:38 2010 >> > @@ -0,0 +1,6 @@ >> > +<sitemap> >> > + <section> >> > + <name>Documentation</name> >> > + <page>usage.xhtml</page> >> > + </section> >> > +</sitemap> >> > \ No newline at end of file >> > >> > Added: >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/org.apache.clerezza.uima.metadata-generator/src/site/xsite/content/usage.xhtml >> > URL: >> http://svn.apache.org/viewvc/incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/org.apache.clerezza.uima.metadata-generator/src/site/xsite/content/usage.xhtml?rev=992980&view=auto >> > >> ============================================================================== >> > --- >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/org.apache.clerezza.uima.metadata-generator/src/site/xsite/content/usage.xhtml >> (added) >> > +++ >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/org.apache.clerezza.uima.metadata-generator/src/site/xsite/content/usage.xhtml >> Mon Sep 6 09:22:38 2010 >> > @@ -0,0 +1,56 @@ >> > +<?xml version="1.0" encoding="utf-8"?> >> > +<!-- >> > +/* >> > + * Licensed to the Apache Software Foundation (ASF) under one >> > + * or more contributor license agreements. See the NOTICE file >> > + * distributed with this work for additional information >> > + * regarding copyright ownership. The ASF licenses this file >> > + * to you 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. >> > + */ >> > +--> >> > +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" " >> http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd";> >> > +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en-us"> >> > +<head> >> > + <title>Usage: How to use the UIMA metadata generator </title> >> > +</head> >> > +<body> >> > +<h1>Usage: How to use the UIMA metadata generator</h1> >> > + >> > +<p>Author: Tommaso Teofili</p> >> > + >> > +<p>Date: July 27, 2010</p> >> > + >> > +<h2 id="list">1. Install UIMA bundles</h2> >> > + >> > +<p> >> > + >> > +</p> >> > + >> > +<h2 id="install">2. Install Clerezza - UIMA utils bundles</h2> >> > + >> > +<p> >> > +</p> >> > + >> > +<h2 id="start">3. Install Metadata Generator bundle</h2> >> > + >> > +<p> >> > +</p> >> > + >> > +<p> >> > + Now you can use the UIMABaseMetadataGenerator, for example you could >> bind such a generator to Discobit Editor to >> > + enable automatic extraction of the graph of tags and entities for a >> document. >> > +</p> >> > +</body> >> > +</html> >> > + >> > >> > Added: >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/org.apache.clerezza.uima.metadata-generator/src/site/xsite/template/skin.html >> > URL: >> http://svn.apache.org/viewvc/incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/org.apache.clerezza.uima.metadata-generator/src/site/xsite/template/skin.html?rev=992980&view=auto >> > >> ============================================================================== >> > --- >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/org.apache.clerezza.uima.metadata-generator/src/site/xsite/template/skin.html >> (added) >> > +++ >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/org.apache.clerezza.uima.metadata-generator/src/site/xsite/template/skin.html >> Mon Sep 6 09:22:38 2010 >> > @@ -0,0 +1,50 @@ >> > +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" " >> http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd";> >> > +<html xmlns="http://www.w3.org/1999/xhtml";> >> > + <head> >> > + <title>Apache Clerezza - ${title}</title> >> > + <link rel="stylesheet" type="text/css" href="style/style.css"/> >> > + ${head} >> > + </head> >> > + <body> >> > + >> > + <div id="banner"> >> > + <a href="http://incubator.apache.org/clerezza/";> >> > + <img id="logo" src="../images/clerezza.png" alt=" >> http://incubator.apache.org/clerezza/"/> >> > + </a><br /> >> > + </div> >> > + >> > + <div id="center" class="${centerClass}"> >> > + <div id="content"> >> > + <!-- <h1 class="FirstChild">${title}</h1> --> >> > + ${body} >> > + <p>Copyright (c) 2010 ASF </p> >> > + <br /><br /> >> > + </div> >> > + </div> >> > + >> > + <div class="SidePanel" id="left"> >> > + <#list sitemap.sections as section> >> > + <div class="MenuGroup"> >> > + <h1>${section.name}</h1> >> > + <ul> >> > + <#list section.entries as entry> >> > + <#if entry = page> >> > + <li >> class="currentLink">${entry.title}</li> >> > + <#else> >> > + <li><a >> href="${entry.href}">${entry.title}</a></li> >> > + </#if> >> > + </#list> >> > + </ul> >> > + </div> >> > + </#list> >> > + <div class="MenuGroup"> >> > + <h1>Project Site</h1> >> > + <ul> >> > + >> > + <li><a href="../index.html">Back to >> project site</a></li> >> > + </ul> >> > + </div> >> > + </div> >> > + >> > + </body> >> > +</html> >> > >> > Added: >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/src/site/site.xml >> > URL: >> http://svn.apache.org/viewvc/incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/src/site/site.xml?rev=992980&view=auto >> > >> ============================================================================== >> > --- >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/src/site/site.xml >> (added) >> > +++ >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/src/site/site.xml >> Mon Sep 6 09:22:38 2010 >> > @@ -0,0 +1,30 @@ >> > +<?xml version="1.0" encoding="UTF-8"?> >> > + >> > +<!-- >> > +/* >> > + * Licensed to the Apache Software Foundation (ASF) under one >> > + * or more contributor license agreements. See the NOTICE file >> > + * distributed with this work for additional information >> > + * regarding copyright ownership. The ASF licenses this file >> > + * to you 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. >> > + */ >> > +--> >> > + >> > +<project> >> > + <body> >> > + <menu name="Documentation"> >> > + <item name="Usage" >> href="documentation/usage.xhtml"/> >> > + </menu> >> > + </body> >> > +</project> >> > >> > Added: >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/src/site/xsite/content/sitemap.xml >> > URL: >> http://svn.apache.org/viewvc/incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/src/site/xsite/content/sitemap.xml?rev=992980&view=auto >> > >> ============================================================================== >> > --- >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/src/site/xsite/content/sitemap.xml >> (added) >> > +++ >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/src/site/xsite/content/sitemap.xml >> Mon Sep 6 09:22:38 2010 >> > @@ -0,0 +1,6 @@ >> > +<sitemap> >> > + <section> >> > + <name>Documentation</name> >> > + <page>usage.xhtml</page> >> > + </section> >> > +</sitemap> >> > \ No newline at end of file >> > >> > Added: >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/src/site/xsite/content/usage.xhtml >> > URL: >> http://svn.apache.org/viewvc/incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/src/site/xsite/content/usage.xhtml?rev=992980&view=auto >> > >> ============================================================================== >> > --- >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/src/site/xsite/content/usage.xhtml >> (added) >> > +++ >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/src/site/xsite/content/usage.xhtml >> Mon Sep 6 09:22:38 2010 >> > @@ -0,0 +1,48 @@ >> > +<?xml version="1.0" encoding="utf-8"?> >> > +<!-- >> > +/* >> > + * Licensed to the Apache Software Foundation (ASF) under one >> > + * or more contributor license agreements. See the NOTICE file >> > + * distributed with this work for additional information >> > + * regarding copyright ownership. The ASF licenses this file >> > + * to you 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. >> > + */ >> > +--> >> > +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" " >> http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd";> >> > +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en-us"> >> > +<head> >> > + <title>Usage: Apache UIMA integration within Clerezza </title> >> > +</head> >> > +<body> >> > +<h1>Usage of Apache UIMA integration within Clerezza </h1> >> > + >> > +<p>Author: Tommaso Teofili</p> >> > + >> > +<p>Date: July 27, 2010</p> >> > + >> > +<p>You can use one of this package modules to take advantage of the >> Apache Unstructured Information Management >> > + Architecture framework to enable discover and annotation of entities >> within text nodes of GraphNodes</p> >> > +<h4>UIMA - Clerezza available modules:</h4> >> > +<ul> >> > + <li>Metadata generator - this module is a particular implementation >> of the MetadataGenerator interface which >> > + provides extraction of entities from a resource depending on its >> media type. It recognizes tags and language to >> > + associate to the uploaded GraphNode and creates a new Graph >> containing the whole UIMA extracted structures >> > + </li> >> > + <li>Concept tagging - this module enables UIMA as a ConceptProvider >> for automatic concept tag suggestion</li> >> > + <li>Utils - utility classes to be used when some module wants to >> call UIMA and its services as a Clerezza bundle</li> >> > + <li>Ontologies - the ontology responsible to describe UIMA type >> system, annotations and features relationships</li> >> > +</ul> >> > +</body> >> > +</html> >> > + >> > >> > Added: >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/src/site/xsite/template/skin.html >> > URL: >> http://svn.apache.org/viewvc/incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/src/site/xsite/template/skin.html?rev=992980&view=auto >> > >> ============================================================================== >> > --- >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/src/site/xsite/template/skin.html >> (added) >> > +++ >> incubator/clerezza/trunk/org.apache.clerezza.parent/org.apache.clerezza.uima/src/site/xsite/template/skin.html >> Mon Sep 6 09:22:38 2010 >> > @@ -0,0 +1,50 @@ >> > +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" " >> http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd";> >> > +<html xmlns="http://www.w3.org/1999/xhtml";> >> > + <head> >> > + <title>Apache Clerezza - ${title}</title> >> > + <link rel="stylesheet" type="text/css" href="style/style.css"/> >> > + ${head} >> > + </head> >> > + <body> >> > + >> > + <div id="banner"> >> > + <a href="http://incubator.apache.org/clerezza/";> >> > + <img id="logo" src="../images/clerezza.png" alt=" >> http://incubator.apache.org/clerezza/"/> >> > + </a><br /> >> > + </div> >> > + >> > + <div id="center" class="${centerClass}"> >> > + <div id="content"> >> > + <!-- <h1 class="FirstChild">${title}</h1> --> >> > + ${body} >> > + <p>Copyright (c) 2010 ASF </p> >> > + <br /><br /> >> > + </div> >> > + </div> >> > + >> > + <div class="SidePanel" id="left"> >> > + <#list sitemap.sections as section> >> > + <div class="MenuGroup"> >> > + <h1>${section.name}</h1> >> > + <ul> >> > + <#list section.entries as entry> >> > + <#if entry = page> >> > + <li >> class="currentLink">${entry.title}</li> >> > + <#else> >> > + <li><a >> href="${entry.href}">${entry.title}</a></li> >> > + </#if> >> > + </#list> >> > + </ul> >> > + </div> >> > + </#list> >> > + <div class="MenuGroup"> >> > + <h1>Project Site</h1> >> > + <ul> >> > + >> > + <li><a href="../index.html">Back to >> project site</a></li> >> > + </ul> >> > + </div> >> > + </div> >> > + >> > + </body> >> > +</html> >> > >> > >> > >> >
