[gnome-user-docs] Adding .yelp-tools.cfg



commit a3ed39cc0c67ebd39bd1e4440b85b31ef3559c1c
Author: Shaun McCance <shaunm redhat com>
Date:   Wed Feb 3 21:26:46 2021 -0500

    Adding .yelp-tools.cfg

 gnome-help/C/.yelp-tools.cfg | 46 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
---
diff --git a/gnome-help/C/.yelp-tools.cfg b/gnome-help/C/.yelp-tools.cfg
new file mode 100644
index 00000000..2b6f53af
--- /dev/null
+++ b/gnome-help/C/.yelp-tools.cfg
@@ -0,0 +1,46 @@
+[namespaces]
+mal = http://projectmallard.org/1.0/
+xi = http://www.w3.org/2001/XInclude
+
+[default]
+version = gnome:40
+
+[check:hrefs]
+allow = help:orca help:baobab help:polari
+
+[check:validate]
+strict = true
+allow = http://www.w3.org/2005/11/its
+
+[check:gnome-info-legal-xi]
+select = /mal:page/mal:info
+assert = xi:include[@href='legal.xml']
+message = Must include legal.xml
+xinclude = false
+
+[check:gnome-info-legal-no]
+select = /mal:page/mal:info
+assert = not(mal:license)
+message = Must not include license directly
+xinclude = false
+
+[check:gnome-desc]
+select = /mal:page/mal:info
+assert = normalize-space(mal:desc) != ''
+message = Must have non-empty desc
+
+[check:gnome-desc-punc]
+select = /mal:page/mal:info/mal:desc
+assert = mal:link or substring(normalize-space(.), string-length(normalize-space(.))) = '.' or 
substring(normalize-space(.), string-length(normalize-space(.))) = '?'
+message = Desc must end with a period or question mark
+
+[check:gnome-desc-link]
+desc = Make sure all desc elements end with an ellipsis
+select = /mal:page/mal:info/mal:desc/mal:link
+assert = substring(normalize-space(..), string-length(normalize-space(..)) - 2) = '...' or 
substring(normalize-space(..), string-length(normalize-space(..))) = '…'
+message = Desc with links must end with an ellipsis
+
+[check:gnome-no-ascii-quotes]
+select = //mal:*[not(ancestor-or-self::mal:cmd or ancestor-or-self::mal:code or 
ancestor-or-self::mal:comment or ancestor-or-self::mal:file or ancestor-or-self::mal:input or 
ancestor-or-self::mal:key or ancestor-or-self::mal:output or ancestor-or-self::mal:screen or 
ancestor-or-self::mal:screen or ancestor-or-self::mal:sys)]
+assert = not(contains(text(), "'") or contains(text(), '"'))
+message = Use ‘curly’ “quotes” instead of 'straight' "quotes"


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]