exist-commits Mailing List for eXist-db

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Revision: 18343
          http://sourceforge.net/p/exist/code/18343
Author:   dizzzz
Date:     2013-03-27 20:04:37 +0000 (Wed, 27 Mar 2013)
Log Message:
-----------
[documentation] added checks for document/link consistency

Modified Paths:
--------------
    apps/doc/modules/view.xql
    apps/doc/templates/page.html

Added Paths:
-----------
    apps/doc/data/getting-help-how-to-report.xml
    apps/doc/diagnostics.html
    apps/doc/modules/diagnostics.xql
    apps/doc/resources/existsolutions-logo.png

Added: apps/doc/data/getting-help-how-to-report.xml
===================================================================

--- apps/doc/data/getting-help-how-to-report.xml	                        (rev 0)
+++ apps/doc/data/getting-help-how-to-report.xml	2013-03-27 20:04:37 UTC (rev 18343)
@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- $Id$ -->
+<book>
+    <bookinfo>
+        <productname>eXist-db – Open Source Native XML Database</productname>
+        <title>eXist-db support</title>
+        <date>January 2013</date>
+        <author>
+            <firstname>Dannes</firstname>
+            <surname>Wessels</surname>
+            <affiliation>
+                <address format="linespecific">
+                    <email>dannes at exist-db.org</email>
+                </address>
+            </affiliation>
+        </author>
+    </bookinfo>
+    <chapter>
+        <title>Getting Help: How to report issues</title>
+        <para>When a (potential) bug is reported, please include as much of the information as described below. When
+            more information is provided, it is more easy for the developers to understand and reproduce the issue,
+            which means that the issue can be picked-up and solved much faster.</para>
+        <chapter>
+            <title>General information</title>
+            <note>
+                <para>When reporting a (suspected) bug please make the report as complete as possible: <itemizedlist>
+                        <listitem>
+                            <para>Try to write a clear (and short) description how to reproduce the problem</para>
+                        </listitem>
+                        <listitem>
+                            <para>Include the exact version (and revision), e.g. "1.4.3" (rev1234) or "2.0". </para>
+                        </listitem>
+                        <listitem>
+                            <para>Always add the operating system (e.g. "Windows7 64bit"), the Java version (e.g.
+                                "Oracle Java 7u15, 64 bit") </para>
+                        </listitem>
+                        <listitem>
+                            <para>Include relevant <b>parts</b> of the logfile (e.g.
+                                    <filename>webapp/WEB-INF/logs/exist.log</filename>)</para>
+                        </listitem>
+                        <listitem>
+                            <para>Mention the changes that have been made in the configuration files, e.g.
+                                    <filename>conf.xml</filename>, <filename>vm.properties</filename>,
+                                    <filename>tools/wrapper/conf/wrapper.conf</filename> and
+                                    <filename>tools/jetty/etc/jetty.xml</filename>.</para>
+                        </listitem>
+                    </itemizedlist>
+                </para>
+            </note>
+        </chapter>
+        <chapter>
+            <title>XQuery specific</title>
+            <note>
+                <para>When reporting a potential <b>XQuery</b> bug please: <itemizedlist>
+                        <listitem>
+                            <para>Make the XQuery, if possible, 'self containing', meaning that the XQuery does not
+                                require any additional files to run.</para>
+                        </listitem>
+                        <listitem>
+                            <para>Describe the actual XQuery result and the expected result</para>
+                        </listitem>
+                        <listitem>
+                            <para>Check if the issue has been solved in the latest version of eXist-db; For this the web
+                                based tool <ulink url="eXide" rel="nofollow">http://exist-db.org/exist/apps/eXide/index.html">eXide</ulink>
+                                can be used.</para>
+                        </listitem>
+                        <listitem>
+                            <para>Run the XQuery with <ulink url="http://kernowforsaxon.sourceforge.net">Kernow for
+                                    Saxon</ulink> and check the similarities and differences. </para>
+                        </listitem>
+                    </itemizedlist>
+                </para>
+            </note>
+            <para>Bugs can also be reported on the <ulink url="Bug" rel="nofollow">http://sourceforge.net/p/exist/bugs/">Bug Tracker</ulink>
+                where data and log files can be attached.</para>
+        </chapter>
+    </chapter>
+</book>
\ No newline at end of file

Added: apps/doc/diagnostics.html
===================================================================
--- apps/doc/diagnostics.html	                        (rev 0)
+++ apps/doc/diagnostics.html	2013-03-27 20:04:37 UTC (rev 18343)
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<div class="templates:surround?with=templates/page.html&amp;at=main">
+    <h1>Documentation diagnostics</h1>
+    <div class="diag:prepare">
+        <h2>Nr of ulinks</h2>
+        <div class="diag:countulinks"/>
+        <h2>The following documents are linked but do not exist</h2>
+        <div class="diag:deadlinks"/>
+        <h2>The following documents are not linked but do exist</h2>
+        <div class="diag:unreferenced"/>
+    </div>
+</div>
\ No newline at end of file

