diff --git a/Documentation.tmpl/Administrator/Index.rst b/Documentation.tmpl/Administrator/Index.rst deleted file mode 100644 index 10bc545..0000000 --- a/Documentation.tmpl/Administrator/Index.rst +++ /dev/null @@ -1,82 +0,0 @@ -.. ================================================== -.. FOR YOUR INFORMATION -.. -------------------------------------------------- -.. -*- coding: utf-8 -*- with BOM. - -.. include:: ../Includes.txt - - -.. _admin-manual: - -Administrator Manual -==================== - -Target group: **Administrators** - -Describes how to manage the extension from an administrator point of view. -That relates to Page/User TSconfig, permissions, configuration etc., -which administrator level users have access to. - -Language should be non / semi-technical, explaining, using small examples. - - -.. _admin-installation: - -Installation ------------- - -- How should the extension be installed? -- Are they dependencies to resolve? -- Is it a static template file to be included? - -To install the extension, perform the following steps: - -#. Go to the Extension Manager -#. Install the extension -#. Load the static template -#. ... - -For a list of configuration options, using a definition list is recommended: - -Some Configuration - This option enables... - -Other configuration - This other option is for all the rest... - - -.. figure:: ../Images/AdministratorManual/ExtensionManager.png - :alt: Extension Manager - - Extension Manager (caption of the image) - - List of extensions within the Extension Manager also shorten with "EM" (legend of the image) - - -.. _admin-configuration: - -Configuration -------------- - -* Where and how the extension should be configured? TypoScript? PHP? - -* Are there other prerequisite to full fill beforehand? - For example, configure a setting in a special way somewhere. - - -.. _admin-faq: - -FAQ ---- - -Possible subsection: FAQ - -Subsection -^^^^^^^^^^ - -Some subsection - -Sub-subsection -"""""""""""""" - -Deeper into the structure... diff --git a/Documentation.tmpl/Configuration/Index.rst b/Documentation.tmpl/Configuration/Index.rst deleted file mode 100644 index bb4a03a..0000000 --- a/Documentation.tmpl/Configuration/Index.rst +++ /dev/null @@ -1,104 +0,0 @@ -.. ================================================== -.. FOR YOUR INFORMATION -.. -------------------------------------------------- -.. -*- coding: utf-8 -*- with BOM. - -.. include:: ../Includes.txt - - -.. _configuration: - -Configuration Reference -======================= - -Technical information: Installation, Reference of TypoScript options, -configuration options on system level, how to extend it, the technical -details, how to debug it and so on. - -Language should be technical, assuming developer knowledge of TYPO3. -Small examples/visuals are always encouraged. - -Target group: **Developers** - - -.. _configuration-typoscript: - -TypoScript Reference --------------------- - -Possible subsections: Reference of TypoScript options. -The construct below show the recommended structure for -TypoScript properties listing and description. - -Properties should be listed in the order in which they -are executed by your extension, but the first should be -alphabetical for easier access. - -When detailing data types or standard TypoScript -features, don't hesitate to cross-link to the TypoScript -Reference as shown below. See the :file:`Settings.yml` -file for the declaration of cross-linking keys. - - -Properties -^^^^^^^^^^ - -.. container:: ts-properties - - =========================== ===================================== ======================= ==================== - Property Data type :ref:`t3tsref:stdwrap` Default - =========================== ===================================== ======================= ==================== - allWrap_ :ref:`t3tsref:data-type-wrap` yes :code:`
|
` - `subst\_elementUid`_ :ref:`t3tsref:data-type-boolean` no 0 - wrapItemAndSub_ :ref:`t3tsref:data-type-wrap` - =========================== ===================================== ======================= ==================== - - -Property details -^^^^^^^^^^^^^^^^ - -.. only:: html - - .. contents:: - :local: - :depth: 1 - - -.. _ts-plugin-tx-extensionkey-stdwrap: - -allWrap -""""""" - -:typoscript:`plugin.tx_extensionkey.allWrap =` :ref:`t3tsref:data-type-wrap` - -Wraps the whole item. - - -.. _ts-plugin-tx-extensionkey-wrapitemandsub: - -wrapItemAndSub -"""""""""""""" - -:typoscript:`plugin.tx_extensionkey.wrapItemAndSub =` :ref:`t3tsref:data-type-wrap` - -Wraps the whole item and any submenu concatenated to it. - - -.. _ts-plugin-tx-extensionkey-substelementUid: - -subst_elementUid -"""""""""""""""" - -:typoscript:`plugin.tx_extensionkey.subst_elementUid =` :ref:`t3tsref:data-type-boolean` - -If set, all appearances of the string ``{elementUid}`` in the total element html-code (after wrapped in allWrap_) -is substituted with the uid number of the menu item. This is useful if you want to insert an identification code -in the HTML in order to manipulate properties with JavaScript. - - -.. _configuration-faq: - -FAQ ---- - -Possible subsection: FAQ diff --git a/Documentation.tmpl/Developer/Index.rst b/Documentation.tmpl/Developer/Index.rst deleted file mode 100644 index fafeb17..0000000 --- a/Documentation.tmpl/Developer/Index.rst +++ /dev/null @@ -1,58 +0,0 @@ -.. ================================================== -.. FOR YOUR INFORMATION -.. -------------------------------------------------- -.. -*- coding: utf-8 -*- with BOM. - -.. include:: ../Includes.txt - - -.. _developer: - -Developer Corner -================ - -Target group: **Developers** - -Use this section for *providing code examples* or any **useful** information code wise. - - -.. _developer-hooks: - -Hooks ------ - -Possible hook examples. Input parameters are: - -+----------------+---------------+---------------------------------+ -| Parameter | Data type | Description | -+================+===============+=================================+ -| $table | string | Name of the table | -+----------------+---------------+---------------------------------+ -| $field | string | Name of the field | -+----------------+---------------+---------------------------------+ - -Use parameter :code:`$table` to retrieve the table name... - -.. _developer-api: - -API ---- - -How to use the API... - -.. code-block:: php - - $stuff = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('\\Foo\\Bar\\Utility\\Stuff'); - $stuff->do(); - -or some other language: - -.. code-block:: javascript - :linenos: - :emphasize-lines: 2-4 - - $(document).ready( - function () { - doStuff(); - } - ); diff --git a/Documentation.tmpl/Introduction/Index.rst b/Documentation.tmpl/Introduction/Index.rst deleted file mode 100644 index 9531bf4..0000000 --- a/Documentation.tmpl/Introduction/Index.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. ================================================== -.. FOR YOUR INFORMATION -.. -------------------------------------------------- -.. -*- coding: utf-8 -*- with BOM. - -.. include:: ../Includes.txt - - -.. _introduction: - -Introduction -============ - - -.. _what-it-does: - -What does it do? ----------------- - -This chapter should give a brief overview of the extension. What does it do? What problems does it solve? -Who is interested in this? Basically, this section includes everything people need to know to decide whether they -should go on with this extension or not. - - -.. _screenshots: - -Screenshots ------------ - -This chapter should help people figure how the extension works. Remove it -if not relevant. - -.. figure:: ../Images/IntroductionPackage.png - :width: 500px - :alt: Introduction Package - - Introduction Package just after installation (caption of the image) - - How the Frontend of the Introduction Package looks like just after installation (legend of the image) diff --git a/Documentation.tmpl/KnownProblems/Index.rst b/Documentation.tmpl/KnownProblems/Index.rst deleted file mode 100644 index dcb52d7..0000000 --- a/Documentation.tmpl/KnownProblems/Index.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. ================================================== -.. FOR YOUR INFORMATION -.. -------------------------------------------------- -.. -*- coding: utf-8 -*- with BOM. - -.. include:: ../Includes.txt - - -.. _known-problems: - -Known Problems -============== - -Say where bugs can be reported / followed up. Is it a -`bug tracker `_? -Use this section for informing about any type of of problem -that are not necessarily named in the bug tracker such as performance issues, ... diff --git a/Documentation.tmpl/Localization.de_DE.tmpl/Index.rst b/Documentation.tmpl/Localization.de_DE.tmpl/Index.rst deleted file mode 100644 index 0204145..0000000 --- a/Documentation.tmpl/Localization.de_DE.tmpl/Index.rst +++ /dev/null @@ -1,66 +0,0 @@ -.. ================================================== -.. FOR YOUR INFORMATION -.. -------------------------------------------------- -.. -*- coding: utf-8 -*- with BOM. - -.. include:: ../Includes.txt - - -.. _start: - -============================================================= -###PROJECT_NAME### (Deutsch) -============================================================= - -.. only:: html - - :Klassifikation: - extension_key - - :Version: - |release| - - :Sprache: - de - - :Beschreibung: - Geben Sie eine Beschreibung ein. - - :Schlüsselwörter: - komma-getrennte,Liste,von,Schlüsselwörtern - - :Copyright: - ###YEAR### - - :Autor: - ###AUTHOR### - - :E-Mail: - author@example.com - - :Lizenz: - Dieses Dokument wird unter der Open Content License, siehe - http://www.opencontent.org/opl.shtml veröffentlicht. - - :Gerendert: - |today| - - Der Inhalt dieses Dokuments bezieht sich auf TYPO3, - ein GNU/GPL CMS-Framework auf `www.typo3.org `_. - - - **Inhaltsverzeichnis** - -.. toctree:: - :maxdepth: 5 - :titlesonly: - :glob: - -.. Introduction/Index -.. UserManual/Index -.. AdministratorManual/Index -.. Configuration/Index -.. DeveloperCorner/Index -.. KnownProblems/Index -.. ToDoList/Index -.. ChangeLog/Index diff --git a/Documentation.tmpl/Localization.de_DE.tmpl/README b/Documentation.tmpl/Localization.de_DE.tmpl/README deleted file mode 100644 index c1517e6..0000000 --- a/Documentation.tmpl/Localization.de_DE.tmpl/README +++ /dev/null @@ -1,24 +0,0 @@ -How to translate -================ - -This directory contains the German translation of your documentation. -This is a complete Sphinx project but you may reuse assets from the -main documentation under Documentation/. - -If you plan to translate your documentation to German, you should -rename this directory and remove the suffix ".tmpl": - -Localization.de_DE.tmpl -> Localization.de_DE - -As this file is not needed either, feel free to delete it as well. - - -Supported languages -=================== - -Please visit http://sphinx-doc.org/latest/config.html#intl-options for a -list of languages supported by Sphinx. - -Please note however that TYPO3 is using locales so you may need to -extend the language code from Sphinx into a proper locale to be used -by TYPO3. diff --git a/Documentation.tmpl/Localization.de_DE.tmpl/Settings.yml b/Documentation.tmpl/Localization.de_DE.tmpl/Settings.yml deleted file mode 100644 index ebf993f..0000000 --- a/Documentation.tmpl/Localization.de_DE.tmpl/Settings.yml +++ /dev/null @@ -1,29 +0,0 @@ -# This is the project specific Settings.yml file. -# Place Sphinx specific build information here. -# Settings given here will replace the settings of 'conf.py'. - -# Below is an example of intersphinx mapping declaration -# Add more mappings depending on what manual you want to link to -# Remove entirely if you don't need cross-linking - ---- -conf.py: - copyright: 2012-2013 - project: Extension Name (Deutsch) - version: x.y - release: x.y.z - intersphinx_mapping: - t3tsref: - - http://docs.typo3.org/typo3cms/TyposcriptReference/ - - null - latex_documents: - - - Index - - .tex - - Extension Name (Français) - - Your Name - - manual - latex_elements: - papersize: a4paper - pointsize: 10pt - preamble: \usepackage{typo3} -... diff --git a/Documentation.tmpl/Localization.fr_FR.tmpl/Index.rst b/Documentation.tmpl/Localization.fr_FR.tmpl/Index.rst deleted file mode 100644 index b1b473d..0000000 --- a/Documentation.tmpl/Localization.fr_FR.tmpl/Index.rst +++ /dev/null @@ -1,66 +0,0 @@ -.. ================================================== -.. FOR YOUR INFORMATION -.. -------------------------------------------------- -.. -*- coding: utf-8 -*- with BOM. - -.. include:: ../Includes.txt - - -.. _start: - -============================================================= -###PROJECT_NAME### (Français) -============================================================= - -.. only:: html - - :Classification: - extension_key - - :Version: - |release| - - :Langue: - fr - - :Description: - entrez une description. - - :Mots-clés: - list,mots-clés,séparés,par,virgules - - :Copyright: - ###YEAR### - - :Auteur: - ###AUTHOR### - - :E-mail: - author@example.com - - :Licence: - Ce document est publié sous la licence de contenu libre - disponible sur http://www.opencontent.org/opl.shtml - - :Généré: - |today| - - Le contenu de ce document est en relation avec TYPO3, - un CMS/Framework GNU/GPL disponible sur `www.typo3.org `_. - - - **Sommaire** - -.. toctree:: - :maxdepth: 5 - :titlesonly: - :glob: - -.. Introduction/Index -.. UserManual/Index -.. AdministratorManual/Index -.. Configuration/Index -.. DeveloperCorner/Index -.. KnownProblems/Index -.. ToDoList/Index -.. ChangeLog/Index diff --git a/Documentation.tmpl/Localization.fr_FR.tmpl/README b/Documentation.tmpl/Localization.fr_FR.tmpl/README deleted file mode 100644 index 8436ec0..0000000 --- a/Documentation.tmpl/Localization.fr_FR.tmpl/README +++ /dev/null @@ -1,24 +0,0 @@ -How to translate -================ - -This directory contains the French translation of your documentation. -This is a complete Sphinx project but you may reuse assets from the -main documentation under Documentation/. - -If you plan to translate your documentation to French, you should -rename this directory and remove the suffix ".tmpl": - -Localization.fr_FR.tmpl -> Localization.fr_FR - -As this file is not needed either, feel free to delete it as well. - - -Supported languages -=================== - -Please visit http://sphinx-doc.org/latest/config.html#intl-options for a -list of languages supported by Sphinx. - -Please note however that TYPO3 is using locales so you may need to -extend the language code from Sphinx into a proper locale to be used -by TYPO3. diff --git a/Documentation.tmpl/Localization.fr_FR.tmpl/Settings.yml b/Documentation.tmpl/Localization.fr_FR.tmpl/Settings.yml deleted file mode 100644 index 82d74d0..0000000 --- a/Documentation.tmpl/Localization.fr_FR.tmpl/Settings.yml +++ /dev/null @@ -1,29 +0,0 @@ -# This is the project specific Settings.yml file. -# Place Sphinx specific build information here. -# Settings given here will replace the settings of 'conf.py'. - -# Below is an example of intersphinx mapping declaration -# Add more mappings depending on what manual you want to link to -# Remove entirely if you don't need cross-linking - ---- -conf.py: - copyright: 2012-2013 - project: Extension Name (Français) - version: x.y - release: x.y.z - intersphinx_mapping: - t3tsref: - - http://docs.typo3.org/typo3cms/TyposcriptReference/ - - null - latex_documents: - - - Index - - .tex - - Extension Name (Français) - - Your Name - - manual - latex_elements: - papersize: a4paper - pointsize: 10pt - preamble: \usepackage{typo3} -... diff --git a/Documentation.tmpl/Readme.rst b/Documentation.tmpl/Readme.rst deleted file mode 100644 index 0fbb6b1..0000000 --- a/Documentation.tmpl/Readme.rst +++ /dev/null @@ -1,24 +0,0 @@ -Extension Manual -================ - -This is a template manual aiming to help developers when it comes to documentation. -The template provides a structure that a developer can take over and, in addition, -many useful snippets and examples. Documentation is written in reST format. - -You manual may be comprised of the whole `Documentation` folder -or just of this README file. More information can be found in -`Core APIs`_. - -This example manual will show you - in particular - how to make links -across manuals or how to present a TypoScript reference. - -Any idea or suggestion for improving this template `can be dropped`_ to -the `Documentation Team`_. - -Remember: documentation is like gift wrapping, it may look superfluous, -but your friends tend to be rather disappointed when their presents -arrive in supermarket carrier bags. (Documentation-Driven Design quote) - -.. _Core APIs: http://docs.typo3.org/typo3cms/CoreApiReference/ExtensionArchitecture/Documentation/Index.html -.. _can be dropped: http://forge.typo3.org/projects/typo3cms-doc-official-extension-template/issues -.. _Documentation Team: http://forge.typo3.org/projects/typo3cms-doc-official-extension-template diff --git a/Documentation.tmpl/ToDoList/Index.rst b/Documentation.tmpl/ToDoList/Index.rst deleted file mode 100644 index 5cc010c..0000000 --- a/Documentation.tmpl/ToDoList/Index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. ================================================== -.. FOR YOUR INFORMATION -.. -------------------------------------------------- -.. -*- coding: utf-8 -*- with BOM. - -.. include:: ../Includes.txt - - -.. _todo: - -To-Do list -========== - -Give a link pointing to a `roadmap `_. -Alternatively, you can dress up a list of things you want to add or fix in this chapter -or give a vision about where the extension is heading. diff --git a/Documentation.tmpl/User/Index.rst b/Documentation.tmpl/User/Index.rst deleted file mode 100644 index 036869b..0000000 --- a/Documentation.tmpl/User/Index.rst +++ /dev/null @@ -1,67 +0,0 @@ -.. ================================================== -.. FOR YOUR INFORMATION -.. -------------------------------------------------- -.. -*- coding: utf-8 -*- with BOM. - -.. include:: ../Includes.txt - - -.. _user-manual: - -Users Manual -============ - -Target group: **Editors** - -Here should be described how to use the extension from the editor perspective. - -- How does it work? - - - works well when doing this. - - - does not work so well when doing that - but we can live with it. - - - **mind indentation when nesting lists**. - -- How to install the plugin on a web page? - -- What options are available? - -Language should be non-technical, explaining, using small examples. -Don't use to many acronyms unless they have been explained. -Don't be confusing by putting information targeting administrators. - -.. tip:: - - Take a break from time to time. - -Admonitions should be used to warn the users about potential -pitfalls, attract their attention to important elements -or just add some notes for for information (further reading, -for example). - -.. important:: - - Remember to always say "please" when asking your software to - do something. - -Provide screenshots as needed for making things clear. When creating -screenshots, try using the `Introduction Package `_ -as a neutral TYPO3 CMS instance. - -.. figure:: ../Images/UserManual/BackendView.png - :width: 500px - :alt: Backend view - - Default Backend view (caption of the image) - - The Backend view of TYPO3 after the user has clicked on module "Page". (legend of the image) - - -.. _user-faq: - -FAQ ---- - -Possible subsection: FAQ diff --git a/Documentation/Administrator/Index.rst b/Documentation/Administrator/Index.rst new file mode 100644 index 0000000..bde52a9 --- /dev/null +++ b/Documentation/Administrator/Index.rst @@ -0,0 +1,43 @@ +.. ================================================== +.. FOR YOUR INFORMATION +.. -------------------------------------------------- +.. -*- coding: utf-8 -*- with BOM. + +.. include:: ../Includes.txt + + +.. _admin-manual: + +Administrator Manual +==================== + +Target group: **Administrators** + +.. _admin-installation: + +Installation +------------ + +This extension does not have any major requirements + +- PHP 5.3-5.6 + +- TYPO3 CMS 6.2 (It is known to run with version 7.5, but this is unsupported) + +- TYPO3 should obviously be able to access the internet + +Just install it from the TER and continue on to the section "Configuration" + + +.. _admin-configuration: + +Configuration +------------- + +Some basic configuration needs to be done: + +- You need an AppID / API Key from `openweathermap.org`_. Enter this AppID in the extension configuration inside the extension manager. + +- Optionally change the cache lifetime in the extension configuration. + +.. _openweathermap.org: http://openweathermap.org/ diff --git a/Documentation.tmpl/ChangeLog/Index.rst b/Documentation/ChangeLog/Index.rst similarity index 61% rename from Documentation.tmpl/ChangeLog/Index.rst rename to Documentation/ChangeLog/Index.rst index 4972785..bf93dbd 100644 --- a/Documentation.tmpl/ChangeLog/Index.rst +++ b/Documentation/ChangeLog/Index.rst @@ -11,6 +11,14 @@ ChangeLog ========= -Providing a change log chapter is optional. You can also refer -users to the ChangeLog file inside the extension or to some repository's -commit listing. +0.0.2 +----- + +- Added documentation + + +0.0.1 +----- + +- First release +- OpenWeatherMap-PHP-Api version 2.0.9 diff --git a/Documentation/Developer/Index.rst b/Documentation/Developer/Index.rst new file mode 100644 index 0000000..ca2e44e --- /dev/null +++ b/Documentation/Developer/Index.rst @@ -0,0 +1,37 @@ +.. ================================================== +.. FOR YOUR INFORMATION +.. -------------------------------------------------- +.. -*- coding: utf-8 -*- with BOM. + +.. include:: ../Includes.txt + + +.. _developer: + +Developer Manual +================ + +.. _usage: + +Usage +----- + +Get an instance of the service and the actual API class: + +.. code-block:: php + + /** @var \RauchF\OpenweathermapPhpApiService\Service\OpenweathermapPhpApiService $owmService */ + $owmService = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstanceService('openweathermap_php_api'); + $owmApi = $owmService->getOpenweathermapPhpApi(); + +Now you can use any API method: + +.. code-block:: php + + $weatherData = $owmApi->getRawWeatherData( + $query, + 'metric', + 'en', + $owmService->getApiKey(), + 'json' + ); diff --git a/Documentation.tmpl/Images/AdministratorManual/ExtensionManager.png b/Documentation/Images/AdministratorManual/ExtensionManager.png similarity index 100% rename from Documentation.tmpl/Images/AdministratorManual/ExtensionManager.png rename to Documentation/Images/AdministratorManual/ExtensionManager.png diff --git a/Documentation.tmpl/Images/IntroductionPackage.png b/Documentation/Images/IntroductionPackage.png similarity index 100% rename from Documentation.tmpl/Images/IntroductionPackage.png rename to Documentation/Images/IntroductionPackage.png diff --git a/Documentation.tmpl/Images/UserManual/BackendView.png b/Documentation/Images/UserManual/BackendView.png similarity index 100% rename from Documentation.tmpl/Images/UserManual/BackendView.png rename to Documentation/Images/UserManual/BackendView.png diff --git a/Documentation.tmpl/Includes.txt b/Documentation/Includes.txt similarity index 100% rename from Documentation.tmpl/Includes.txt rename to Documentation/Includes.txt diff --git a/Documentation.tmpl/Index.rst b/Documentation/Index.rst similarity index 85% rename from Documentation.tmpl/Index.rst rename to Documentation/Index.rst index a4acfe2..b3fcef7 100644 --- a/Documentation.tmpl/Index.rst +++ b/Documentation/Index.rst @@ -14,7 +14,7 @@ OpenWeatherMap PHP API for TYPO3 .. only:: html :Classification: - openweathermap_php_api + openweathermap_php_api_service :Version: |release| @@ -23,9 +23,10 @@ OpenWeatherMap PHP API for TYPO3 en :Description: + A TYPO3 service extension to facilitate usage of cmfcmf/OpenWeatherMap-PHP-Api in your projects :Keywords: - comma,separated,list,of,keywords + service,api,openweathermap,library :Copyright: 2015 @@ -54,11 +55,8 @@ OpenWeatherMap PHP API for TYPO3 :glob: Introduction/Index - User/Index Administrator/Index - Configuration/Index Developer/Index KnownProblems/Index - ToDoList/Index ChangeLog/Index Targets diff --git a/Documentation/Introduction/Index.rst b/Documentation/Introduction/Index.rst new file mode 100644 index 0000000..05a9f71 --- /dev/null +++ b/Documentation/Introduction/Index.rst @@ -0,0 +1,26 @@ +.. ================================================== +.. FOR YOUR INFORMATION +.. -------------------------------------------------- +.. -*- coding: utf-8 -*- with BOM. + +.. include:: ../Includes.txt + + +.. _introduction: + +Introduction +============ + + +.. _what-it-does: + +What does it do? +---------------- + +This extension provides a wrapper for the library OpenWeatherMap-PHP-Api (`GitHub`_). + +It allows developers to use the library in their TYPO3 extension without much hassle. + +The library uses the TYPO3 caching framework and TYPO3's own methods to fetch URLs. + +.. _GitHub: https://github.com/cmfcmf/OpenWeatherMap-PHP-Api diff --git a/Documentation/KnownProblems/Index.rst b/Documentation/KnownProblems/Index.rst new file mode 100644 index 0000000..de4f7f4 --- /dev/null +++ b/Documentation/KnownProblems/Index.rst @@ -0,0 +1,18 @@ +.. ================================================== +.. FOR YOUR INFORMATION +.. -------------------------------------------------- +.. -*- coding: utf-8 -*- with BOM. + +.. include:: ../Includes.txt + + +.. _known-problems: + +Known Problems +============== + +None so far. + +Please report any bugs and issues you may encounter on `GitHub`_. + +.. _GitHub: https://github.com/RauchF/OpenWeatherMap-PHP-Api-Service/issues diff --git a/Documentation.tmpl/Settings.yml b/Documentation/Settings.yml similarity index 97% rename from Documentation.tmpl/Settings.yml rename to Documentation/Settings.yml index 0e79b74..0c2cb24 100644 --- a/Documentation.tmpl/Settings.yml +++ b/Documentation/Settings.yml @@ -10,7 +10,7 @@ conf.py: copyright: 2015 project: OpenWeatherMap PHP API for TYPO3 - version: + version: 0.0.2 release: intersphinx_mapping: t3tsref: diff --git a/Documentation.tmpl/Targets.rst b/Documentation/Targets.rst similarity index 100% rename from Documentation.tmpl/Targets.rst rename to Documentation/Targets.rst diff --git a/README.md b/README.md index e69de29..cdc8344 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,80 @@ +# OpenWeatherMap-PHP-Api-Service (EXT:openweathermap\_php\_api\_service) + +This extension provides a wrapper for the library OpenWeatherMap-PHP-Api [(GitHub)](https://github.com/cmfcmf/OpenWeatherMap-PHP-Api). + +It allows developers to use the library in their TYPO3 extension without much hassle. + +The library uses the TYPO3 caching framework and TYPO3’s own methods to fetch URLs. + +## Requirements + +This extension does not have any major requirements + +- PHP 5.3-5.6 +- TYPO3 CMS 6.2 (It is known to run with version 7.5, but this is unsupported) +- TYPO3 should obviously be able to access the internet + +## Installation + +Just install the extension from the TER or manually. + +## Configuration + +Some basic configuration needs to be done: + +- You need an AppID / API Key from [openweathermap.org](http://openweathermap.org/). Enter this AppID in the extension configuration inside the extension manager. +- Optionally change the cache lifetime in the extension configuration. + +## Usage + +Get an instance of the service and the actual API class: +```php + /** @var \RauchF\OpenweathermapPhpApiService\Service\OpenweathermapPhpApiService $owmService */ + $owmService = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstanceService('openweathermap_php_api'); + $owmApi = $owmService->getOpenweathermapPhpApi(); +``` + +Now you can use any API method: + +```php + $weatherData = $owmApi->getRawWeatherData( + $query, + 'metric', + 'en', + $owmService->getApiKey(), + 'json' + ); +``` + +## Issues / Contributing + +Please report any bugs and issues you may encounter on [GitHub](https://github.com/RauchF/OpenWeatherMap-PHP-Api-Service/issues). + +## Licenses + +The source code and usage are covered under the following licenses: + +### OpenWeatherMap-PHP-Api-Service for TYPO3 +(c) 2015 Felix Rauch + +This product is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 3 of the License, or +(at your option) any later version. + +The GNU General Public License can be found at +http://www.gnu.org/copyleft/gpl.html. + +### OpenWeatherMap-PHP-Api + +Copyright (c) 2013 Christian Flach + +MIT — Please see the LICENSE file distributed with the source code +for further information regarding copyright and licensing. + +### OpenWeatherMap +Please check out the following links to read about the usage policies +and the license of OpenWeatherMap before using the service. +- http://www.OpenWeatherMap.org +- http://www.OpenWeatherMap.org/terms +- http://www.OpenWeatherMap.org/appid \ No newline at end of file diff --git a/composer.json b/composer.json index 087285b..66e7f13 100644 --- a/composer.json +++ b/composer.json @@ -13,5 +13,5 @@ "type": "typo3-cms-extension", "keywords": ["TYPO3 CMS"], "license": "", - "version": "0.0.1" + "version": "0.0.2" } diff --git a/ext_emconf.php b/ext_emconf.php index 33d7cc2..10fded1 100644 --- a/ext_emconf.php +++ b/ext_emconf.php @@ -2,7 +2,7 @@ $EM_CONF[$_EXTKEY] = array( 'title' => 'OpenWeatherMap PHP API for TYPO3', - 'description' => '', + 'description' => 'A TYPO3 service extension to facilitate usage of cmfcmf/OpenWeatherMap-PHP-Api in your projects', 'category' => 'services', 'author' => 'Felix Rauch', 'author_email' => 'rauch@skaiamail.de', @@ -11,7 +11,7 @@ 'uploadfolder' => '0', 'createDirs' => '', 'clearCacheOnLoad' => 0, - 'version' => '0.0.1', + 'version' => '0.0.2', 'constraints' => array( 'depends' => array( 'typo3' => '6.2.0-6.2.99', @@ -21,4 +21,4 @@ 'suggests' => array( ), ), -); \ No newline at end of file +); diff --git a/ext_icon.gif b/ext_icon.gif deleted file mode 100644 index 1a832d4..0000000 Binary files a/ext_icon.gif and /dev/null differ diff --git a/ext_icon.png b/ext_icon.png new file mode 100644 index 0000000..e55981b Binary files /dev/null and b/ext_icon.png differ