98_weekprofile: using id's in module documentation

git-svn-id: https://svn.fhem.de/fhem/trunk@24963 2b470e98-0d58-463d-a4d8-8e2adae1ed80

fhem/CHANGED

@@ -1,5 +1,6 @@
 # Add changes at the top of the list. Keep it in ASCII, and 80-char wide.
 # Do not insert empty lines here, update check depends on it.
+ - change:  98_weekprofile: using id's in module documentation
  - change:  93_RFHEM: Deprecation message (use FHEM2FHEM), some fixes
  - change:  93_DbRep: SQL code for SQLite, Forum:#122791
  - bugfix:  70_ZoneMinder: Trigger-Port state fixed

fhem/FHEM/98_weekprofile.pm

@@ -1752,14 +1752,17 @@ sub weekprofile_getEditLNK_MasterDev($$)
 }
 1;
 
+__END__
+
 =pod
+=encoding utf8
 =item summary    administration of weekprofiles
 =item summary_DE Verwaltung von Wochenprofilen
 
 =item helper
 =begin html
 
-<a name="weekprofile"></a>
+<a id="weekprofile"></a>
 <h3>weekprofile</h3>
 <ul>
   With this module you can manage and edit different weekprofiles. You can send the profiles to different devices.<br>
@@ -1800,13 +1803,14 @@ sub weekprofile_getEditLNK_MasterDev($$)
   <br>
   If the maste device is Homatic HM-TC-IT-WM-W-EU then only the first profile (R_P1_...) will be used!
   <br>
-  <b>For this module libjson-perl have to be installed</b>
+  <b>For this module <i>libjson-perl</i> have to be installed</b>
   <br><br>
+  <a id="weekprofile-events"></a>
   <b>Events:</b><br>
   Currently the following event will be created:<br>
   <li>PROFILE_TRANSFERED: if a profile or a part of a profile (changes) is send to a device</li>
   <li>PROFILES_SAVED: the profile are stored in the config file (also if there are no changes)</li>
-  <a name="weekprofiledefine"></a>
+  <a id="weekprofile-define"></a>
   <b>Define</b>
   <ul>
     <code>define &lt;name&gt; weekprofile [master device]</code><br>
@@ -1821,66 +1825,79 @@ sub weekprofile_getEditLNK_MasterDev($$)
     Without a master device a 'default' profile will be created
   </ul>
   
-  <a name="weekprofileset"></a>
+  <a id="weekprofile-set"></a>
   <b>Set</b>
   <ul>
+    <a id="weekprofile-set-profile_data"></a>
     <li>profile_data<br>
        <code>set &lt;name&gt; profile_data &lt;profilename&gt; &lt;json data&gt; </code><br>
        The profile 'profilename' will be changed. The data have to be in json format.
     </li>
+    <a id="weekprofile-set-send_to_device"></a>
     <li>send_to_device<br>
       <code>set &lt;name&gt; send_to_device &lt;profilename&gt; [devices] </code><br>
       The profile 'profilename' will be transfered to one or more the devices. Without the parameter device the profile 
       will be transferd to the master device. 'devices' is a comma seperated list of device names
     </li>
+    <a id="weekprofile-set-copy_profile"></a>
     <li>copy_profile<br>
       <code>set &lt;name&gt; copy_profile &lt;source&gt; &lt;destination&gt; </code><br>
       Copy from source to destination. The destination will be overwritten
     </li>
+    <a id="weekprofile-set-remove_profile"></a>
     <li>remove_profile<br>
       <code>set &lt;name&gt; remove_profile &lt;profilename&gt; </code><br>
       Delete profile 'profilename'.
     </li>
+    <a id="weekprofile-set-reference_profile"></a>
     <li>reference_profile<br>
       <code>set &lt;name&gt; reference_profile &lt;source&gt; &lt;destination&gt; </code><br>
       Create a reference from destination to source. The destination will be overwritten if it exits.
     </li>