Added: apps/doc/modules/diagnostics.xql
===================================================================
--- apps/doc/modules/diagnostics.xql	                        (rev 0)
+++ apps/doc/modules/diagnostics.xql	2013-03-27 20:04:37 UTC (rev 18343)
@@ -0,0 +1,85 @@
+xquery version "3.0";
+
+module namespace diag="http://exist-db.org/xquery/diagnostics";
+
+import module namespace templates="http://exist-db.org/xquery/templates" at "templates.xql";
+import module namespace config="http://exist-db.org/xquery/apps/config" at "config.xqm";
+
+declare function diag:prepare($node as node(), $model as map(*)) {
+    let $ulinks := collection($config:data-root)//ulink
+    return
+        map { "ulinks" := $ulinks } 
+};
+
+declare function diag:countulinks($node as node(), $model as map(*)) {
+  let $ulinks := $model("ulinks")
+  return count($ulinks)
+};
+
+
+declare %private function diag:filterlocallinks($ulinks as node()*){
+
+    for $ulink in $ulinks
+    let $url :=  normalize-space(string(data($ulink/@url)))
+    return
+        if( starts-with($url, "http:") or starts-with($url, "https:") or starts-with($url, "mailto:") or
+        starts-with($url, "/")   or starts-with($url, "#") or $url eq "" or  starts-with($url, "{") 
+        or  starts-with($url, "api") or starts-with($url, "irc:"))
+        then
+        ()
+        else
+        $ulink
+
+};
+
+declare %private function diag:cleanUrl($url as xs:string) as xs:string {
+
+    let $rawurl :=  normalize-space($url)
+    return if (contains($rawurl, "#"))
+        then
+            substring-before($rawurl, "#")
+        else
+            $rawurl
+        
+};
+
+declare function diag:deadlinks($node as node(), $model as map(*)) {
+  let $ulinks := $model("ulinks")
+  let $filtered := diag:filterlocallinks($ulinks)
+  return
+  <table>
+  <tr><th>In document</th><th>Linked document</th></tr>
+  {
+     for $row in $filtered
+     let $url := data($row/@url)
+     return
+     if(doc-available($config:data-root || "/" || $url))
+     then
+     ()
+     else
+     <tr><td>{document-uri(root($row))}</td><td>{data($row/@url) }</td></tr>
+  }
+  </table>
+};
+
+declare function diag:unreferenced($node as node(), $model as map(*)) {
+  let $ulinks := $model("ulinks")
+  
+  let $alldocs := xmldb:get-child-resources($config:data-root)
+  return
+  <table>
+  <tr><th>Document</th></tr>
+  {
+  for $doc in $alldocs
+  return 
+    if($ulinks/@url = $doc)
+    then
+        ()
+    else
+        <tr><td>{$doc}</td></tr>
+  }
+  </table>
+  
+  };
+  
+  

Modified: apps/doc/modules/view.xql
===================================================================
--- apps/doc/modules/view.xql	2013-03-27 14:56:33 UTC (rev 18342)
+++ apps/doc/modules/view.xql	2013-03-27 20:04:37 UTC (rev 18343)
@@ -8,6 +8,7 @@
 import module namespace config="http://exist-db.org/xquery/apps/config" at "config.xqm";
 import module namespace review="http://exist-db.org/xquery/documentation/review" at "review.xql";
 import module namespace site="http://exist-db.org/apps/site-utils";
+import module namespace diag="http://exist-db.org/xquery/diagnostics" at "diagnostics.xql";
 
 declare option exist:serialize "method=html5 media-type=text/html";
 

Added: apps/doc/resources/existsolutions-logo.png
===================================================================
(Binary files differ)

Index: apps/doc/resources/existsolutions-logo.png
===================================================================
--- apps/doc/resources/existsolutions-logo.png	2013-03-27 14:56:33 UTC (rev 18342)
+++ apps/doc/resources/existsolutions-logo.png	2013-03-27 20:04:37 UTC (rev 18343)

Property changes on: apps/doc/resources/existsolutions-logo.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Modified: apps/doc/templates/page.html
===================================================================
--- apps/doc/templates/page.html	2013-03-27 14:56:33 UTC (rev 18342)
+++ apps/doc/templates/page.html	2013-03-27 20:04:37 UTC (rev 18343)
@@ -72,6 +72,9 @@
                                         <a href="{fundocs}/index.html">XQuery Functions</a>
                                     </li>
                                     <li>
+                                        <a href="{doc}/getting-help.xml">Get Support</a>
+                                    </li>
+                                    <li>
                                         <a href="http://atomic.exist-db.org">News / Wiki</a>
                                     </li>
                                     <li>





