[Volute] r3985 - trunk/projects/dm/provenance/implementation-note

Volute commit messages volutecommits at g-vo.org
Fri Apr 28 14:45:31 CEST 2017


Author: kriebe
Date: Fri Apr 28 14:45:31 2017
New Revision: 3985

Log:
Add separate file for implementation notes

Added:
   trunk/projects/dm/provenance/implementation-note/
   trunk/projects/dm/provenance/implementation-note/Makefile
   trunk/projects/dm/provenance/implementation-note/ProvImplementationNote.tex

Added: trunk/projects/dm/provenance/implementation-note/Makefile
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ trunk/projects/dm/provenance/implementation-note/Makefile	Fri Apr 28 14:45:31 2017	(r3985)
@@ -0,0 +1,31 @@
+# ivoatex Makefile.  The ivoatex/README for the targets available.
+
+# short name of your document (edit $DOCNAME.tex; would be like RegTAP)
+DOCNAME = ProvImplementationNote
+
+# count up; you probably do not want to bother with versions <1.0
+DOCVERSION = 0.1
+
+# Publication date, ISO format; update manually for "releases"
+date := $(shell date +"%Y-%m-%d")
+DOCDATE = $(date)
+
+# What is it you're writing: NOTE, WD, PR, or REC
+DOCTYPE = NOTE
+
+# Source files for the TeX document (but the main file must always
+# be called $(DOCNAME).tex
+SOURCES = $(DOCNAME).tex
+
+# List of pixel image files to be included in submitted package 
+#FIGURES = VOArchitecture-Prov2016.png CTA_DM_high_level.png CTA_prov.png usecase_Pollux_example1.png
+#updated the architecture diag . Mireille
+
+# List of PDF figures (for vector graphics)
+#VECTORFIGURES = workflow-backwards.pdf
+#classes-overview.pdf classes-core-w3c entity-details activity-details.pdf provgraph-activityflow agent-relations.pdf classes-relations-dms
+
+# Additional files to distribute (e.g., CSS, schema files, examples...)
+AUX_FILES = 
+
+include ivoatex/Makefile

Added: trunk/projects/dm/provenance/implementation-note/ProvImplementationNote.tex
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ trunk/projects/dm/provenance/implementation-note/ProvImplementationNote.tex	Fri Apr 28 14:45:31 2017	(r3985)
@@ -0,0 +1,105 @@
+\documentclass[11pt,a4paper]{ivoa}
+\input tthdefs
+
+\usepackage[utf8]{inputenc}
+\usepackage{booktabs, tabulary}    % for nicer tables
+
+% make the text in pdf properly searchable
+\usepackage{lmodern}
+
+% use listings for including text files and code snippets
+\usepackage{listings}
+
+\title{ProvenanceDM Implementation Note}
+
+\ivoagroup{DM}
+
+\author{Kristin Riebe}
+\author{Mathieu Servillat}
+\author{François Bonnarel}
+\author{Mireille Louys}
+\author{Florian Rothmaier}
+\author{Michèle Sanguillon}
+\author{IVOA Data Model Working Group}
+
+\editor{Kristin Riebe}
+\editor{Mathieu Servillat}
+
+\previousversion[]{no previous versions yet}
+
+% own definitions
+\definecolor{todocolor}{rgb}{1,1,0.8}
+\definecolor{darkred}{rgb}{0.6,0,0}
+\definecolor{rose}{rgb}{1.0,0.88,0.88}
+\definecolor{darkgrey}{rgb}{0.35,0.35,0.35}
+
+\newcommand{\TODO}[1]{%
+    \noindent%
+    \colorbox{todocolor}{%
+            \parbox{0.85\linewidth}{\sffamily \textbf{TODO:}\\
+            #1}
+    }%
+    \vspace{2pt}
+
+}
+
+\newcommand{\note}[1]{%
+    \noindent%
+    \textcolor{darkgrey}{{\sffamily Note:} \emph{#1}}%
+}
+
+
+\newcommand{\paragraphlb}[1]{\paragraph{#1}\mbox{}\\} % paragraph with line break
+
+\setlength{\fboxsep}{5pt}
+%\setlength{\fboxrule}{1.5pt}
+\newcommand{\warning}[1]{%
+    \vspace{\baselineskip}
+    \noindent
+    \parbox{\linewidth}{%
+        \colorbox{darkred}{%
+            \parbox{0.7\linewidth}{\large \sffamily \textcolor{white}{Warning}}%
+        }\\[-1pt]
+        \noindent%
+        \fcolorbox{darkred}{rose}{%
+            \parbox{0.7\linewidth-2\fboxrule}{#1}%
+        }%
+    }%
+    \vspace{\baselineskip}
+}%
+
+% for nicer tables:
+\renewcommand{\arraystretch}{1.3}
+\newcommand{\head}[1]{\textbf{#1}}
+
+
+% define new command for classes, in case we decide later on for a different style
+\newcommand{\class}[1]{\emph{#1}}
+
+\begin{document}
+\newcolumntype{Y}{>{\raggedright\arraybackslash}X}
+
+\begin{abstract}
+This document collects implementation notes for the IVOA Provenance Data Model as described in \citet{std:ProvenanceDM}. It contains more details on the used classes and attributes for each use case. It is separated from the standard document for IVOA Provenance, so it can be updated without affecting the standard.
+
+\end{abstract}
+
+\section{Provenance for CTA}
+etc. etc.
+
+\section{Pollux database}
+etc. etc.
+
+\section{HiPS use case}
+etc. etc.
+
+\section{Provenance for RAVE}
+etc. etc.
+
+\section{Provenance from SimDM classes for CosmoSim}
+etc. etc.
+
+
+\bibliography{ivoatex/ivoabib,prov-refs}
+
+\end{document}
\ No newline at end of file


More information about the Volutecommits mailing list