User Tools

Site Tools

Trace:
wiki:syntax

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
wiki:syntax [2016/11/30 09:34] – saso_santeljwiki:syntax [2024/02/12 15:52] (current) – external edit 127.0.0.1
Line 1: Line 1:
-~~PDF:LANDSCAPE~~+====== Formatting Syntax ======
  
-====== HIQ Configurator ======+[[doku>DokuWiki]] supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains all possible syntax you may use when editing the pages. Simply have a look at the source of this page by pressing "Edit this page". If you want to try something, just use the [[playground:playground|playground]] page. The simpler markup is easily accessible via [[doku>toolbar|quickbuttons]], too.
  
-HIQ Configurator is a tool for setting the HIQ system configuration parameters. +===== Basic Text Formatting =====
-This includes device settings, timetable, automation, alarm and more. +
-Controller  Settings can be saved in a file. Hardware configuration is +
-automatically detected during the installation.+
  
-To check the application without the hardware, run HIQ Simulator (included in HIQ Configurator install directory), keep it running, and click Autodetect.+DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. Of course you can **__//''combine''//__** all these.
  
-HIQ Configurator works in a local network, internet access is not supported.+  DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. 
 +  Of course you can **__//''combine''//__** all these.
  
 +You can use <sub>subscript</sub> and <sup>superscript</sup>, too.
  
-Download {{hiq_home:methods:hiq_configurator_v1.2.7.exe|HIQ Configurator v1.2.7}}.\\ +  You can use <sub>subscript</sub> and <sup>superscript</sup>, too.
-(Some antivirus programs or company firewalls do not allow the downloading of *.exe files. You can download {{hiq_home:methods:hiq_configurator_v1.2.7.zip|file in .zip package}} or you can disable the antivirus program.) +
-===== Lights + Blinds =====+
  
-<WRAP column 500px>+You can mark something as <del>deleted</del> as well.
  
-Manual control of lights, dimmers, blinds and scenes.+  You can mark something as <del>deleted</del> as well.
  
-|< 100% 150px >| +**Paragraphs** are created from blank lines. If you want to **force a newline** without a paragraph, you can use two backslashes followed by a whitespace or the end of line.
-^   Manual control   || +
-| **On Off lights**   | Click on icon to toggle.                                                                                                                                                              | +
-| **Dimmable lights** | Adjust brightness with slider then click on icon to toggle on/off.                                                                                                                    | +
-| **Blinds**          | Click on blind to set position.                                                                                                                                                       | +
-| **Scenes**          | Click on scene icon to set affected lights and blinds to values stored in scene memory.                                                                                               | +
-|                                                                                                                                                                                                            || +
-^    Settings  || +
-| **On Off lights**   | Long-press to set auto off time in seconds; set to 0 to disable auto-off.                                                                                                            | +
-| **Dimmable lights** | No individual  Settings available. Check smooth option to gruadually enable intensity change for all dimmable lights.                                                                   | +
-| **Blinds**          | Long-press on upper / lower time to set rising / lowering time.                                                                                                                       | +
-| :::                 | Long-press on % to set intermediate position. Set to 0 for no intermediate position.                                                                                                  | +
-| **Scenes**          | Long-press on scene icon to memorize actual lights/blinds state to scene memory. Only affected lights and blinds will be memorized. For setting affected devices see "Scene editor". |+
  
-</WRAP>+This is some text with some linebreaks\\ Note that the 
 +two backslashes are only recognized at the end of a line\\ 
 +or followed by\\ a whitespace \\this happens without it.
  
-<WRAP column>+  This is some text with some linebreaks\\ Note that the 
 +  two backslashes are only recognized at the end of a line\\ 
 +  or followed by\\ a whitespace \\this happens without it.
  
-{{  :sw:hiq_configurator:lights_blinds.png?800&direct|}}+You should use forced newlines only if really needed.
  
-</WRAP>+===== Links =====
  
-<WRAP clear></WRAP>\\ +DokuWiki supports multiple ways of creating links.
-\\+
  
-==== RGB dimmer ====+==== External ====
  
-<WRAP column 500px>+External links are recognized automagically: http://www.google.com or simply www.google.com - You can set the link text as well: [[http://www.google.com|This Link points to google]]. Email addresses like this one: <andi@splitbrain.org> are recognized, too.
  
