Skip to content

Commit

Permalink
Add drafts for extension docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pascalwengerter committed Jan 23, 2024
1 parent 30ca76c commit c80d5fa
Show file tree
Hide file tree
Showing 6 changed files with 130 additions and 0 deletions.
45 changes: 45 additions & 0 deletions docs/extension-system/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,48 @@ geekdocCollapseSection: true
{{< toc >}}

The ownCloud Web can be extended through various entry points with custom extensions.

## Concepts and building blocks

### Apps

- What is an app?
- basic building block of oC web
- need to get registered in config in order to get loaded by oC web runtime
- can register 0-n extensions (see below)

<!-- TODO: Add minimum viable app via ClassicApplicationScript/ApplicationInformation interface -->

### Extensions

- What is an extension?
- list of extension types
-
- extension points (extension.ts)
- was wird erweitert - Funktionalität
- Extensions werden an/in Extension Points eingebunden
- scopes - wo wird eine Extension verwendet? (e.g. wo wird eine `action` verwendet)
<!-- See if extension point/scope differentiation is still necessary after formulating text -->

- How do I create an extension => examples folder?


## Further information (digging deeper)

AKA "under the hood"

### Global Extension Registry

- What is Global Extension Registry?

### - What can / can't I do with an extension?



### js-package / commonjs-file

- current limitations

### extension-sdk

- Rename to application-sdk?
21 changes: 21 additions & 0 deletions docs/extension-system/extension-types/actions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: 'Action extensions'
date: 2023-11-26T00:00:00+00:00
weight: 60
geekdocRepo: https://github.com/owncloud/web
geekdocEditPath: edit/master/docs/extension-system/extension-types
geekdocFilePath: actions.md
geekdocCollapseSection: true
---

{{< toc >}}

One possible extension type is actions.


### 3. Actions
- E.g. contextmenu
- E.g. batch actions
- E.g. new action

<!-- TODO: Add link to next extension type doc page -->
16 changes: 16 additions & 0 deletions docs/extension-system/extension-types/file-editor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: 'File editor extensions'
date: 2023-11-26T00:00:00+00:00
weight: 60
geekdocRepo: https://github.com/owncloud/web
geekdocEditPath: edit/master/docs/extension-system/extension-types
geekdocFilePath: file-editor.md
geekdocCollapseSection: true
---

{{< toc >}}

One possible extension type is ___.

# Dokumentation der Verwendung der AppWrapper-Component
<!-- TODO: Add link to next extension type doc page -->
17 changes: 17 additions & 0 deletions docs/extension-system/extension-types/left-sidebar-menu-item.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: 'Left sidebar menu item extensions'
date: 2023-11-26T00:00:00+00:00
weight: 60
geekdocRepo: https://github.com/owncloud/web
geekdocEditPath: edit/master/docs/extension-system/extension-types
geekdocFilePath: left-sidebar-menu-item.md
geekdocCollapseSection: true
---

{{< toc >}}

One possible extension type is left sidebar menu items.

### 2. Left sidebar menu item
- How to add items
<!-- TODO: Add link to next extension type doc page -->
18 changes: 18 additions & 0 deletions docs/extension-system/extension-types/right-sidebar-panels.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: 'Right sidebar panel extensions'
date: 2023-11-26T00:00:00+00:00
weight: 60
geekdocRepo: https://github.com/owncloud/web
geekdocEditPath: edit/master/docs/extension-system/extension-types
geekdocFilePath: right-sidebar-panels.md
geekdocCollapseSection: true
---

{{< toc >}}

One possible extension type is right sidebar panels.

### 4. Global registration of right sidebar panels

- Makes them reusable in all other apps
<!-- TODO: Add link to next extension type doc page -->
13 changes: 13 additions & 0 deletions docs/extension-system/extension-types/search.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: 'Search extensions'
date: 2023-11-26T00:00:00+00:00
weight: 60
geekdocRepo: https://github.com/owncloud/web
geekdocEditPath: edit/master/docs/extension-system/extension-types
geekdocFilePath: search.md
geekdocCollapseSection: true
---

{{< toc >}}

One possible extension type is search.

0 comments on commit c80d5fa

Please sign in to comment.