+    <a id="weekprofile-set-restore_topic"></a>
     <li>restore_topic<br>
       <code>set &lt;name&gt; restore_topic &lt;topic&gt;</code><br>
       All weekprofiles from the topic will be transfered to the correcponding devices.
       Therefore a user attribute 'weekprofile' with the weekprofile name <b>without the topic name</b> have to exist in the device.
     </li>
+    <a id="weekprofile-set-reread_master"></a>
     <li>reread_master<br>
-		Refresh (reread) the master profile from the master device.
+      Refresh (reread) the master profile from the master device.
     </li>
+    <a id="weekprofile-set-import_profile"></a>
     <li>import_profile<br>
     <code>set &lt;name&gt; import_profile &lt;device&gt; &lt;[profilename]&gt;</code><br>
-		Importing a profile from a supported device 
+        Importing a profile from a supported device 
     </li>
   </ul>
   
-  <a name="weekprofileget"></a>
+  <a id="weekprofile-get"></a>
   <b>Get</b>
   <ul>
+    <a id="weekprofile-get-profile_data"></a>
     <li>profile_data<br>
        <code>get &lt;name&gt; profile_data &lt;profilename&gt; </code><br>
        Get the profile data from 'profilename' in json-Format
     </li>
+    <a id="weekprofile-get-profile_names"></a>
     <li>profile_names<br>
       <code>set &lt;name&gt; profile_names [topicname]</code><br>
       Get a comma seperated list of weekprofile profile names from the topic 'topicname'
       If topicname is not set, 'default' will be used
       If topicname is '*', all weekprofile profile names are returned.
     </li>
+    <a id="weekprofile-get-profile_references"></a>
     <li>profile_references [name]<br>
       If name is '*', a comma seperated list of all references in the following syntax
       <code>ref_topic:ref_profile>dest_topic:dest_profile</code>
       are returned
       If name is 'topicname:profilename', '0' or the reference name is returned.
     </li>
+    <a id="weekprofile-get-topic_names"></a>
     <li>topic_names<br>
      Return a comma seperated list of topic names.
     </li>
+    <a id="weekprofile-get-associations"></a>
     <li>associations [ReturnType (0|1)]<br>
     Returns a list of supported devices with the associated profile.<br>
     ReturnType 0: HTML table</br>
@@ -1888,7 +1905,7 @@ sub weekprofile_getEditLNK_MasterDev($$)
     </li>
   </ul>
   
-  <a name="weekprofilereadings"></a>
+  <a id="weekprofile-readings"></a>
   <p><b>Readings</b></p>
   <ul>
     <li>active_topic<br>
@@ -1902,66 +1919,84 @@ sub weekprofile_getEditLNK_MasterDev($$)
     </li>
   </ul>
   
-  <a name="weekprofileattr"></a>
+  <a id="weekprofile-attr"></a>
   <b>Attributes</b>
   <ul>
+    <a id="weekprofile-attr-widgetTranslations"></a>
     <li>widgetTranslations<br>
     Comma seperated list of texts translations <german>:<translation>
     <code>attr name widgetTranslations Abbrechen:Cancel,Speichern:Save</code> 
     </li>
+    <a id="weekprofile-attr-widgetWeekdays"></a>
     <li>widgetWeekdays<br>
       Comma seperated list of week days starting at Monday
       <code>attr name widgetWeekdays Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday</code>
     </li>
+    <a id="weekprofile-attr-widgetEditOnNewPage"></a>
     <li>widgetEditOnNewPage<br>
       Editing the profile on a new html page if it is set to '1'
     </li>
+    <a id="weekprofile-attr-widgetEditDaysInRow"></a>
     <li>widgetEditDaysInRow<br>
     Count of visible days in on row during Edit. Default 2.<br>
     </li>
+    <a id="weekprofile-attr-widgetTempRange"></a>
     <li>widgetTempRange<br>
     Set the temperature range of the dropdown list in the FHEM widget
     Syntax: min:max:step e.g. 5:30:0.5
     </li>
