move ocs to core dev, highlight deprecated info.xml entries

This commit is contained in:
Bernhard Posselt
2014-05-11 12:10:33 +02:00
parent 4a013ada2c
commit c1f992d77a
3 changed files with 153 additions and 2 deletions

View File

@@ -1,3 +1,4 @@
============
App Metadata
============
@@ -12,21 +13,36 @@ The :file:`appinfo/info.xml` contains metadata about the app:
<id>yourappname</id>
<name>Your App</name>
<description>Your App description</description>
<version>0.0.1</version>
<version>1.0</version>
<licence>AGPL</licence>
<author>Your Name</author>
<require>7</require>
<require>5</require>
<types>
<type>filesystem</type>
</types>
<documentation>
<user>http://doc.owncloud.org</user>
<admin>http://doc.owncloud.org</admin>
</documentation>
<website>http://www.owncloud.org</website>
<!-- deprecated -->
<public>
<file id="caldav">appinfo/caldav.php</file>
</public>
<remote>
<file id="caldav">appinfo/caldav.php</file>
</remote>
<standalone />
<default_enable />
<shipped>true</shipped>
</info>
id
@@ -82,3 +98,41 @@ website
-------
link to project webpage
Depcrecated
===========
The following sections are just listed for reference and should not be use because
* **public/remote**: Use :doc:`api` instead because you'll have to use :doc:`../core/externalapi` which is known to be buggy (works only properly with GET/POST)
* **standalone/default_enable**: They tell core what do on setup, you will not be able to even activate your app if it has those entries. This should be replaced by a config file inside core.
public
------
Used to provide a public interface (requires no login) for the app. The id is appended to the URL **/owncloud/index.php/public**. Example with id set to 'calendar'::
/owncloud/index.php/public/calendar
Also take a look at :doc:`../core/externalapi`.
remote
------
Same as public but requires login. The id is appended to the URL **/owncloud/index.php/remote**. Example with id set to 'calendar'::
/owncloud/index.php/remote/calendar
Also take a look at :doc:`../core/externalapi`.
standalone
----------
Can be set to true to indicate that this app is a webapp. This can be used to tell GNOME Web for instance to treat this like a native application.
default_enable
--------------
**Core apps only**: Used to tell ownCloud to enable them after the installation.
shipped
-------
**Core apps only**: Used to tell ownCloud that the app is in the standard release.
Please note that if this attribute is set to *FALSE* or not set at all, every time you disable the application, all the files of the application itself will be *REMOVED* from the server!