[tracker] Add diagram in NIE documentation
- From: Ivan Frade <ifrade src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [tracker] Add diagram in NIE documentation
- Date: Thu, 19 Nov 2009 15:56:25 +0000 (UTC)
commit bce744e99f2b378374884ddcd88ecd1f472cd206
Author: Ivan Frade <ivan frade nokia com>
Date: Tue Nov 17 18:37:06 2009 +0200
Add diagram in NIE documentation
docs/ontologies/README.ontologiesdoc | 11 ++++++++---
docs/ontologies/nie/explanation.html | 2 ++
docs/ontologies/nie/overview.dia | Bin 0 -> 2086 bytes
utils/services/gen-doc.sh | 7 ++++++-
4 files changed, 16 insertions(+), 4 deletions(-)
---
diff --git a/docs/ontologies/README.ontologiesdoc b/docs/ontologies/README.ontologiesdoc
index c84b83e..08228f0 100644
--- a/docs/ontologies/README.ontologiesdoc
+++ b/docs/ontologies/README.ontologiesdoc
@@ -10,7 +10,10 @@ Expected documents/format
2) In that directory, there must be a file called 'explanation.html'
This file will be copied as-it-is into the ontology webpage
3) That file can link to any other files in the same directory
- All files in the directory will be copied together in the final web directory
+ All files in the directory will be copied together in the final web
+ directory (*)
+
+(*) .dia files will be exported as PNG.
Explanation.html
================
@@ -20,6 +23,8 @@ It will be copied as-it-is into the ontology HTML page, so it shouldn't include
HTML headers (i.e. it is NOT a valid HTML document).
The classes inside the ontology can be linked using <a
-href="#ClassName">.
+href="#ClassName">. Dia diagrams (x.dia) in the directory, should be
+linked using the png extension (<a href="x.png">). They will be
+converted automatically in doc generation time.
-the file "explanation.html.template" can be used as starting point.
+The file "explanation.html.template" can be used as starting point.
diff --git a/docs/ontologies/nie/explanation.html b/docs/ontologies/nie/explanation.html
index d944d51..5c0a6c9 100644
--- a/docs/ontologies/nie/explanation.html
+++ b/docs/ontologies/nie/explanation.html
@@ -76,3 +76,5 @@ original <a href="http://www.semanticdesktop.org/ontologies/nie">
Nepomuk NIE Ontology</a> web page.
<h2>Graphical overview</h2>
+
+<img src="./overview.png">
diff --git a/docs/ontologies/nie/overview.dia b/docs/ontologies/nie/overview.dia
new file mode 100644
index 0000000..f119e72
Binary files /dev/null and b/docs/ontologies/nie/overview.dia differ
diff --git a/utils/services/gen-doc.sh b/utils/services/gen-doc.sh
index c780589..f61620a 100755
--- a/utils/services/gen-doc.sh
+++ b/utils/services/gen-doc.sh
@@ -28,6 +28,11 @@ for f in `find ../../data/ontologies -name "*.ontology"` ; do
grep "^[a-z]\{1,\}\:[a-zA-Z]" $f |awk -v pr=$PREFIX '{print pr " " $1}' >> file-class.cache
done
+echo "Converting all dia diagrams to png"
+for image in `find ../../docs/ontologies -name "*.dia"` ; do
+ dia -t png $image
+done
+
for f in `find ../../data/ontologies -name "*.description"` ; do
# ../../data/ontologies/XX-aaa.description -> PREFIX=aaa
TMPNAME=${f%.description}
@@ -35,7 +40,7 @@ for f in `find ../../data/ontologies -name "*.description"` ; do
echo "Generating $PREFIX"
mkdir -p $BUILD_DIR/$PREFIX
# Copy before because we check in the code if the documentation exists
- if [ -e ../../docs/ontologies/$PREFIX ]; then
+ if [ -e ../../docs/ontologies/$PREFIX ]; then
cp -r ../../docs/ontologies/$PREFIX/* $BUILD_DIR/$PREFIX/ ;
fi
./ttl2html -d $f -o $BUILD_DIR/$PREFIX/index.html -l file-class.cache \
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]