+    <a id="weekprofile-attr-tempMap"></a>
     <li>tempMap<br>
     Temperature key value pair
-    Syntax: <key_1>:<value 1>,<key_2>:<value 2><br>
+    Syntax: <key_1>:<value 1>,<key_2>:<value 2> e.g. off:5.0,on:30.0
-    e.g. off:5.0,on:30.0
     </li>
+    <a id="weekprofile-attr-tempON"></a>
+    <li>tempON<br>
+    deprecated - please use tempMap
+    </li>
+    <a id="weekprofile-attr-tempOFF"></a>
+    <li>tempOFF<br>
+    deprecated - please use tempMap
+    </li>
+    <a id="weekprofile-attr-sendKeywordsToDevices"></a>
     <li>sendKeywordsToDevices<br>
     Send temperatur keywords instead of temparture values to device
     Default: 0
     </li>
+    <a id="weekprofile-attr-configFile"></a>
     <li>configFile<br>
       Path and filename of the configuration file where the profiles will be stored
       Default: ./log/weekprofile-<name>.cfg
     </li>
+    <a id="weekprofile-attr-icon"></a>
     <li>icon<br>
       icon for edit<br>
       Default: edit_settings
     </li>
+    <a id="weekprofile-attr-useTopics"></a>
     <li>useTopics<br>
       Enable topics.<br>
       Default: 0
     </li>
+    <a id="weekprofile-attr-sendDelay"></a>
     <li>sendDelay<br>
     Default: 0
     Delay in seconds between sending profile data the same type of device.
     This is usefull to avoid messages like "queue is full, dropping packet" by HM devices
     </li>
+    <a id="weekprofile-attr-forceCompleteProfile"></a>
     <li>forceCompleteProfile<br>
     Default: 0
     Force to send the complete profile to the device instead of only the changes.
     Possibility to resend a complete week profile
     </li>
   </ul>
-  
 </ul>
 =end html
 
 =begin html_DE
 
-<a name="weekprofile"></a>
+<a id="weekprofile"></a>
 <h3>weekprofile</h3>
 <ul>
   Beschreibung im Wiki: http://www.fhemwiki.de/wiki/Weekprofile<br><br> 
@@ -2003,13 +2038,14 @@ sub weekprofile_getEditLNK_MasterDev($$)
   <br>
   Beim Homatic HM-TC-IT-WM-W-EU wird nur das 1. Profil (R_P1_...) genommen!
   <br>
-  <b>Für das Module wird libjson-perl benötigt</b>
+  <b>Für das Modul wird <i>libjson-perl</i> benötigt</b>
   <br><br>
+  <a id="weekprofile-events"></a>
   <b>Events:</b><br>
   Aktuell werden folgende Events erzeugt:<br>
   <li>PROFILE_TRANSFERED: wenn ein Profil oder Teile davon zu einem Gerät gesended wurden</li>
   <li>PROFILES_SAVED: wenn Profile in die Konfigurationsdatei gespeichert wurden (auch wenn es keine Änderung gab!)</li>
-  <a name="weekprofiledefine"></a>
+  <a id="weekprofile-define"></a>
   <b>Define</b>
   <ul>
     <code>define &lt;name&gt; weekprofile [master device]</code><br>
@@ -2024,56 +2060,67 @@ sub weekprofile_getEditLNK_MasterDev($$)
     Wird kein 'Master-Geräte' angegeben, wird ein 'default' Profil angelegt.
   </ul>
   
-  <a name="weekprofileset"></a>
+  <a id="weekprofile-set"></a>
   <b>Set</b>
   <ul>
+    <a id="weekprofile-set-profile_data"></a>
     <li>profile_data<br>
        <code>set &lt;name&gt; profile_data &lt;profilname&gt; &lt;json data&gt; </code><br>
        Es wird das Profil 'profilname' geändert. Die Profildaten müssen im json-Format übergeben werden.
     </li>
