lib-songbeamer
Version:
transforming SongBeamer Song-Files and Ablaufplan-Files
1,219 lines (315 loc) • 12.7 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Module: ablauf</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Module: ablauf</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="description">Gets Json from and json to Ablaufplan-files</div>
<dl class="details">
<dt class="tag-version">Version:</dt>
<dd class="tag-version"><ul class="dummy"><li>1.0</li></ul></dd>
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul>
<li>Dominik Sigmund</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="libs_ablauf.js.html">libs/ablauf.js</a>, <a href="libs_ablauf.js.html#line1">line 1</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="~regex"><span class="type-signature">(inner, constant) </span>regex<span class="type-signature"></span></h4>
<div class="description">
Get Json from a string
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="libs_ablauf.js.html">libs/ablauf.js</a>, <a href="libs_ablauf.js.html#line14">line 14</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".toFile"><span class="type-signature">(static) </span>toFile<span class="signature">(json, callback)</span><span class="type-signature"></span></h4>
<div class="description">
Write Json to a File String
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>json</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">String as delivered by fs.readFile</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="ablauf.html#~stringCallback">ablauf~stringCallback</a></span>
</td>
<td class="description last">A Callback with an error or the String as delivered to fs.writeFile</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="libs_ablauf.js.html">libs/ablauf.js</a>, <a href="libs_ablauf.js.html#line50">line 50</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Nothing
</div>
<h4 class="name" id="~clean"><span class="type-signature">(inner) </span>clean<span class="signature">(text)</span><span class="type-signature"> → {String}</span></h4>
<div class="description">
Removes Strange Symbols from the Text for a better json
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>text</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">A Bite of Text</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="libs_ablauf.js.html">libs/ablauf.js</a>, <a href="libs_ablauf.js.html#line73">line 73</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
- A cleaner bit of Text
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">String</span>
</dd>
</dl>
<h4 class="name" id="~color2Hex"><span class="type-signature">(inner) </span>color2Hex<span class="signature">(color)</span><span class="type-signature"> → {string}</span></h4>
<div class="description">
Takes Color Information and returns a css-hex-representation
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>color</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Some weird color (string, windows decimal, ...)</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="libs_ablauf.js.html">libs/ablauf.js</a>, <a href="libs_ablauf.js.html#line85">line 85</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
- A clean hex-rep
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="~colourNameToHex"><span class="type-signature">(inner) </span>colourNameToHex<span class="signature">(colour)</span><span class="type-signature"> → {string}</span></h4>
<div class="description">
Takes a cssColor-Name and returns the hex-value or an empty string
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>colour</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">A ColourName</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="libs_ablauf.js.html">libs/ablauf.js</a>, <a href="libs_ablauf.js.html#line161">line 161</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
- A Hex-Color or an empty String
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="~getType"><span class="type-signature">(inner) </span>getType<span class="signature">(caption, filename)</span><span class="type-signature"> → {string}</span></h4>
<div class="description">
Guesses the Type of the Item
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>caption</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The Caption of the item</td>
</tr>
<tr>
<td class="name"><code>filename</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The Filename of the item</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="libs_ablauf.js.html">libs/ablauf.js</a>, <a href="libs_ablauf.js.html#line137">line 137</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
- Type, may be: song, video, powerpoint, sermon, unknown
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="~hex2Color"><span class="type-signature">(inner) </span>hex2Color<span class="signature">(hex)</span><span class="type-signature"> → {string}</span></h4>
<div class="description">
Takes a Hex-Color and makes a windows-decimal-color out of it.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>hex</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">A Hex Color</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="libs_ablauf.js.html">libs/ablauf.js</a>, <a href="libs_ablauf.js.html#line121">line 121</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
- Windows Decimal Color
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-ablauf.html">ablauf</a></li><li><a href="module-index.html">index</a></li><li><a href="module-song.html">song</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jan 04 2018 16:30:08 GMT+0100 (Mitteleuropäische Zeit)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>