gnumed-doc 1.4.6+dfsg-1 / usr / share / doc / gnumed / user-manual / Gnumed / GmManualPlaceholderReference.html

This file is indexed.

/usr/share/doc/gnumed/user-manual/Gnumed/GmManualPlaceholderReference.html is in gnumed-doc 1.4.6+dfsg-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
	<title> GmManualPlaceholderReference &lt; Gnumed &lt; Foswiki</title>
		  
	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> <meta name="robots" content="noindex" /> <link rel="alternate" type="application/rss+xml" title="RSS Feed" href="WebRss.html" />
	<link rel="icon" href="../rsrc/System/ProjectLogos/favicon.ico" type="image/x-icon" /> <link rel="shortcut icon" href="../rsrc/System/ProjectLogos/favicon.ico" type="image/x-icon" />
	<link rel="alternate" href="http://wiki.gnumed.de/bin/edit/Gnumed/GmManualPlaceholderReference?t=1391005513" type="application/x-wiki" title="edit GmManualPlaceholderReference" />
	<meta name="description" content="GmManualPlaceholderReference" />
	 <!--[if IE]></base><![endif]-->
	
	<style type="text/css" media="all">
@import url('../rsrc/System/SkinTemplates/base.css');
</style>
<style type="text/css" media="all">
@import url('../rsrc/System/SkinTemplates/default.css');
</style>
<!--[if IE]><style type="text/css" media="screen">
pre {
	overflow-x:auto;
	padding-bottom:expression(this.scrollWidth > this.offsetWidth ? 16 : 0);
}
</style>
<![endif]-->