+    <a id="weekprofile-set-send_to_device"></a>
     <li>send_to_device<br>
       <code>set &lt;name&gt; send_to_device &lt;profilname&gt; [devices] </code><br>
       Das Profil wird an ein oder mehrere Geräte übertragen. Wird kein Gerät angegeben, wird das 'Master-Gerät' verwendet.
       'Devices' ist eine kommagetrennte Auflistung von Geräten
     </li>
+    <a id="weekprofile-set-copy_profile"></a>
     <li>copy_profile<br>
       <code>set &lt;name&gt; copy_profile &lt;quelle&gt; &lt;ziel&gt; </code><br>
       Kopiert das Profil 'quelle' auf 'ziel'. 'ziel' wird überschrieben oder neu angelegt.
     </li>
+    <a id="weekprofile-set-remove_profile"></a>
     <li>remove_profile<br>
       <code>set &lt;name&gt; remove_profile &lt;profilname&gt; </code><br>
       Das Profil 'profilname' wird gelöscht.
     </li>
+    <a id="weekprofile-set-reference_profile"></a>
     <li>reference_profile<br>
       <code>set &lt;name&gt; reference_profile &lt;quelle&gt; &lt;ziel&gt; </code><br>
       Referenziert das Profil 'ziel'auf 'quelle'. 'ziel' wird überschrieben oder neu angelegt.
     </li>
+    <a id="weekprofile-set-restore_topic"></a>
     <li>restore_topic<br>
       <code>set &lt;name&gt; restore_topic &lt;topic&gt;</code><br>
       Alle Wochenpläne in der Topic werden zu den entsprechenden Geräten übertragen.
       Dazu muss im Gerät ein Userattribut 'weekprofile' mit dem Namen des Wochenplans <b>ohne</b> Topic gesetzt sein.
     </li>
+    <a id="weekprofile-set-reread_master"></a>
     <li>reread_master<br>
     Aktualisiert das master profile indem das 'Master-Geräte' neu ausgelesen wird.
     </li>
+    <a id="weekprofile-set-import_profile"></a>
     <li>import_profile<br>
     <code>set &lt;name&gt; import_profile &lt;device&gt; &lt;[profilename]&gt;</code><br>
     Profil von einem Gerät importieren. 
     </li>
   </ul>
   
-  <a name="weekprofileget"></a>
+  <a id="weekprofile-get"></a>
   <b>Get</b>
   <ul>
+    <a id="weekprofile-get-profile_data"></a>
     <li>profile_data<br>
        <code>get &lt;name&gt; profile_data &lt;profilname&gt; </code><br>
        Liefert die Profildaten von 'profilname' im json-Format
     </li>
+    <a id="weekprofile-get-profile_names"></a>
     <li>profile_names<br>
       <code>set &lt;name&gt; profile_names [topic_name]</code><br>
       Liefert alle Profilnamen getrennt durch ',' einer Topic 'topic_name'
       Ist 'topic_name' gleich '*' werden alle Profilnamen zurück gegeben.
     </li>
+    <a id="weekprofile-get-profile_references"></a>
     <li>profile_references [name]<br>
       Liefert eine Liste von Referenzen der Form <br>
       <code>
@@ -2081,6 +2128,7 @@ sub weekprofile_getEditLNK_MasterDev($$)
       </code>
       Ist name 'topicname:profilename' wird  '0' der Name der Referenz zurück gegeben.
     </li>
+    <a id="weekprofile-get-associations"></a>
     <li>associations [Rückgabetyp (0|1)]<br>
       Gibt eine Liste der unterstützten Geräte mit dem verbundenen\zugeordnetem Profilnamen zurück.<br>
       Rückgabetyp 0: HTML Tabelle</br>
@@ -2088,7 +2136,7 @@ sub weekprofile_getEditLNK_MasterDev($$)
     </li>
   </ul>
   
-  <a name="weekprofilereadings"></a>
+  <a id="weekprofile-readings"></a>
   <p><b>Readings</b></p>
   <ul>
     <li>active_topic<br>
@@ -2102,60 +2150,79 @@ sub weekprofile_getEditLNK_MasterDev($$)
     </li>
   </ul>
   
