plugins-nextcloud-mirror/richdocuments
1
0
Fork 0
mirror of https://github.com/nextcloud/richdocuments.git synced 2025-12-18 05:20:43 +01:00
Code Projects Releases Activity

Start of template API

Browse source 
Signed-off-by: Roeland Jago Douma <roeland@famdouma.nl>
This commit is contained in:
Roeland Jago Douma 2018-09-06 20:52:28 +02:00
commit 6eefc956d9
No known key found for this signature in database
GPG key ID: F941078878347C0C
1 changed files with 84 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

84
docs/tempaltes.md Normal file
View file

@ -0,0 +1,84 @@
# Templates
Often users will use the same templates. This documents describes the flow and
API's that will eventually come into place.
## Template location
There are two kind of templates:
1. system wide templates
2. user defined tempaltes
Both should be simple template files and preview for them should be obtained using
the preview API. The richdocuments works as a preview provider so it should provide
proper previews to use.
### System wide templates
An admin can configure system wide templates. This can be done from the admin
settings.
These templates are stored in the AppData.
> Note: it might require some less pretty code to get the previews out of the
appdata. But since it will also work on 13 we have no real alternative.
There are a few special templates that are shipped with the app. The empty
files. They should always be available.
### User defined tempaltes
In the Collabora user settings the user can select a folder from where to load
templates. This can be any folder the user has access to. So users can share template
folders among eachother.
## API
### Listing templates
Send a GET to:
`<server>/ocs/v2.php/apps/richdocuemnts/api/v1/templates/<type>`
Here type can be:
* docuemnt
* spreadsheet
* presentation
This returns a list of templates with
* id
* name
* link to preview
* extention
### Template previews
Send a GET to:
`<server>/apps/richdocuemnts/templates/<id>`
Where `id` is the id of the template obtained in the listing. This returns back
an image (jpeg or png). For displaying.
### Creating document based on a template
Send a POST to
`<server>/ocs/v2.php/apps/richdocuemnts/api/v1/templates/new`
with:
* `path`: the full path relative to the user where to create the document
* `template`: the template id you want to create
## Web frontend
When clicking on a new document a selection popup appears listing the
available templates.
The user can select a template, possible change the name and create it.
This is similar to the current flow with the difference that the user can now
select a template.