<meta name="foswiki.PUBURL" content="http://wiki.gnumed.de/pub" /> <!-- PUBURL -->
<meta name="foswiki.PUBURLPATH" content="/pub" /> <!-- PUBURLPATH -->
<meta name="foswiki.SCRIPTSUFFIX" content="" /> <!-- SCRIPTSUFFIX -->
<meta name="foswiki.SCRIPTURL" content="http://wiki.gnumed.de/bin" /> <!-- SCRIPTURL -->
<meta name="foswiki.SCRIPTURLPATH" content="/bin" /> <!-- SCRIPTURLPATH -->
<meta name="foswiki.SERVERTIME" content="29%20Jan%202014%20-%2015:25" /> <!-- SERVERTIME -->
<meta name="foswiki.SKIN" content="twikinet%2c%20pattern" /> <!-- SKIN -->
<meta name="foswiki.SYSTEMWEB" content="System" /> <!-- SYSTEMWEB -->
<meta name="foswiki.TOPIC" content="GmManualPlaceholderReference" /> <!-- TOPIC -->
<meta name="foswiki.USERNAME" content="KarstenHilbert" /> <!-- USERNAME -->
<meta name="foswiki.USERSWEB" content="Main" /> <!-- USERSWEB -->
<meta name="foswiki.WEB" content="Gnumed" /> <!-- WEB -->
<meta name="foswiki.WIKINAME" content="KarstenHilbert" /> <!-- WIKINAME -->
<meta name="foswiki.WIKIUSERNAME" content="Main.KarstenHilbert" /> <!-- WIKIUSERNAME -->
<meta name="foswiki.NAMEFILTER" content="%5b%5cs%5c*%3f~%5e%5c%24%40%25%60%22'%26%3b%7c%3c%3e%5c%5b%5c%5d%23%5cx00-%5cx1f%5d" /> <!-- NAMEFILTER --><!--JQUERYPLUGIN::FOSWIKI::META-->
<script type='text/javascript' src='../rsrc/System/JQueryPlugin/jquery-1.4.3.js'></script><!--JQUERYPLUGIN-->
<script type='text/javascript' src='../rsrc/System/JQueryPlugin/plugins/livequery/jquery.livequery.js'></script><!--JQUERYPLUGIN::LIVEQUERY-->
<script type='text/javascript' src='../rsrc/System/JQueryPlugin/plugins/foswiki/jquery.foswiki.js'></script><!--JQUERYPLUGIN::FOSWIKI-->
<script type='text/javascript' src='../rsrc/System/JSTreeContrib/jquery.jstree.js'></script><!--JQUERYPLUGIN::JSTREE-->
</head>
<body class=""><div class="foswikiPage">
<a name="PageTop"></a> 
<p></p>
<p></p>
<h1><a name="Placeholder_Reference"></a>  Placeholder Reference </h1>
<p></p>
<h2><a name="General:"></a>  General: </h2>
<p></p>
The general form of placeholders is as follows:
<p></p>
<pre>$&#60;field&#95;1::field&#95;2::field&#95;3&#62;$</pre><br>
which stand for �
<p></p>
<pre>$&#60;name::args::max string length&#62;$</pre>
<p></p>
<h2><a name="Syntax_and_usage:"></a>  Syntax and usage: </h2>
<p></p>
Every GNUmed placeholder must currently be bounded by $&lt; and &gt;$.
<p></p>
<code>name</code> <ul>
<li> must, in all cases, provide a valid (defined-in-GNUmed) placeholder name as listed within <a href="http://gitorious.org/gnumed/gnumed/source/1824b477cb7c6a94a90b46fb7eae32c0f8c41c4e:gnumed/gnumed/client/wxpython/gmMacro.py#L166-181" target="_top">this source file</a>.
</li></ul> 
<p></p>
<code>args</code> <ul>
<li> are in some cases unavailable and inapplicable, for example in 'lastname'
</li> <li> otherwise provides one or more (sub) arguments, in the latter case separated by '//'
</li> <li> may support an "output template" � see below.
</li></ul> 
<p></p>
<code>max string length</code> <ul>
<li> when specified, must be an integer and
</li> <li> except as noted below, is optional, thus usually allowing $&lt;field_1::::integer&gt;$ or $&lt;field_1::::&gt;$.
</li></ul> 
<p></p>
Beginning with client release 1.4, the placeholder must always include the two sets of  '::' even when no argument or max length are supplied.
<p></p>
Spaces, such as might make a placeholder's incarnation more readable, may not be harmless. Within a placeholder, spaces � except when part of a valid and properly formatted argument � may break the placeholder particularly if interposed between the $ and either &lt; or &gt;, and between the $&lt; and the placeholder name. Spaces on either or both sides of 'max string length' should, however, still allow detection of the 3rd field integer:
<p></p>
<pre>   $&#60;field&#95;1:::: 60&#62;$</pre><br>
<pre>   $&#60;field&#95;1:::: 60 &#62;$</pre><br>
<pre>   $&#60;field&#95;1::::60 &#62;$</pre><br>
For the 'injectable' placeholders (form_� ) <ul>
<li> 'max string length' is non-optional and
</li> <li> if these placeholders had not been 'set' (programmed) into the code calling it, the placeholder's own name its returned
</li></ul> 
<p></p>
In all other cases where a properly-formatted placeholder cannot resolve to a value ��as in the case where no value had yet been created for a patient � the resulting output will depend whether or not the instance of GNUmed is running with --debug on. If yes, it will return "no URL for �" and otherwise u'' (IOW, an empty value).
<p></p>
There is, at present, no way to include conditional statements inside a placeholder, for example to include or exclude characters (such as ', ") depending on whether a key (like 'suburb') is empty.
<p></p>
<h2><a name="Placeholder_output_templates_44_fields_44_escape_styles_and_formats"></a>  Placeholder output templates, fields, escape styles and formats </h2>
<p></p>
Some placeholder <code>args</code> involve an output template of the form
<p></p>
<pre>   something &#37;s something else</pre><br>
where 'something' and 'something else' represent any fixed text desired to be outputted, and where <code>%s</code> is the special pythonic token used to convert a specified value to a string using the <code>Str()</code> function.
<p></p>
The <code>%s</code> can be used in either of two ways.
<p></p>
When wanting only one or a few columns from the view referenced by a particular placeholder, each such column can be represented by a <code>field</code> around which <code>%s</code> needs to be applied, for example
<p></p>
<pre>   &#37;(laterality)s
   &#37;(is&#95;active)s</pre>
<p></p>
When unqualified, meaning when it is not being applied to one or more fields, %s will return the content of what <code>str(the_class_in_question)</code> returns.
<p></p>
Placeholders no longer require an <code><escape style></code> to be specified, because the <a href="LaTeX.html">LaTeX</a> engine now tells the placeholder handler to use a suitable escape function to escape the data being returned, as should any other future-use engines within GNUmed.
<p></p>
At the point where target document description languages (other than <a href="LaTeX.html">LaTeX</a>) are supported, certain placeholders may require a <code>format</code> to be specified.
<p></p>
<p></p>
<h2><a name="Placeholder_particulars"></a>  Placeholder particulars </h2>
<p></p>
The following table gives the particulars of most placeholders.
<p></p>
TBA
<p></p>
<h2><a name="Placeholder_examples"></a>  Placeholder examples </h2>
<p></p>
The following table provides a formatted example for most placeholders.
<p></p>
TBA
<p></p>
<a name="TopicEnd"></a>
<p></p>
<p></p>
<p></p>
<p></p>
</div>
</body></html>

APT Browse - Built by Thomas Orozco.