2004	Jan	Feb	Mar (57)	Apr (103)	May (164)	Jun (139)	Jul (173)	Aug (196)	Sep (221)	Oct (333)	Nov (214)	Dec (88)
2005	Jan (163)	Feb (165)	Mar (98)	Apr (93)	May (199)	Jun (118)	Jul (200)	Aug (212)	Sep (185)	Oct (297)	Nov (437)	Dec (272)
2006	Jan (542)	Feb (329)	Mar (267)	Apr (332)	May (267)	Jun (130)	Jul (161)	Aug (348)	Sep (166)	Oct (305)	Nov (173)	Dec (173)
2007	Jan (199)	Feb (118)	Mar (133)	Apr (200)	May (208)	Jun (146)	Jul (198)	Aug (146)	Sep (187)	Oct (182)	Nov (181)	Dec (83)
2008	Jan (252)	Feb (124)	Mar (124)	Apr (101)	May (143)	Jun (122)	Jul (129)	Aug (60)	Sep (80)	Oct (89)	Nov (54)	Dec (112)
2009	Jan (88)	Feb (145)	Mar (105)	Apr (164)	May (123)	Jun (154)	Jul (374)	Aug (341)	Sep (219)	Oct (137)	Nov (373)	Dec (240)
2010	Jan (197)	Feb (270)	Mar (253)	Apr (150)	May (102)	Jun (51)	Jul (300)	Aug (512)	Sep (254)	Oct (258)	Nov (288)	Dec (143)
2011	Jan (238)	Feb (179)	Mar (253)	Apr (332)	May (248)	Jun (255)	Jul (216)	Aug (282)	Sep (146)	Oct (77)	Nov (86)	Dec (69)
2012	Jan (172)	Feb (234)	Mar (229)	Apr (101)	May (212)	Jun (267)	Jul (129)	Aug (210)	Sep (239)	Oct (271)	Nov (368)	Dec (220)
2013	Jan (179)	Feb (155)	Mar (59)	Apr (47)	May (99)	Jun (158)	Jul (185)	Aug (16)	Sep (16)	Oct (7)	Nov (20)	Dec (12)
2014	Jan (21)	Feb (17)	Mar (18)	Apr (13)	May (27)	Jun (15)	Jul (19)	Aug (22)	Sep (30)	Oct (16)	Nov (19)	Dec (16)
2015	Jan (14)	Feb (24)	Mar (33)	Apr (41)	May (14)	Jun (80)	Jul (53)	Aug (8)	Sep (7)	Oct (15)	Nov (13)	Dec (2)
2016	Jan (22)	Feb (12)	Mar (30)	Apr (6)	May (33)	Jun (16)	Jul (8)	Aug (20)	Sep (12)	Oct (18)	Nov (12)	Dec (11)
2017	Jan (24)	Feb (26)	Mar (47)	Apr (23)	May (19)	Jun (14)	Jul (28)	Aug (30)	Sep (17)	Oct	Nov	Dec
2019	Jan (1)	Feb (73)	Mar (90)	Apr (42)	May (116)	Jun (90)	Jul (127)	Aug (103)	Sep (56)	Oct (42)	Nov (95)	Dec (58)
2020	Jan (102)	Feb (31)	Mar (93)	Apr (60)	May (57)	Jun (45)	Jul (29)	Aug (32)	Sep (44)	Oct (86)	Nov (51)	Dec (71)
2021	Jan (44)	Feb (25)	Mar (78)	Apr (130)	May (64)	Jun (74)	Jul (21)	Aug (64)	Sep (40)	Oct (43)	Nov (21)	Dec (99)
2022	Jan (154)	Feb (64)	Mar (45)	Apr (95)	May (62)	Jun (48)	Jul (73)	Aug (37)	Sep (71)	Oct (27)	Nov (40)	Dec (65)
2023	Jan (89)	Feb (130)	Mar (124)	Apr (50)	May (93)	Jun (46)	Jul (45)	Aug (68)	Sep (62)	Oct (71)	Nov (108)	Dec (82)
2024	Jan (53)	Feb (76)	Mar (64)	Apr (75)	May (36)	Jun (54)	Jul (98)	Aug (137)	Sep (58)	Oct (177)	Nov (84)	Dec (52)
2025	Jan (70)	Feb (53)	Mar (72)	Apr (47)	May (88)	Jun (49)	Jul (86)	Aug (51)	Sep (65)	Oct (91)	Nov (18)	Dec

S	M	T	W	T	F	S
					1	2
3	4	5	6	7	8	9
10	11	12	13	14	15	16
17	18	19	20 (4)	21 (5)	22	23 (6)
24 (6)	25 (20)	26 (13)	27 (5)	28	29	30
31

exist-commits Mailing List for eXist-db

eXist-db is a feature rich Open Source native XML database

exist-commits — Receive notifications about CVS commits.