You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@vcl.apache.org by bu...@apache.org on 2016/02/26 20:11:12 UTC

svn commit: r981240 - in /websites/staging/vcl/trunk/content: ./ docs/message_substitutions.html

Author: buildbot
Date: Fri Feb 26 19:11:12 2016
New Revision: 981240

Log:
Staging update by buildbot for vcl

Added:
    websites/staging/vcl/trunk/content/docs/message_substitutions.html
Modified:
    websites/staging/vcl/trunk/content/   (props changed)

Propchange: websites/staging/vcl/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri Feb 26 19:11:12 2016
@@ -1 +1 @@
-1693284
+1732544

Added: websites/staging/vcl/trunk/content/docs/message_substitutions.html
==============================================================================
--- websites/staging/vcl/trunk/content/docs/message_substitutions.html (added)
+++ websites/staging/vcl/trunk/content/docs/message_substitutions.html Fri Feb 26 19:11:12 2016
@@ -0,0 +1,167 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+    Licensed to the Apache Software Foundation (ASF) under one or more
+    contributor license agreements.  See the NOTICE file distributed with
+    this work for additional information regarding copyright ownership.
+    The ASF licenses this file to You under the Apache License, Version 2.0
+    (the "License"); you may not use this file except in compliance with
+    the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE- 2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+-->
+
+  <link href="/css/vcl.css" rel="stylesheet" type="text/css">
+  <link href="/css/code.css" rel="stylesheet" type="text/css">
+  <title>Apache VCL - Site Configuration Message Substitutions</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+</head>
+
+<body>
+  <div id="sitetitle">
+    <table width="100%" border="0" cellspacing="0" cellpadding="5">
+      <tr>
+         <td><a href="/index.html"><img src="/img/vcl-logo.png" height="100" align="left" alt="Apache VCL logo"></a></td>
+         <td><a href="http://www.apache.org"><img src="/img/asf-logo.png" align="right" alt="Apache Software Foundation logo"></a></td>
+      </tr>
+    </table>
+  </div>
+
+  <div id="navigation"> 
+  <style type="text/css">
+/* The following code is added by mdx_elementid.py
+   It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+  visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<ul>
+<li><a href="/index.html">Information</a><ul>
+<li><a href="/info/features.html">Features</a></li>
+<li><a href="/info/architecture.html">Architecture</a></li>
+<li><a href="/downloads/download.cgi">Download</a></li>
+<li><a href="/info/license.html">License</a></li>
+</ul>
+</li>
+<li><a href="/docs/index.html">Documentation</a><ul>
+<li><a href="https://cwiki.apache.org/confluence/x/yQdG">Using VCL</a></li>
+<li><a href="https://cwiki.apache.org/confluence/x/ywdG">Administration</a></li>
+<li><a href="/docs/installation.html">Installation</a></li>
+</ul>
+</li>
+<li><a href="/comm/index.html">Community</a><ul>
+<li><a href="/comm/index.html#getInvolved">Getting Involved</a></li>
+<li><a href="/comm/index.html#mail-list">Mailing Lists</a></li>
+<li><a href="/comm/wiki.html">Wiki</a></li>
+<li><a href="/dev/index.html">Development</a><ul>
+<li><a href="/dev/jira.html">Issue Tracking</a></li>
+<li><a href="/dev/code-documentation.html">Code Documentation</a></li>
+<li><a href="/dev/roadmap.html">Roadmap</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li><a href="http://www.apache.org">Apache Software Foundation</a><ul>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+</ul>
+</li>
+</ul>
+  </div>
+  
+  <div id="content">
+    <h1 class="title">Site Configuration Message Substitutions</h1>
+    <style type="text/css">
+/* The following code is added by mdx_elementid.py
+   It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+  visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="message-substitutions">Message Substitutions<a class="headerlink" href="#message-substitutions" title="Permanent link">&para;</a></h1>
+<p>Messages sent to users and admins can be configured via the VCL web 
+site under Site Configuration as of version 2.5. There are many 
+variables that can be substituted into the messages by the backend 
+before a message is sent to a user. Variables are included in 
+square brackets ( [ ] ). For example:</p>
+<div class="codehilite"><pre><span class="n">Your</span> <span class="n">reservation</span> <span class="k">for</span> <span class="p">[</span><span class="n">image_name</span><span class="p">]</span> <span class="n">is</span> <span class="n">now</span> <span class="n">available</span><span class="p">.</span>
+</pre></div>
+
+
+<p>The list of variables that can be substituted is quite large. So, 
+listing all of them out results in a list that can easily become 
+difficult to maintain and quickly out of date. The best place to 
+look for a list of variables that could be used is in the 
+<a href="http://svn.apache.org/viewvc/vcl/trunk/managementnode/lib/VCL/DataStructure.pm?view=markup">Datastructure.pm</a> module of the backend code in the 
+$SUBROUTINE_MAPPINGS hash (though, not all of those make sense in 
+some of the messages and may not be available).</p>
+<p>After saving a message, the backend will analyze it for any invalid
+variables. If any are found, a notice will be displayed about which
+messages have invalid variables, and which variables are invalid.</p>
+<p>As of VCL 2.5, here is the list of variables included in the default
+set of messages:</p>
+<pre>
+[IMAGE_CAPTURE_TYPE]
+[IMAGE_SIZE_OLD]
+[NOTICE_INTERVAL]
+[PID]
+[computer_id]
+[computer_provisioning_module_perl_package]
+[computer_provisioning_name]
+[computer_provisioning_pretty_name]
+[computer_short_name]
+[image_id]
+[image_name]
+[image_os_module_perl_package]
+[image_prettyname]
+[image_size]
+[imagemeta_sysprep]
+[imagerevision_id]
+[imagerevision_revision]
+[management_node_short_name]
+[request_id]
+[reservation_id]
+[user_affiliation_helpaddress]
+[user_affiliation_name]
+[user_affiliation_sitewwwaddress]
+[user_firstname]
+[user_id]
+[user_lastname]
+[user_login_id]
+[vmhost_computer_id]
+[vmhost_id]
+[vmhost_profile_id]
+[vmhost_profile_name]
+[vmhost_short_name]
+</pre>
+  </div>
+  
+  <div id="footer">
+    <div class="copyright">
+      <p>
+        Copyright &copy; 2012 The Apache Software Foundation, Licensed under 
+        the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+        <br />
+        Apache and the Apache feather logo are trademarks of The Apache Software Foundation.
+      </p>
+    </div>
+  </div>
+  
+</body>
+</html>