-RGB mode is used when red/green/blue/(white) LED stripe is connected to the dimmer. Instead of individual light, total brightness, saturation and hue are controlled.+  DokuWiki supports multiple ways of creating links. External links are recognized 
 +  automagically: http://www.google.com or simply www.google.com - You can set 
 +  link text as well: [[http://www.google.com|This Link points to google]]. Email 
 +  addresses like this one: <andi@splitbrain.org> are recognized, too.
  
 +==== Internal ====
  
-|< 100% >| +Internal links are created by using square brackets. You can either just give a [[pagename]] or use an additional [[pagename|link text]].
-^   Control  | +
-| Sliders on top adjust brightness, saturation and hue of RGB lights. Check boxes on right side toggle RGB and White lamps | +
-| Color cycling button will start color cycling.|  +
-| Colors buttons will set RGB lights to match button color. | +
-| Off button will turn RGB off. | +
-| | +
-^   Settings  | +
-| White temperature mode check box enables white range simulation, from warm to cold white. | +
-| Cycle time sets color cycling speed (time for complete cycle in seconds). |+
  
-</WRAP>+  Internal links are created by using square brackets. You can either just give 
 +  a [[pagename]] or use an additional [[pagename|link text]].
  
-<WRAP column>+[[doku>pagename|Wiki pagenames]] are converted to lowercase automatically, special characters are not allowed.
  
-{{ sw:hiq_configurator:rgb_dimmer.png?direct&800|}}+You can use [[some:namespaces]] by using a colon in the pagename.
  
-</WRAP>+  You can use [[some:namespaces]] by using a colon in the pagename.
  
-<WRAP clear></WRAP>\\ +For details about namespaces see [[doku>namespaces]].
-\\ +
-==== Input setup ====+
  
-<WRAP column 500px>+Linking to a specific section is possible, too. Just add the section name behind a hash character as known from HTML. This links to [[syntax#internal|this Section]].
  
-Set mode of operation for each [[:hiq_home:hw:lc-10-iq|Light controller (LC)]] input.\\ +  This links to [[syntax#internal|this Section]].
-Default is to toggle the corresponding output on and off with each keypress.\\ +
-Timer extend is used to extend the time when output is configured as timer. +
-Typical usage is for a staircase light.\\ +
-Direct mode turns output on when button is pressed, off when released. +
-Typical usage is for a door bell.\\ +
-Scene button enables selected scene. Scene number is altered with a long press on scene number.\\ +
-Timer extend mode extends timer with every press. Typical use is motion (PIR) sensor.\\ +
-Timer extend/night only - the same as above, works only al low light conditions.\\ +
-Motions sensor for ready light.\\ +
-Inverse door (window) sensor – inverse function of “direct” (doorbell) button. +
-Inverse door sensor/night only – the same as above, works only al low light conditions.\\ +
-Door sensor for ready light. +
-Input only – used for custom programming in [[:hiq_home:hw:hc-iq| Home controller]].\\+
  
-|< 100% >| +Notes:
-^   Settings  | +
-| Click on input icon to cycle between all options.| +
-| In scene mode corresponding scene has to be set. |+
  
-</WRAP>+  * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones. 
 +  * DokuWiki does not use [[wp>CamelCase]] to automatically create links by default, but this behavior can be enabled in the [[doku>config]] file. Hint: If DokuWiki is a link, then it's enabled. 
 +  * When a section's heading is changed, its bookmark changes, too. So don't rely on section linking too much.
  
-<WRAP column>+==== Interwiki ====
  
-{{ :sw:hiq_configurator:input_setup.png?direct&800|}}+DokuWiki supports [[doku>Interwiki]] links. These are quick links to other Wikis. For example this is a link to Wikipedia's page about Wikis: [[wp>Wiki]].
  
-</WRAP>+  DokuWiki supports [[doku>Interwiki]] links. These are quick links to other Wikis. 
 +  For example this is a link to Wikipedia's page about Wikis: [[wp>Wiki]].
  
-<WRAP clear></WRAP>\\ +==== Windows Shares ====
-\\ +
-==== IR remote ====+
  
-<WRAP column 500px>+Windows shares like [[\\server\share|this]] are recognized, too. Please note that these only make sense in a homogeneous user group like a corporate [[wp>Intranet]].
  
-HIQ scenes can be set from an IR remote controller. Any Philips (RC5) compatible remote controller can be used. Receiver is any scene controller or thermostat ([[:hiq_home:hw:sc-4t-iq| SC-4T-IQ]], [[:hiq_home:hw:sc-40-iq| SC-40-IQ]], [[:hiq_home:hw:th-1m-iq| TH-1M-IQ]], [[:hiq_home:hw:th-1t-iq| TH-1T-IQ]] and [[:hiq_home:hw:th-3-iq| TH-3-IQ]]).+  Windows Shares like [[\\server\share|this]] are recognized, too.
  
-|< 100% >| +Notes:
-^   Settings  | +
-| Press remote controller button until the code is recognized, then assign it to a scene. | +
-|Enable or disable IR receiver in each scene controller and/or thermostat.| +
-|Enable or disable beep when valid IR code is received.|+
  
-</WRAP>+  * For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the "local zone"). 
 +  * For Mozilla and Firefox it can be enabled through different workaround mentioned in the [[http://kb.mozillazine.org/Links_to_local_pages_do_not_work|Mozilla Knowledge Base]]. However, there will still be a JavaScript warning about trying to open a Windows Share. To remove this warning (for all users), put the following line in ''conf/lang/en/lang.php'' (more details at [[doku>localization#changing_some_localized_texts_and_strings_in_your_installation|localization]]): <code - conf/lang/en/lang.php> 
 +<?php 
 +/** 
 + * Customization of the english language file 
 + * Copy only the strings that needs to be modified 
 + */ 
 +$lang['js']['nosmblinks'] = ''; 
 +</code>
  
-<WRAP column>+==== Image Links ====
  
-{{ :sw:hiq_configurator:ir_remote.png?direct&800|}}+You can also use an image to link to another internal or external page by combining the syntax for links and [[#images_and_other_files|images]] (see below) like this:
  
-</WRAP>+  [[http://php.net|{{wiki:dokuwiki-128.png}}]]
  
-<WRAP clear></WRAP>\\ +[[http://php.net|{{wiki:dokuwiki-128.png}}]]
-\\ +
-===== Scene editor =====+
  
-<WRAP column 500px>+Please note: The image formatting is the only formatting syntax accepted in link names.
  
-A Scene is a user defined array, used to set a group of lights and blinds to a predefined state. +The whole [[#images_and_other_files|image]] and [[#links|link]] syntax is supported (including image resizing, internal and external images and URLs and interwiki links).
-Within a scene, each output can be on, off, or not affected. +
-Dimmer and blinds can be set from 0 to 100% in 10% increments.+
  
-^   Settings  | +===== Footnotes =====
-| Click on matrix to toggle between allowed options. Hold and drag to set multiple fields. | +
-| If scene controller (SC-4x-IQ) is connected, click Read before and Write after editing.  | +
-| Use Clear all to erase the whole matrix.                                                 |+
  
-</WRAP>+You can add footnotes ((This is a footnote)) by using double parentheses.
  
-<WRAP column>+  You can add footnotes ((This is a footnote)) by using double parentheses.
  
-{{ :sw:hiq_configurator:scene_editor.png?direct&800|}}+===== Sectioning =====
  
-</WRAP>+You can use up to five different levels of headlines to structure your content. If you have more than three headlines, a table of contents is generated automatically -- this can be disabled by including the string ''<nowiki>~~NOTOC~~</nowiki>'' in the document.
  
-<WRAP clear></WRAP>\\ +==== Headline Level 3 ==== 
-\\ +=== Headline Level 4 === 
-===== Ready light =====+== Headline Level 5 ==
  
-<WRAP column 500px>+  ==== Headline Level 3 ==== 
 +  === Headline Level 4 === 
 +  == Headline Level 5 ==
  
-Ready Light is a light automation system. +By using four or more dashes, you can make a horizontal line:
-Unlike common presence detectors, its design ensures almost perfect operation. +
-The system is based on two sensors, passive infrared (PIR) for presence, and magnetic reed switch for door open/close.  +
-System can be used with a single sensor (PIR or reed), but is also limited to common functionality. +
  
-|< 100% 150px >| +----
-^  Settings                                                                                        || +
-| **room enable**    | Enables Ready Light functionality.                                          | +
-| **only by night ** | Enables operation at low light conditions only.                                            | +
-| **light output**   | Set which light will be effected.                                           | +
-| **motion sensor**      | Set motion sensor (PIR) input.                                                  | +
-| **door sensor**     | Set magnetic (reed) door sensor input.                                                      | +
-| **short timeout**  | Set time from closing the door to the moment when lights will turn off.     | +
-| **long timeout**   | Set time from leaving the room to light off, without closing the door.|+
  
-</WRAP>+===== Media Files =====
  
-<WRAP column>+You can include external and internal [[doku>images|images, videos and audio files]] with curly brackets. Optionally you can specify the size of them.
  
-{{ :sw:hiq_configurator:ready_light.png?direct&800|}}+Real size:                        {{wiki:dokuwiki-128.png}}
  
-</WRAP>+Resize to given width:            {{wiki:dokuwiki-128.png?50}}
  
-<WRAP clear></WRAP>\\ +Resize to given width and height((when the aspect ratio of the given width and height doesn't match that of the image, it will be cropped to the new ratio before resizing)): {{wiki:dokuwiki-128.png?200x50}}
-\\ +
-===== HVAC =====+
  
-<WRAP column 500px>+Resized external image:           {{https://www.php.net/images/php.gif?200x50}}
  
-Heating/cooling control.+  Real size:                        {{wiki:dokuwiki-128.png}} 
 +  Resize to given width:            {{wiki:dokuwiki-128.png?50}} 
 +  Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}} 
 +  Resized external image:           {{https://www.php.net/images/php.gif?200x50}}
  
-|< 100% 150px >| 
-^  Settings                                                                                                                      || 
-| **on/off**     | Toggle on/off mode. When OFF, secondary setpoint is used. When secondary setpoint is set to 0, output is off. | 
-| **setpoint**   | Setpoint for ON mode.                                                                                         | 
-| **fan limit**  | Toggle between preset fan modes.                                                                              | 
  
-</WRAP>+By using left or right whitespaces you can choose the alignment.
  
-<WRAP column>+{{ wiki:dokuwiki-128.png}}
  
-{{ :sw:hiq_configurator:hvac.png?direct&800|}}+{{wiki:dokuwiki-128.png }}
  
-</WRAP>+{{ wiki:dokuwiki-128.png }}
  
-<WRAP clear></WRAP>\\ +  {{ wiki:dokuwiki-128.png}} 
-\\ +  {{wiki:dokuwiki-128.png }} 
-==== HVAC setup ====+  {{ wiki:dokuwiki-128.png }}
  
-<WRAP column 500px>+Of course, you can add a title (displayed as a tooltip by most browsers), too.
  
-Heating/cooling setup.+{{ wiki:dokuwiki-128.png |This is the caption}}
  
-|< 100% 200px >| +  {{ wiki:dokuwiki-128.png |This is the caption}}
-^  Settings    || +
-| **heating/cooling/off**           | Operation mode and energy source selection.    | +
-| **delay**                         | Actuator delay time in seconds.   |  +
-|         || +
-| **outdoor temperature**           | Enable and select which thermostat external temperature sensor is measuring outdoor temperature.                                                  | +
-| **wall temperature**              | Enable and select which thermostat external temperature sensor is measuring wall temperature.                                                     | +
-| **water temperature**             | Enable and select which thermostat external temperature sensor is measuring water temperature.                                                    | +
-| **auxiliary temperature**         | Enable and select which thermostat external temperature sensor is measuring auxiliary temperature.                                                | +
-|                                                                                                                                                                                      || +
-| **temperature source**            | Select thermostat regulation temperature source: internal, external (connected to thermostat) or remote (connected to fan-coil controller).       | +
-| **display when off**              | Select what to display when thermostat is off. Available options are nothing, dashes or measured temperature.                                     | +
-| **available fan options**         | Select available fan options: F1 (low speed), F2 (medium speed), F3 (high speed) and MAX (max fan speed for predefined time). | +
-| **write options to thermostat**               | Write thermostat options to device.                                                                                                               | +
-| **read back**                     | Read thermostat options from device.                                                                                                              | +
-|                                                                                                                                                                                      || +
-| **setpoint idle**                 | Idle setpoint, used when thermostat is off. Set to 0 for disabling heating/cooling when thermostat is off.                                        | +
-| **setpoint lo limit**             | Lower limit for user setpoint setting.                                                                                                            | +
-| **setpoint hi limit**             | Higher limit for user setpoint setting.                                                                                                           | +
-| **max time**                      | Timeout for fan max functionality.                                                                                                                | +
-| **temperature offset**            | Offset for temperature measurements.                                                                                                              | +
-| **hysteresis**                    | Hysteresis for thermostat temperature regulation.                                                                                                 | +
-| **window switch**                 | Enable window switch. When enabled opened window will turn heating/cooling off.                                                                   | +
-| **window switch**                 | Enable window switch. When enabled opened window will turn heating/cooling off.                                                                   | +
-| **output active**                 | Indicates if the output is currently active                                   | +
-| **demand enable**                 | Enable heating/cooling demand. When enabled, output on [[:hiq_home:hw:hc-iq| Home controller]] will be switched on (QX6 for heating and QX5 for cooling.|+
  
 +For linking an image to another page see [[#Image Links]] above.
  
-</WRAP>+==== Supported Media Formats ====
  
-<WRAP column>+DokuWiki can embed the following media formats directly.
  
-{{ :sw:hiq_configurator:hvac_setup.png?direct&800|}}+| Image | ''gif'', ''jpg'', ''png''  | 
 +| Video | ''webm'', ''ogv'', ''mp4'' | 
 +| Audio | ''ogg'', ''mp3'', ''wav''  | 
 +| Flash | ''swf''                    |
  
-</WRAP>+If you specify a filename that is not a supported media format, then it will be displayed as a link instead.
  
-<WRAP clear></WRAP>\\ +By adding ''?linkonly'' you provide a link to the media without displaying it inline
-\\+
  
-===== Timetable =====+  {{wiki:dokuwiki-128.png?linkonly}}
  
-<WRAP column 500px>+{{wiki:dokuwiki-128.png?linkonly}} This is just a link to the image.
  
-Timetable defines periods in which the heating/cooling system is active, when output (0-55) and/or scene is active. +==== Fallback Formats ====
-Tables are independent, and may be used to handle separate zones, e.g. living area or sleeping area. +
-Manual override is possible at any time, timetable will catch on with the next transition.     +
  
-|< 100% 150px >| +Unfortunately not all browsers understand all video and audio formats. To mitigate the problem, you can upload your file in different formats for maximum browser compatibility.
-^  Settings                                                                                                                                      || +
-| **matrix**           | Click to toggle active/idle state. Hold and drag mouse to set multiple fields. Each rectangle represents a half hour.   | +
-|                                                                                                                                               || +
-| **TH0 .. TH4**       | Select which thermostat is affected.                                                                                    | +
-| **set output**       | Select and specify which output is activated on idle to active transition and deactivated at active to idle transition. | +
-| **set scene**        | Select and specify which scene is activated on idle to active transition (on) and at active to idle transition. (off)   |+
  
 +For example consider this embedded mp4 video:
  
 +  {{video.mp4|A funny video}}
  
-</WRAP>+When you upload a ''video.webm'' and ''video.ogv'' next to the referenced ''video.mp4'', DokuWiki will automatically add them as alternatives so that one of the three files is understood by your browser.
  
-<WRAP column>+Additionally DokuWiki supports a "poster" image which will be shown before the video has started. That image needs to have the same filename as the video and be either a jpg or png file. In the example above a ''video.jpg'' file would work.
  
-{{ :sw:hiq_configurator:timetable.png?direct&800|}}+===== Lists =====
  
-</WRAP>+Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a ''*'' for unordered lists or a ''-'' for ordered ones.
  
-<WRAP clear></WRAP>\\ +  * This is a list 
-\\ +  * The second item 
-===== Automation =====+    * You may have different levels 
 +  * Another item
  
-<WRAP column 500px>+  - The same list but ordered 
 +  - Another item 
 +    - Just use indention for deeper levels 
 +  - That's it
  
-Events are based on the HIQ Commander application, which must be installed on your phone. +<code> 
-Some phones may not support all events.+  * This is a list 
 +  * The second item 
 +    * You may have different levels 
 +  * Another item
  
-|< 100% 150px >| +  - The same list but ordered 
-^  Settings     || +  - Another item 
-| Select tasks and actions to be performed automatically and/or when the event occurs. | +    - Just use indention for deeper levels 
-|| +  - That's it 
-| **presence indicator**         | aaaaaaaaaaaaaaaaaaaaaa                              | +</code>
-|presence descript|bbbbbbbb| +
-|| +
-| **low light indicator** | Indication; Used for various automations.                                                                                                                   | +
-| latitude / longitude    | Set geographic location for sunrise / sunset calculation. Also correct time zone must be set in “system -> setup -> time zone”                                                                                  | +
-| offset            | Sunrise/sunset correction given in minutes, positive value moves sunrise later and sunset earlier.                                               | +
-| also use light sensor        | Use [[:hiq_home:hw:rhkf-u| lightness sensor]]  for low light calculation.                                                                                                     | +
-| threshold                | Lightness sensor threshold for day/night calculation.                                                                                                | +
-|| +
-| **coming home**         | Task is triggered when we came home – in connection with presence indicator.                                                                               | +
-| TH0 on .. TH4 on        | Select which thermostat is toggled to ON state.                                                                                                 | +
-| set scene               | Set scene to be activated at coming home task.                                                                                                  | +
-| only by night          | If enabled, scene will be triggered at low light.                                                                                              | +
-|                                                                                                                                                                          || +
-| **leaving home**        | Task is triggered when we leave – in connection with presence indicator.                                                                   | +
-| TH0 off .. TH4 off      | Select which thermostat is toggled to ON state.                                                                                                 | +
-| set scene               | Set scene to be activated at leaving home task.                                                                                                 | +
-| only by night          | If enabled, scene will be triggered at low light.                                                                                              | +
-|                                                                                                                                                                          || +
-| **smart lights**        | aaaaaaaaaaaa.                                                                   | +
-|set scene      | Set scene to be activated at leaving home task.                                                                                                 | +
-| set dimmer               | Set scene to be activated at leaving home task.                                                                                                 | +
-| transition time          | If enabled, scene will be triggered at low light.                                                                                              | +
-| final brightness          | If enabled, scene will be triggered at low light.                                                                                              | +
-|                                                                                                                                                                          || +
-| **random lights**       | When nobody is at home set random scenes to discourage snooping.                                                                                | +
-| scene number            | Set which scenes will be randomly triggered.                                                                                                    | +
-|                                                                                                                                                                          || +
-| **comfort wake up**        | Task is triggered at a predefined time before smartphone alarm time (time is set on the smartphone).                                                                                 | +
-| TH0 on .. TH4 on        | Select affected thermostats.                                                                                                                    | +
-| set scene               | Set scene to be activated at comfort wake up task.                                                                                                 | +
-| only by night          | If enabled, scene will be triggered only at low light.                                                                                              | +
-|                                                                                                                                                                          || +
-| **sunny wake up**       | HIQ lifts blind in your bedroom. Task is triggered at a predefined time before smartphone alarm time (time is set on the smartphone).                                                                              | +
-| move gradually           | Selected blind will move gradually.                                                                                                                             | +
-| blinds number           | Set affected blind.                                                                                                                             | +
-| final position           | Final blind position.                                                                                                                           | +
-|                                                                                                                                                                          || +
-| **default setpoint**    | When active, temperature setpoint adjustment is valid for about an hour, then it returns to the predefined, optimal temperature.                  | +
-| TH0 .. TH4              | Select affected thermostat and set optimal temperature. The remaing time is shown in minutes.                                                                                            | +
-|                                                                                                                                                                          || +
-| **bio offset**          | Temperature will follow your natural biological rhythm (chronotype).                                                                            | +
-| //time-plot//           | Set morning, evening or both temperatures to increase/decrease.                                                                                              | +
-| //slider//              | Set temperature increase/decrease.                                                                                                                       | +
-|                                                                                                                                                                          || +
-| **connect charger**     | Actions will be triggered when smartphone is connected to a charger.                                                                              | +
-| TH0 off .. TH4 off        | Select which thermostat is affected.                                                                                                            | +
-| set scene               | Set scene to be activated at connecting charger.                                                                                                | +
-| only by night          | If enabled, scene will be triggered only at low light.                                                                                              | +
-|                                                                                                                                                                          || +
-| **disconnect charger**  | Actions will be triggered when smartphone is disconnected from a charger.                                                                              | +
-| TH0 on .. TH4 on      | Select which thermostat is affected.                                                                                                            | +
-| set scene               | Set scene to be activated at disconnecting charger.                                                                                                | +
-| only by night          | If enabled, scene will be triggered only at low light.                                                                                              | +
-|                                                                                                                                                                          || +
-| **call notification**   | When you receive a call, selected light will turn on and off a couple of times, to get your attention when phone is away or silenced.          | +
-| Output number           | Set affected light output (0-55).                                                                                                                             | +
-|                                                                                                                                                                          || +
-| **text notification**   | When you receive a  text message, selected light will turn on and off a couple of times, to get your attention when phone is away or silenced. | +
-| Output number           | Set affected light (0-55).                                                                                                                             | +
-</WRAP>+
  
-<WRAP column>+Also take a look at the [[doku>faq:lists|FAQ on list items]].
  
-{{ :sw:hiq_configurator:automation.png?direct&800|}}+===== Text Conversions =====
  
-</WRAP>+DokuWiki can convert certain pre-defined characters or strings into images or other text or HTML.
  
-<WRAP clear></WRAP>\\ +The text to image conversion is mainly done for smileys. And the text to HTML conversion is used for typography replacements, but can be configured to use other HTML as well.
-\\ +
-===== Alarm =====+
  
-<WRAP column 500px>+==== Text to Image Conversions ====
  
-Alarm is based on 4 zones, each with up to 3 sensors. Alarm states are: +DokuWiki converts commonly used [[wp>emoticon]]s to their graphical equivalents. Those [[doku>Smileys]] and other images can be configured and extended. Here is an overview of Smileys included in DokuWiki:
-  * **OFF**: protection is off. +
-  * **Arming**: protection is switching on, active timeout for leaving protected area. +
-  * **Armed**: protection enabled. +
-  * **Activating**: protection is on and movement detected - timeout allows to disengage alarm. +
-  * **Alarm active**: intrusion detected, siren output active. +
-  * **Expired**: delay time expired, siren is turned off (default 120s).+
  
 +  * 8-) %%  8-)  %%
 +  * 8-O %%  8-O  %%
 +  * :-( %%  :-(  %%
 +  * :-) %%  :-)  %%
 +  * =)  %%  =)   %%
 +  * :-/ %%  :-/  %%
 +  * :-\ %%  :-\  %%
 +  * :-? %%  :-?  %%
 +  * :-D %%  :-D  %%
 +  * :-P %%  :-P  %%
 +  * :-O %%  :-O  %%
 +  * :-X %%  :-X  %%
 +  * :-| %%  :-|  %%
 +  * ;-) %%  ;-)  %%
 +  * ^_^ %%  ^_^  %%
 +  * m(  %%  m(   %%
 +  * :?: %%  :?:  %%
 +  * :!: %%  :!:  %%
 +  * LOL %%  LOL  %%
 +  * FIXME %%  FIXME %%
 +  * DELETEME %% DELETEME %%
  
-|< 100% 150px >| +==== Text to HTML Conversions ====
-^  Control                                                                                                                                       || +
-| **zone0 .. zone3**   | Select affected zone.                                                                                                   | +
-| **alarm on/off**     | Toggle alarm for selected zones. If "require 4-digit code" is enabled we have to enter the code first.                                | +
-^  Settings                                                                                                                                      || +
-| **enable**   |Enable or disable sensor on selected input.                                                                                                    | +
-| **instant**   |If enabled, alarm will be activated instantly, without “Activating” time. Use in places without presence.       | +
-| **input**   |Input which triggers the alarm. Motion (PIR) sensors are recommended but any input can be used.       | +
-|| +
-| **arming time**   |Time from activating alarm to “Armed” state.     | +
-| **delay time**   |Time from intrusion detected to “alarm active” state.   | +
-| **active time**   |”Alarm active” time. When expired the siren will be switched off.   | +
-| **alarm output**   |Output for siren or other indicator.  | +
-| **alarm scene**   |”Alarm active” scene.  | +
-|| +
-| **auto arming by presence signal**   |Automatic arming by presence signal.  | +
-| **require 4-digit code**   |Change 4-digit arming/disarming code. Valid only in HIQ configurator. | +
-| **state indicator**   | Alarm state indicator. Blinks when arming, on when armed. Outputs 0-39 can be used.  | +
-| **use blinking**   | Alarm state indicator blinks when “Arming” is activated and when alarm is deactivated.  |+
  
-</WRAP>+Typography: [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.
  
-<WRAP column>+-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) 
 +"He thought 'It's a man's world'..."
  
-{{ :sw:hiq_configurator:alarm.png?direct&800 |}}+<code> 
 +-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) 
 +"He thought 'It's a man's world'..." 
 +</code>
  
-</WRAP>+The same can be done to produce any kind of HTML, it just needs to be added to the [[doku>entities|pattern file]].
  
-<WRAP clear></WRAP>\\ +There are three exceptions which do not come from that pattern file: multiplication entity (640x480), 'single' and "double quotes". They can be turned off through a [[doku>config:typography|config option]].
-\\+
  
-===== Energy =====+===== Quoting =====
  
-<WRAP column 500px> +Some times you want to mark some text to show it's a reply or comment. You can use the following syntax:
-Energy monitoring is the first step to efficient energy usage. Once knowing how much energy something is using, one can make a rational strategy for saving.+
  
-|< 100% 150px >| +<code> 
-^ Overview  || +I think we should do it
-| **total power**     | Current power. | +
-| **energy total**   | Used energy since energy counter installation (or reset). | +
-| **relative power**  | Toggle between preset fan modes.                                                               | +
-| **voltage**     | Current system voltage. | +
-| **energy in last 24 hours**   | Graph of used energy in last 24 hours.                | +
-| ** energy in last 24 hours **  | Graph of used energy in last 30 days.    | +
-| ** Power consumption **  | Power consumption in last hour.   | +
-||| +
-^ Settings  ||  +
-| **Reset**  | Reset energy consumption, to measure the amount of electricity something is using:| +
-|:::|1. Turn the output off.| +
-|:::|2. Reset relative power.| +
-|:::|3. Turn the output on.| +
-|:::|A few seconds later, measured relative power is displayed. If the reading is not stable, temporary turn off any load which may consume variable amount of power.| +
-|:::|Measured rating may be used to set the nominal power on ‘By output’ page. |+
  
 +> No we shouldn't
  
-</WRAP>+>> Well, I say we should
  
-<WRAP column>+> Really?
  
-{{ :sw:hiq_configurator:energy.png?direct&800|}}+>> Yes!
  
-</WRAP>+>>> Then lets do it! 
 +</code>
  
-<WRAP clear></WRAP>\\ +I think we should do it
-\\+
  
-==== Energy by output ====+> No we shouldn't
  
-<WRAP column 500px>+>> Well, I say we should
  
-Overview of +> Really?
  
-|< 100% 200px >| +>> Yes!
-^  Overview    || +
-| **Power count**     | A number how many times the output is turned on. | +
-| **Working hours**   |Total number of hours the output spent in on state | +
-| **Nominal power**  | Output power configured by user. | +
-| **Current power**  | Output power at the current moment.  | +
-| **Energy today**     | Total energy used from last midnight. | +
-| **Energy total**   | Total energy consumed by the specific output.           | +
-||| +
-^  Configuration    || +
-|** output**     | Select target output with +/- button.| +
-| **Set nominal** | Set nominal power. It can be measured by resettable power meter or read from the label.   | +
-|**Reset counter**  | Power count, working hours and energy total can be reset.  | +
-| **Toggle output ** | Toggle selected output.  |+
  
-</WRAP>+>>> Then lets do it!
  
-<WRAP column>+===== Tables =====
  
-{{ :sw:hiq_configurator: energy_by_output.png?direct&800|}}+DokuWiki supports a simple syntax to create tables.
  
-</WRAP>+^ Heading 1      ^ Heading 2       ^ Heading 3          ^ 
 +| Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        | 
 +| Row 2 Col 1    | some colspan (note the double pipe) || 
 +| Row 3 Col 1    | Row 3 Col 2     | Row 3 Col 3        |
  
-<WRAP clear></WRAP>\\ +Table rows have to start and end with a ''|'' for normal rows or a ''^'' for headers.
-\\ +
-===== System =====+
  
-<WRAP column 500px>+  ^ Heading 1      ^ Heading 2       ^ Heading 3          ^ 
 +  | Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        | 
 +  | Row 2 Col 1    | some colspan (note the double pipe) || 
 +  | Row 3 Col 1    | Row 3 Col 2     | Row 3 Col 3        |
  
-Heating/cooling control.+To connect cells horizontally, just make the next cell completely empty as shown above. Be sure to have always the same amount of cell separators!
  
-|< 100% 150px >| +Vertical tableheaders are possible, too.
-^  Settings                                                                                                                      || +
-| **on/off**     | Toggle on/off mode. When OFF, secondary setpoint is used. When secondary setpoint is set to 0, output is off. | +
-| **setpoint**   | Setpoint for ON mode.                                                                                         | +
-| **fan limit**  | Toggle between preset fan modes.                                                                              |+
  
-</WRAP>+|              ^ Heading 1            ^ Heading 2          ^ 
 +^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        | 
 +^ Heading 4    | no colspan this time |                    | 
 +^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |
  
-<WRAP column>+As you can see, it's the cell separator before a cell which decides about the formatting:
  
-{{ :sw:hiq_configurator:system.png?direct&800|}}+  |              ^ Heading 1            ^ Heading 2          ^ 
 +  ^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        | 
 +  ^ Heading 4    | no colspan this time |                    | 
 +  ^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |
  
-</WRAP>+You can have rowspans (vertically connected cells) by adding ''%%:::%%'' into the cells below the one to which they should connect.
  
-<WRAP clear></WRAP>\\ +^ Heading 1      ^ Heading 2                  ^ Heading 3          ^ 
-\\+| Row 1 Col 1    | this cell spans vertically | Row 1 Col 3        | 
 +| Row 2 Col 1    | :::                        | Row 2 Col 3        | 
 +| Row 3 Col 1    | :::                        | Row 2 Col 3        |
  
-==== System setup ====+Apart from the rowspan syntax those cells should not contain anything else.
  
-<WRAP column 500px>+  ^ Heading 1      ^ Heading 2                  ^ Heading 3          ^ 
 +  | Row 1 Col 1    | this cell spans vertically | Row 1 Col 3        | 
 +  | Row 2 Col 1    | :::                        | Row 2 Col 3        | 
 +  | Row 3 Col 1    | :::                        | Row 2 Col 3        |
  
-Heating/cooling setup.+You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text.
  
-|< 100% 200px >| +^           Table with alignment           ^^^ 
-^  Settings                                                                                                                                                                             || +|         right|    center    |left          | 
-| **heating/cooling/off**           | Operation mode and energy source selection.                                                                                                       | +|left          |         right|    center    | 
-|                                                                                                                                                                                      || +| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
-| **fan coil/radiator/none**        | Actuator selection.                                                                                                                               | +
-| **delay**                         | Actuator delay time in seconds.                                                                                                                   |+
  
 +This is how it looks in the source:
  
-</WRAP>+  ^           Table with alignment           ^^^ 
 +  |         right|    center    |left          | 
 +  |left          |         right|    center    | 
 +  | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
  
-<WRAP column>+Note: Vertical alignment is not supported.
  
-{{ :sw:hiq_configurator:system_setup.png?direct&800|}}+===== No Formatting =====
  
-</WRAP>+If you need to display text exactly like it is typed (without any formatting), enclose the area either with ''%%<nowiki>%%'' tags or even simpler, with double percent signs ''<nowiki>%%</nowiki>''.
  
-<WRAP clear></WRAP>\\ +<nowiki> 
-\\+This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. 
 +</nowiki> 
 +The same is true for %%//__this__ text// with a smiley ;-)%%.
  
 +  <nowiki>
 +  This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it.
 +  </nowiki>
 +  The same is true for %%//__this__ text// with a smiley ;-)%%.
 +
 +===== Code Blocks =====
 +
 +You can include code blocks into your documents by either indenting them by at least two spaces (like used for the previous examples) or by using the tags ''%%<code>%%'' or ''%%<file>%%''.
 +
 +  This is text is indented by two spaces.
 +
 +<code>
 +This is preformatted code all spaces are preserved: like              <-this
 +</code>
 +
 +<file>
 +This is pretty much the same, but you could use it to show that you quoted a file.
 +</file>
 +
 +Those blocks were created by this source:
 +
 +    This is text is indented by two spaces.
 +
 +  <code>
 +  This is preformatted code all spaces are preserved: like              <-this
 +  </code>
 +
 +  <file>
 +  This is pretty much the same, but you could use it to show that you quoted a file.
 +  </file>
 +
 +==== Syntax Highlighting ====
 +
 +[[wiki:DokuWiki]] can highlight sourcecode, which makes it easier to read. It uses the [[http://qbnz.com/highlighter/|GeSHi]] Generic Syntax Highlighter -- so any language supported by GeSHi is supported. The syntax uses the same code and file blocks described in the previous section, but this time the name of the language syntax to be highlighted is included inside the tag, e.g. ''<nowiki><code java></nowiki>'' or ''<nowiki><file java></nowiki>''.
 +
 +<code java>
 +/**
 + * The HelloWorldApp class implements an application that
 + * simply displays "Hello World!" to the standard output.
 + */
 +class HelloWorldApp {
 +    public static void main(String[] args) {
 +        System.out.println("Hello World!"); //Display the string.
 +    }
 +}
 +</code>
 +
 +The following language strings are currently recognized: //4cs 6502acme 6502kickass 6502tasm 68000devpac abap actionscript3 actionscript ada aimms algol68 apache applescript apt_sources arm asm asp asymptote autoconf autohotkey autoit avisynth awk bascomavr bash basic4gl batch bf biblatex bibtex blitzbasic bnf boo caddcl cadlisp ceylon cfdg cfm chaiscript chapel cil c_loadrunner clojure c_mac cmake cobol coffeescript c cpp cpp-qt cpp-winapi csharp css cuesheet c_winapi dart dcl dcpu16 dcs delphi diff div dos dot d ecmascript eiffel email epc e erlang euphoria ezt f1 falcon fo fortran freebasic freeswitch fsharp gambas gdb genero genie gettext glsl gml gnuplot go groovy gwbasic haskell haxe hicest hq9plus html html4strict html5 icon idl ini inno intercal io ispfpanel java5 java javascript jcl j jquery julia kixtart klonec klonecpp kotlin latex lb ldif lisp llvm locobasic logtalk lolcode lotusformulas lotusscript lscript lsl2 lua m68k magiksf make mapbasic mathematica matlab mercury metapost mirc mk-61 mmix modula2 modula3 mpasm mxml mysql nagios netrexx newlisp nginx nimrod nsis oberon2 objc objeck ocaml-brief ocaml octave oobas oorexx oracle11 oracle8 oxygene oz parasail parigp pascal pcre perl6 perl per pf phix php-brief php pic16 pike pixelbender pli plsql postgresql postscript povray powerbuilder powershell proftpd progress prolog properties providex purebasic pycon pys60 python qbasic qml q racket rails rbs rebol reg rexx robots roff rpmspec rsplus ruby rust sas sass scala scheme scilab scl sdlbasic smalltalk smarty spark sparql sql sshconfig standardml stonescript swift systemverilog tclegg tcl teraterm texgraph text thinbasic tsql twig typoscript unicon upc urbi uscript vala vbnet vb vbscript vedit verilog vhdl vim visualfoxpro visualprolog whitespace whois winbatch wolfram xbasic xml xojo xorg_conf xpp yaml z80 zxbasic//
 +
 +There are additional [[doku>syntax_highlighting|advanced options]] available for syntax highlighting, such as highlighting lines or adding line numbers.
 +
 +==== Downloadable Code Blocks ====
 +
 +When you use the ''%%<code>%%'' or ''%%<file>%%'' syntax as above, you might want to make the shown code available for download as well. You can do this by specifying a file name after language code like this:
 +
 +<code>
 +<file php myexample.php>
 +<?php echo "hello world!"; ?>
 +</file>
 +</code>
 +
 +<file php myexample.php>
 +<?php echo "hello world!"; ?>
 +</file>
 +
 +If you don't want any highlighting but want a downloadable file, specify a dash (''-'') as the language code: ''%%<code - myfile.foo>%%''.
 +
 +===== RSS/ATOM Feed Aggregation =====
 +[[DokuWiki]] can integrate data from external XML feeds. For parsing the XML feeds, [[http://simplepie.org/|SimplePie]] is used. All formats understood by SimplePie can be used in DokuWiki as well. You can influence the rendering by multiple additional space separated parameters:
 +
 +^ Parameter  ^ Description ^
 +| any number | will be used as maximum number items to show, defaults to 8 |
 +| reverse    | display the last items in the feed first |
 +| author     | show item authors names |
 +| date       | show item dates |
 +| description| show the item description. All HTML tags will be stripped |
 +| nosort     | do not sort the items in the feed |
 +| //n//[dhm] | refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). |
 +
 +The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. [[wiki:DokuWiki]] will generally try to supply a cached version of a page, obviously this is inappropriate when the page contains dynamic external content. The parameter tells [[wiki:DokuWiki]] to re-render the page if it is more than //refresh period// since the page was last rendered.
 +
 +By default the feed will be sorted by date, newest items first. You can sort it by oldest first using the ''reverse'' parameter, or display the feed as is with ''nosort''.
 +
 +**Example:**
 +
 +  {{rss>http://slashdot.org/index.rss 5 author date 1h }}
 +
 +{{rss>http://slashdot.org/index.rss 5 author date 1h }}
 +
 +
 +===== Control Macros =====
 +
 +Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble:
 +
 +^ Macro           ^ Description |
 +| %%~~NOTOC~~%%   | If this macro is found on the page, no table of contents will be created |
 +| %%~~NOCACHE~~%% | DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the %%<php>%% syntax above is used), adding this macro will force DokuWiki to rerender a page on every call |
 +
 +===== Syntax Plugins =====
 +
 +DokuWiki's syntax can be extended by [[doku>plugins|Plugins]]. How the installed plugins are used is described on their appropriate description pages. The following syntax plugins are available in this particular DokuWiki installation:
 +
 +~~INFO:syntaxplugins~~
  
wiki/syntax.1480498486.txt.gz · Last modified: 2016/11/30 09:34 by saso_santelj