Dokumentationsstruktur/en: Unterschied zwischen den Versionen

Aktuelle Version vom 28. Mai 2020, 14:26 Uhr

Documentation about FHEM is spread among several sources.

Short overview as a first orientation:

FHEM

Some basic informations about FHEM and installation instructions.

If you run into trouble when using and configuring FHEM it is strictly recommended to have a look into the CommandRef. There you find detailed info about usage and options for all official modules and FHEM commands. Also this is the place where new functionality will be first documented directly by the module's author. The Commandref shall provide the necessary info about how to use

FHEM commands and options;
Device modules wrt. definition, configuration and usage. Device module typically means modules to integrate a piece of hardware;
Helper modules.

For all people contributing software to be officially distributed with FHEM (aka module author) there is just one strict rule: They have to provide a commandref (in english) for the module and support it for the first tree months. So commandref is the most important source for information about each module.

TIP: A lot of the module authors are not fluent in english, so in case you see room for improvement of the english version just provide a better version and contact the respectivemaintainer - he/she most likely will be happy about your contribution.

FHEMWiki

The page you are currently reading is part of the FHEMWiki. The link at the top left leads you to the main page. This is a good place to start. We apologize about most articles are in German, feel free to add or translate content also in English for others! Many articles you find in the FHEMWiki are directly maintained by module authors, a lot of them have just been written by other users. So accuracy and timeliness of the articles may vary.

TIP: There's a special section in our forum for proposals for improvement on the FHEMWiki.

Forum

Some module authors - especially of modules not (yet) distributed as part of FHEM - prefer to provide further info about the usage of these modules in the Forum. Helpful information about the Forum itself is provided in the pinned Threads in Anfängerbereich, we apologize about them beeing mostly in German. Feel free to ask any question also in English - either in the English part of the Forum or also in the regular section you find suitable for your specific interest. If you are able to read german, you may find a lot of useful information by using the hints for doing forum searches in the mentioned pinned threads.

TIP: We like to challenge people about first having used the searching possibilities before asking, as most problems have been discussed before - there are about 20.000 users in the forum - so there waits (at least one) solution on most topics to be discovered! But we understand it's not easy to even know the right keywords for searching if you are not speaking german.

Foreign information sources

Information provided in other sources - especially blogs - have to be challenge yourself whether this is at the right level of timeliness and quality. Keep in mind: Most of the respective bloggers aso. may follow their own agenda. This may be different to the FHEM community's.

TIP: So it's highly recommended to first double check that sort of information against the one provided by the community before asking questions on info sourced "elsewhere" in the forum.

