Skip to content

Commit 3de78d1

Browse files
Update transformation docs for script profile changes & Clean-Up addons folder (#2235)
* Update transformation docs for script profile changes Refs openhab/openhab-core#4058. Signed-off-by: Florian Hotze <[email protected]> * Migrate actions docs from addons to configuration folder Signed-off-by: Florian Hotze <[email protected]> * Clean-up addons docs The removed files have not been picked up by the build process, i.e. they were not used by the website. Looking at their content, they also seem outdated. Signed-off-by: Florian Hotze <[email protected]> * Minor enhancements Signed-off-by: Florian Hotze <[email protected]> * Address review Signed-off-by: Florian Hotze <[email protected]> --------- Signed-off-by: Florian Hotze <[email protected]> Co-authored-by: stefan-hoehn <[email protected]>
1 parent c9a8344 commit 3de78d1

File tree

13 files changed

+43
-377
lines changed

13 files changed

+43
-377
lines changed

.vuepress/process_file.rb

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -104,18 +104,6 @@ def process_file(indir, file, outdir, source)
104104
next
105105
end
106106

107-
# Actions and transformations are currently partly in add-ons, copy the content above the list of add-ons
108-
if line =~ /^More details regarding this and other Transformation services can be found in the individual transformation articles linked below./
109-
out.puts ""
110-
out.puts ":::tip"
111-
out.puts "You can find the available transformation services [here](https://www.openhab.org/addons/#transform)."
112-
out.puts ":::"
113-
out.puts ""
114-
break
115-
end
116-
117-
break if line =~ /^## Installable Actions/
118-
119107
# Remove collapsibles in Linux install document and replace them by regular headings
120108
next if line =~ /include collapsible/ && file =~ /linux/
121109
line = "##### " + line if line =~ /^Apt Based Systems/ && file =~ /linux/

.vuepress/process_main_docs.rb

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,6 @@ def process_main_docs(docs_source_dir)
6363
}
6464
puts " -> images"
6565
FileUtils.cp_r("#{docs_source_dir}/configuration/images", "docs/configuration")
66-
process_file("#{docs_source_dir}/addons", "actions.md", "docs/configuration", "#{$docs_repo_root}/addons/actions.md")
67-
process_file("#{docs_source_dir}/addons", "transformations.md", "docs/configuration", "#{$docs_repo_root}/addons/transformations.md")
6866
#process_file("#{docs_source_dir}/tutorials", "migration.md", "docs/configuration/migration", "#{$docs_repo_root}/tutorials/migration.md")
6967
#FileUtils.mv("docs/configuration/migration/migration.md", "docs/configuration/migration/index.md")
7068
#FileUtils.cp_r("#{docs_source_dir}/tutorials/images", "docs/configuration/migration")

addons/bindings.md

Lines changed: 0 additions & 94 deletions
This file was deleted.
-2.56 MB
Binary file not shown.

addons/index.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

addons/io.md

Lines changed: 0 additions & 70 deletions
This file was deleted.

addons/persistence.md

Lines changed: 0 additions & 50 deletions
This file was deleted.

addons/uis.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

addons/voices.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

addons/actions.md renamed to configuration/actions.md

Lines changed: 9 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,8 @@ We recommend placing these custom files somewhere inside your `$OH_CONF` folder,
386386

387387
#### Localization
388388

389-
Ephemeris supports translation of holidays into many languages. Localization support files can be found in the [GitHub repo](https://github.com/focus-shift/jollyday/tree/main/jollyday-core/src/main/resources/descriptions). Currently these language supports are available:
389+
Ephemeris supports translation of holidays into many languages. Localization support files can be found in the [GitHub repo](https://github.com/focus-shift/jollyday/tree/main/jollyday-core/src/main/resources/descriptions).
390+
Currently, these language supports are available:
390391

391392
1. [Dutch](https://github.com/focus-shift/jollyday/tree/main/jollyday-core/src/main/resources/descriptions/holiday_descriptions_nl.properties)
392393
1. [English](https://github.com/focus-shift/jollyday/tree/main/jollyday-core/src/main/resources/descriptions/holiday_descriptions.properties)
@@ -396,56 +397,10 @@ Ephemeris supports translation of holidays into many languages. Localization sup
396397
1. [Portuguese](https://github.com/focus-shift/jollyday/tree/main/jollyday-core/src/main/resources/descriptions/holiday_descriptions_pt.properties)
397398
1. [Swedish](https://github.com/focus-shift/jollyday/tree/main/jollyday-core/src/main/resources/descriptions/holiday_descriptions_sv.properties)
398399

399-
Feel free to extent this list by providing additional language support files.
400-
401-
To enable localization,
402-
403-
- copy the file for your language to your OH setup.
404-
- again a folder in `$OH_CONF` folder, such as `$OH_CONF/services` is proposed.
405-
- use function 'Ephemeris.getHolidayDescription' to convert the name according to your localization file.
406-
407-
## Installable Actions
408-
409-
The following actions are available as installable add-ons.
410-
411-
<table id="actions-select" class="striped">
412-
<tbody>
413-
<tr>
414-
<td width="20%">
415-
<p>
416-
<input type="checkbox" class="filled-in" id="manual-checkbox" />
417-
<label for="manual-checkbox"><img src="{{base}}/images/tag-install-manual.svg"></label>
418-
</p>
419-
</td>
420-
<td>
421-
<p>
422-
Some openHAB 1 actions have not yet completed validation for inclusion in the distribution; however, they may indeed work properly under openHAB 2.
423-
All openHAB 1 addons can be downloaded in a <a href="https://bintray.com/openhab/mvn/download_file?file_path=org%2Fopenhab%2Fdistro%2Fopenhab%2F1.9.0%2Fopenhab-1.9.0-addons.zip">zip file</a>.
424-
We need your help testing them so that they may be easily installed in a future distribution.
425-
Please see the <a href="{{base}}/developers/development/compatibilitylayer.html#how-to-use-openhab-1x-add-ons-that-are-not-part-of-the-distribution">compatibility layer documentation</a> and
426-
also search the <a href="https://community.openhab.org">openHAB community forum</a> for the latest information and steps for manual installation.
427-
</p>
428-
</td>
429-
</tr>
430-
</tbody>
431-
</table>
432-
433-
<table id="actions-overview" class="bordered addon-table">
434-
<thead>
435-
<tr>
436-
<th data-field="label" width="20%">Name</th>
437-
<th data-field="description">Description</th>
438-
</tr>
439-
</thead>
440-
<tbody>
441-
{% for action in site.addons_actions %}
442-
<tr class="install-{{action.install}} since-{{action.since}}">
443-
<td>
444-
<h4><a href="{{base}}{{action.url}}">{% if action.logo %}<img class="logo" src="{{base}}/{{action.logo}}" title="{{ action.label }}" alt="{{ action.label }}" />{% else %}{{ action.label }}{% endif %}</a></h4>
445-
<img src="{{base}}/images/tag-since-{{action.since}}.svg"> <img src="{{base}}/images/tag-install-{{action.install}}.svg">
446-
</td>
447-
<td>{{ action.description | markdownify }}</td>
448-
</tr>
449-
{% endfor %}
450-
</tbody>
451-
</table>
400+
Feel free to extend this list by providing additional language support files.
401+
402+
To enable localization:
403+
404+
- Copy the file for your language to your OH setup.
405+
- A folder in `$OH_CONF` folder, such as `$OH_CONF/services` is proposed.
406+
- Use the function `Ephemeris.getHolidayDescription` to convert the name according to your localization file.

0 commit comments

Comments
 (0)