Differences

This shows you the differences between two versions of the page.

--- macros:example:shutdown [2018/03/23 12:21] – created icke_siegen
+++ macros:example:shutdown [2019/04/27 16:54] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 Example
-====== Shutdown ======
+====== System - Shutdown ======
-^ by: | marc Heimendinger |
+^ by: | Marc Heimendinger |
 ^ published: | March 2018 |
 ^ description: | Shuts Titan down. |
 ^ remarks: | This affects only the Titan 'surface' program which is shut down without prompt. The Titan Server is not affected and keeps running. |
-{{tag>[ Shutdown ]}}
+{{tag>Shutdown}}
 ==== functions ====
-  * [[:macros:function:someusedfunction]]
+  * [[:macros:function:Titan.Shutdown]]
-  * [[:macros:function:anotherusedfunction]]
-==== affected properties ====
-  * [[:macros:property:someproperty]]
-  * [[:macros:property:anotherusedproperty]]
-==== control structures ====
-  * anyspecials?
 ===== Code =====
-<code xml filename.xml>
+<code xml shutdown.xml>
 <?xml version="1.0" encoding="utf-8"?>
 <avolites.macros xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="Avolites.Menus.xsd">
- <macro name="" id="">
+  <!-- Shuts down the console (without prompt !). Marc Heimendinger 11/03/2018 -->
-    <description></description>
+  <macro id="Avolites.Macros.ShutDown" name="Shutdown">
+    <description>Shuts down the console (without prompt !).</description>
     <sequence>
-      <step></step>
+      <step pause="0.01">Titan.Shutdown()</step>
-     </sequence>
+    </sequence>
   </macro>
 </avolites.macros>
@@ Line 39: / Line 33: @@
 This explains the functional steps within the sequence. For all the other XML details please refer to [[:macros:formats_and_syntax#xml_format|Formats and syntax]]
-tbd
+This simply applies the function Titan.Shutdown() whci immediately - and without prompt - shuts Titan down. however, only the 'Surface' program is affected (e.g. TitanOne, Titan Simulator etc) - Titan Server is not affected and keeps running in the background.
 ===== How to use it =====
-  - [[:macros:deploying|make this macro available]]
+  * [[:macros:deploying|make this macro available]]
+  * Fire this macro to immediately shut Titan down.
-tbd
 ~~DISCUSSION~~