@@ Zeile 4: / Zeile 4: @@
 ==[http://www.fhem.de FHEM]==
-Some basic infos about FHEM and installation instructions.
+Some basic informations about FHEM and installation instructions.
 =={{Link2CmdRef}}==
-If you run into trouble when using and configuring FHEM it is strictly recommended to have a look into '''CommandRef'''. There you find detailed info about usage and options for all official modules and FHEM-commands. Also this is the place where new functionality will be first documented directly by module's autors. Commandref shall provide the necessary info about how to use
+If you run into trouble when using and configuring FHEM it is strictly recommended to have a look into the '''CommandRef'''. There you find detailed info about usage and options for all official modules and FHEM commands. Also this is the place where new functionality will be first documented directly by the module's author. The Commandref shall provide the necessary info about how to use
 * FHEM commands and options;
-* Device Modules wrt. definition, configuration and usage. Device Module typically means modules to integrate a piece of hardware;
+* Device modules wrt. definition, configuration and usage. Device module typically means modules to integrate a piece of hardware;
-* Helper Modules.
+* Helper modules.
-For all people contributing software to be officially distributed with FHEM (aka Module author) there is just one strict rule: They have to provide a commandref (in english) for the module and support it for the first tree months. So commandref is the most important source for information about each module.
+For all people contributing software to be officially distributed with FHEM (aka module author) there is just one strict rule: They have to provide a commandref (in english) for the module and support it for the first tree months. So commandref is the most important source for information about each module.
-'''TIPP:''' A lot of the Module Authors are not fluent in english, so in case you see room for improvement of the english version just provide a better version and contact the respective[https://www.fhem.de/MAINTAINER.txt maintainer] - he/she most likely will be happy.
+'''TIP:''' A lot of the module authors are not fluent in english, so in case you see room for improvement of the english version just provide a better version and contact the respective[https://www.fhem.de/MAINTAINER.txt maintainer] - he/she most likely will be happy about your contribution.
 ==FHEMWiki==
-The page you are currently reading is part of the FHEMWiki. The link at the top left leads you to the main page. This is a good place to start. We appologise about most articles are in german, feel free to add or translate content also in english for others! Many articles you find in the FHEMWiki are directly maintained by Module's authors, a lot of them have just been written by other users. So accuracy and actuality of the articles may vary.
+The page you are currently reading is part of the FHEMWiki. The link at the top left leads you to the main page. This is a good place to start. We apologize about most articles are in German, feel free to add or translate content also in English for others! Many articles you find in the FHEMWiki are directly maintained by module authors, a lot of them have just been written by other users. So accuracy and timeliness of the articles may vary.
-'''TIPP:''' There's a special [https://forum.fhem.de/index.php/board,80.0.html section in our forum] for proposals for improvement on the FHEMWiki.
+'''TIP:''' There's a special [https://forum.fhem.de/index.php/board,80.0.html section in our forum] for proposals for improvement on the FHEMWiki.
 ==[http://forum.fhem.de/ Forum]==
-Some Module Authors - especially of Modules not (yet) distributed as part of FHEM - prefer to provide further info about the usage of these modules in the forum. Helpfull info about the forum itself is provided in the [https://forum.fhem.de/index.php/board,18.0.html pinned Threads in Anfängerbereich], we appologize about them beeing mostly in german. Feel free to ask any question also in english - either in the english part of the forum or also in the regular section you find suitable for your specific interest. If you are able to read german, you may find a lot of usefull info by using the hints for doing forum searches in the mentionned pinned threads.
+Some module authors - especially of modules not (yet) distributed as part of FHEM - prefer to provide further info about the usage of these modules in the Forum. Helpful information about the Forum itself is provided in the [https://forum.fhem.de/index.php/board,18.0.html pinned Threads in Anfängerbereich], we apologize about them beeing mostly in German. Feel free to ask any question also in English - either in the English part of the Forum or also in the regular section you find suitable for your specific interest. If you are able to read german, you may find a lot of useful information by using the hints for doing forum searches in the mentioned pinned threads.
-'''TIPP:''' We like to challenge people about first having used the searching possibilities before asking, as most problems have been discussed before - there are about 20.000 users in the forum - so there waits (at least one) solution on most topics to be discovered! But we understand it's not easy to even know the right keywords for searching if you are not speaking german.
+'''TIP:''' We like to challenge people about first having used the searching possibilities before asking, as most problems have been discussed before - there are about 20.000 users in the forum - so there waits (at least one) solution on most topics to be discovered! But we understand it's not easy to even know the right keywords for searching if you are not speaking german.
-==Internet, Blogs usw.==
+==Foreign information sources==
-Information provided in other sources - especially blogs - you have to challenge yourself whether this is at the right level of actuality and quality. Keep in mind: Most of the respective bloggers aso. may follow their own agenda. This may be different to the FHEM community's.
+Information provided in other sources - especially blogs - have to be challenge yourself whether this is at the right level of timeliness and quality. Keep in mind: Most of the respective bloggers aso. may follow their own agenda. This may be different to the FHEM community's.
-'''TIPP:''' So it's highly recommended to first doublecheck that sort of information against the one provided by the community before asking questions on info sourced "elsewhere" in the forum.
+'''TIP:''' So it's highly recommended to first double check that sort of information against the one provided by the community before asking questions on info sourced "elsewhere" in the forum.
 [[Kategorie:Dokumentation]]