From 5f3c06c05e885b29f6ac3a8bdcd1393ba0be0ce4 Mon Sep 17 00:00:00 2001
From: ulimaass <ulimaass@2b470e98-0d58-463d-a4d8-8e2adae1ed80>
Date: Fri, 16 Mar 2012 23:38:25 +0000
Subject: [PATCH] commandref-entry for floorplan

git-svn-id: svn://svn.code.sf.net/p/fhem/code/trunk@1355 2b470e98-0d58-463d-a4d8-8e2adae1ed80
---
 .../95_FLOORPLAN/commandref - floorplan.html  | 130 ++++++++++++++++++
 1 file changed, 130 insertions(+)
 create mode 100644 fhem/contrib/95_FLOORPLAN/commandref - floorplan.html

diff --git a/fhem/contrib/95_FLOORPLAN/commandref - floorplan.html b/fhem/contrib/95_FLOORPLAN/commandref - floorplan.html
new file mode 100644
index 000000000..269affe76
--- /dev/null
+++ b/fhem/contrib/95_FLOORPLAN/commandref - floorplan.html	
@@ -0,0 +1,130 @@
+
+
+<a name="FLOORPLAN"></a>
+<h3>FLOORPLAN</h3>
+<ul>
+  Implements an additional enry to your fhem menu, leading to a userinterface without fhem-menu, rooms or devicelists. 
+  Devices can be displayed at a defined coordinate on the screen, usually with a clickable icon allowing to switch 
+  the device on or off by clicking on it. A picture can be used background - use e.g. a floorplan of your house, or any picture.
+  Use floorplanstyle.css to adapt the representation.<br>
+  FLOORPLAN is not part of the fhem standard delivery. Download it from 
+  <a href="http://fhem.svn.sourceforge.net/viewvc/fhem/trunk/fhem/contrib/95_FLOORPLAN/?sortby=file">this SVN folder</a>, 
+  where you also find pdf-files (english and german) with a step-by-step guide for setup. <br>
+  <br>
+
+  <a name="FLOORPLANdefine"></a>
+  <b>Define</b>
+  <ul>
+    <code>define &lt;name&gt; FLOORPLAN </code>
+    <br><br>
+
+    <b>Hint:</b> Store fp_&lt;name&gt;.png in your modpath folder (FHEM) to use it as background picture.<br><br>
+    Example:
+    <ul>
+      <code>
+	  define Groundfloor FLOORPLAN<br>
+	  fp_Groundfloor.png
+	  </code><br>
+    </ul>  
+  </ul>
+  <br>
+
+  <a name="FLOORPLANset"></a>
+  <b>Set </b>
+  <ul>
+      <li>N/A</li>
+  </ul>
+  <br>
+
+  <a name="FLOORPLANget"></a>
+  <b>Get </b>
+  <ul>
+      <li>N/A</li>
+  </ul>
+  <br>
+
+  <a name="FLOORPLANattr"></a>
+  <b>Attributes</b>
+  <ul>
+    <li><a name="fp_fpname">userattr fp_&lt;name&gt; &lt;top&gt;,&lt;left&gt;[,&lt;style&gt;[,&lt;description&gt;]]</a><br><br>
+    A <a href="#userattr">userattr</a> fp_&lt;name&gt; will be created automatically if it does not exist yet.<br>
+	<ul>
+      <li>top   = screen-position, pixels from top of screen
+      <li>left  = screen-position, pixels from left of screen
+      <li>style = 
+		<ul>
+			<li>0  icon/state only
+			<li>1  devicename and icon/state
+			<li>2  devicename, icon/state and commands
+			<li>3  device-reading and optional description
+			<li>4  S300TH-specific, displays temperature above humidity
+		</ul>
+      <li>description will be displayed instead of the original devicename
+    </ul><br>
+    Examples:<br>
+    <ul>
+	  <pre>
+ attr lamp1 fp_Groundfloor 100,100                   #display lamp1 with icon only at screenposition 100,100
+ attr lamp2 fp_Groundfloor 100,140,1,Art-Deco        #display lamp2 with description 'Art-Deco-Light' at 100,140
+ attr lamp3 fp_FirstFloor  130,100,1                 #if you define other floorplans, you can display the same device at different positions
+ attr myFHT fp_Groundfloor 300,20,10,Temperature     #display given Text + FHT-temperature
+	  </pre>
+	</ul>
+	<b>Hint:</b> no blanks between parameters<br><br>
+	
+    <li><a name="fp_arrange">fp_arrange</a><br>
+  	  Activates the "arrange mode" which shows an additional menu on the screen, 
+	  allowing to place devices easily on the screen.<br>
+	  Example:
+	<ul>
+      <code>attr Groundfloor fp_arrange 1</code><br><br>
+    </ul>
+	</li>
+	<li><a name="fp_stylesheetPrefix">fp_stylesheetPrefix</a><br>
+	Allows the usage of a separate stylesheet like <a href="#stylesheetPrefix">stylesheetPrefix</a>.<br>
+	The prefix is prepended the standard stylesheet floorplanstyle.css .<br>
+		  Example:
+	<ul>
+      <code>attr Groundfloor fp_stylesheetPrefix dark       # use darkfloorplanstyle.css</code><br><br>
+    </ul>
+	</li>
+
+	<li><a name="fp_default">fp_default</a><br>
+	The floorplan startscreen is skipped if this attribute is assigned to one of the floorplans in your installation.
+	</li>
+    Example:
+	<ul>
+      <code>attr Groundfloor fp_default 1</code><br><br>
+    </ul>
+
+	<li><a name="fp_noMenu">fp_noMenu</a><br>
+	Suppresses the menu which usually shows the links to all your floorplans.
+	</li>
+    Example:
+	<ul>
+      <code>attr Groundfloor fp_noMenu 1</code><br><br>
+    </ul>
+	
+    <li><a name="commandfield">commandfield</a><br>
+	Adds a fhem-commandfield to the floorplan screen.
+	</li>
+    Example:
+	<ul>
+      <code>attr Groundfloor commandfield 1</code><br><br>
+    </ul>
+
+    <li><a name="fp_inherited">Inherited from FHEMWEB</a><br>	
+	The following attributes are inherited from the underlying <a href="#FHEMWEB">FHEMWEB</a> instance:<br>
+    <ul>
+		<a href="#smallscreen">smallscreen</a><br>
+		<a href="#touchpad">touchpad</a><br>
+		<a href="#refresh">refresh</a><br>
+		<a href="#plotmode">plotmode</a><br>	
+		<a href="#plotsize">plotsize</a><br>
+		<a href="#webname">webname</a><br>	
+    </ul>
+    </li><br>
+  </ul>
+  <br>
+</ul>
+