[Blends-commit] r1833 - blends/trunk/blends/doc/en

[Debian Pure Blends Subversion Commit]

Author: tille
Date: Sun Aug 23 09:23:03 2009
New Revision: 1833
URL: http://svn.debian.org/viewsvn/blends?rev=1833&view=rev

Log:
Documenting new fields which influence rendering of tasks pages


Modified:
   blends/trunk/blends/doc/en/08_websentinel.sgml

Modified: blends/trunk/blends/doc/en/08_websentinel.sgml
URL: http://svn.debian.org/viewsvn/blends/blends/trunk/blends/doc/en/08_websentinel.sgml?rev=1833&view=diff&r1=1833&r2=1832&p1=blends/trunk/blends/doc/en/08_websentinel.sgml&p2=blends/trunk/blends/doc/en/08_websentinel.sgml
==============================================================================
--- blends/trunk/blends/doc/en/08_websentinel.sgml	(original)
+++ blends/trunk/blends/doc/en/08_websentinel.sgml	Sun Aug 23 09:23:03 2009
@@ -148,6 +148,52 @@
        be used in the same syntax as a Description field in Debian
        control files.
    </item>
+  <tag>Registration</tag>
+   <item>Sometimes, specifically in the case of scientific software,
+       the project authors ask for registration of their software to
+       get numbers of users of their software.  These numbers enable
+       them to ask for further funding of their project.  To support
+       this intend of authors the tasks pages can feature a link to
+       this registration page if the link is given in the tasks file
+       in the Registration field.
+   </item>
+  <tag>Published-*</tag>
+   <item>
+    <p>Several scientific software asks users of the code to quote the
+       publication which was used to describe the algorithm.
+       There was a really long discussion on the 
+       <url id="http://lists.debian.org/debian-science" name="Mailing
+       list of Debian Science Blend">
+       (<url id="http://lists.debian.org/debian-science/2008/10/msg00033.html"
+       name="see the start of the thread here">) how this might be
+       approached. There was some consensus that we need to define a
+       general control file featuring the citation information but the
+       problem has no real solution in the near future.  To find an
+       intermediate solution which solves the situation for the tasks
+       pages of Blends some <tt>Published-*</tt> tags can be inserted
+       into the tasks file which are rendered on the according tasks
+       pages.  Here comes a list of these tags:
+    </p>
+    <p>
+    <taglist>
+     <tag>Published-Authors</tag>
+      <item>Authors of the publication.  For consistency reasons it is
+      suggested to use <tt>Firstname1 Lastname1, Firstname2 Lastname2</tt>.
+      </item>
+     <tag>Published-Title</tag>
+      <item>Title of the publication.
+      </item>
+     <tag>Published-In</tag>
+      <item>Publication journal
+      </item>
+     <tag>Published-Year</tag>
+      <item>Publication year
+      </item>
+    </taglist>
+    </p>
+    <p>Any suggestion to enhance these fields is welcome.
+    </p>
+   </item>
 </taglist>
 </p>