-  <a name="weekprofileattr"></a>
+  <a id="weekprofile-attr"></a>
   <b>Attribute</b>
   <ul>
+    <a id="weekprofile-attr-widgetTranslations"></a>
     <li>widgetTranslations<br>
-    Liste von Übersetzungen der Form <german>:<Übersetzung> getrennt durch ',' um Texte im Widget zu übersetzen.
+    Liste von Übersetzungen der Form <german>:<Übersetzung> getrennt durch ',' um Texte im Widget zu Übersetzen.
     <code>attr name widgetTranslations Abbrechen:Abbr,Speichern:Save</code> 
     </li>
+    <a id="weekprofile-attr-widgetWeekdays"></a>
     <li>widgetWeekdays<br>
       Liste von Wochentagen getrennt durch ',' welche im Widget angzeigt werden. 
       Beginnend bei Montag. z.B.
       <code>attr name widgetWeekdays Montag,Dienstag,Mittwoch,Donnerstag,Freitag,Samstag,Sonntag</code>
     </li>
+    <a id="weekprofile-attr-widgetEditDaysInRow"></a>
     <li>widgetEditDaysInRow<br>
     Anzahl in der in einer Reihe dargestellten Tage während der Bearbeitung. Default 2.<br>
     </li>
+    <a id="weekprofile-attr-widgetEditOnNewPage"></a>
     <li>widgetEditOnNewPage<br>
       Wenn gesetzt ('1'), dann wird die Bearbeitung auf einer separaten\neuen Webseite gestartet.
     </li>
+    <a id="weekprofile-attr-widgetTempRange"></a>
     <li>widgetTempRange<br>
     Bereich der Temperatur Dropdown-Box im FHEM widget
     Syntax: min:max:step z.B. 5:30:0.5
     </li>
+    <a id="weekprofile-attr-tempMap"></a>
     <li>tempMap<br>
     Temperatur Schlüssel-Werte-Paare
     Syntax: <schlüsselwort_1>:<wert_1>,<schlüsselwort_2>:<wert_2><br>
     z.B. off:5.0,on:30.0
     </li>
+    <a id="weekprofile-attr-tempOn"></a>
+    <li>tempOn<br>
+    Veraltet - bitte tempMap benutzen
+    </li>
+    <a id="weekprofile-attr-tempOff"></a>
+    <li>tempOff<br>
+    Veraltet - bitte tempMap benutzen
+    </li>
+    <a id="weekprofile-attr-sendKeywordsToDevices"></a>
     <li>sendKeywordsToDevices<br>
     Sende Temperatur-Schlüsselwort zum Gerät anstatt der Werte
     Default: 0
     </li>
+    <a id="weekprofile-attr-configFile"></a>
     <li>configFile<br>
       Pfad und Dateiname wo die Profile gespeichert werden sollen.
       Default: ./log/weekprofile-<name>.cfg
     </li>
+    <a id="weekprofile-attr-icon"></a>
     <li>icon<br>
       Änders des Icons zum Bearbeiten
       Default: edit_settings
     </li>
+    <a id="weekprofile-attr-useTopics"></a>
     <li>useTopics<br>
       Verwendung von Topic aktivieren.
     </li>
+    <a id="weekprofile-attr-sendDelay"></a>
     <li>sendDelay<br>
     Default: 0
     Verzögerungszweit in Sekunden zwischen dem Senden von Profildaten an ein Thermostat gleichen Typs.
     Hilfreich zur Vermeidung von Meldungen wie "queue is full, dropping packet".
     </li>
+    <a id="weekprofile-attr-forceCompleteProfile"></a>
     <li>forceCompleteProfile<br>
     Default: 0
     Ezwingt das Senden eines komplettes Wochenprofiles anstatt der Änderungen
     Es besteht somit die Möglichkeit eines erneuten Senden der Daten an das Thermostats
     </li>
   </ul>
-  
 </ul>
 =end html_DE