O backend é o *verdadeiro* plone. Escrito em python, tem como base o conjunto de bibliotecas `zope`.
## Backend
A documentação é sofrida e espalhada entre os sites do `plone` e as várias bibliotecas `zope`. Be afraid.
### ZCML
Boa parte da configuração do backend é através de arquivos *XML* com extensão *zcml*.
O arquivo `configure.zcml` do diretório base de cada addon é lido automaticamente. Outros arquivos `.zcml` do addon deve ser incluídos a partir deste, usando a diretiva `<include>`.
Algumas diretivas usadas:
|||
|---|---|
|`<include>`|Indica outro arquivo *zcml* a ser lido|
|`<genericsetup:registerProfile>`|Define um conjunto de *zcml* que vai ser executado quando o addon for instalado ou desinstalado|
|`<configlet>`|Cria um item de painel de controle.|
|`<browser:page>`|Define uma *"página"*. Até o momento, só sei que se usa para indicar o conteúdo de um item de painel de controle criado com `<configlet>`|
|`<records>`|Cria dados no *registry* do Plone. Por exemplo, dados referentes a um item customizado de painel de controle.|
|`<plone:service>`|Define um endpoint de api|
### Arquivos De Interesse
|||
|---|---|
|`instance.yaml`|Use para gerenciar addons|
|`mx.ini`|Use para incluir repositórios git externos ao monorepo na estrutura de diretórios|
### Apontando para repositório externo
### Receitas
#### Apontando para repositório externo
Ao desenvolver um addon reutilizável, o próprio costuma ter um repositório git separado. Para isto, usa-se o [mxdev](https://github.com/mxstack/mxdev).
Ao desenvolver um addon reutilizável, o próprio costuma ter um repositório git separado. Para isto, usa-se o [mxdev](https://github.com/mxstack/mxdev).
@ -28,7 +87,7 @@ Passos:
1. Configure o arquivo `backend/requirements.txt`, colocando o nome do add-on:
1. Configure o arquivo `backend/requirements.txt`, colocando o nome do add-on:
```interlegis.barra-acessibilidade-backend```
```interlegis.barra-acessibilidade-backend```
2. Configure o arquivo `backend/instance.yaml`:
2. Configure o arquivo `backend/instance.yaml`:
```
```
@ -45,13 +104,13 @@ Passos:
extras = test
extras = test
branch = feature-7
branch = feature-7
´´´
´´´
4. `make backend-build` na raiz do projeto para baixar o conteúdo do git.
4. `make backend-build` na raiz do projeto para baixar o conteúdo do git.
[docs, install an add-on from source](https://6.docs.plone.org/admin-guide/add-ons.html#install-an-add-on-from-source)
[docs, install an add-on from source](https://6.docs.plone.org/admin-guide/add-ons.html#install-an-add-on-from-source)
### Instalar Addon
#### Instalar Addon
1. Adicionar uma linha em `backend/requirements.txt` para o addon
1. Adicionar uma linha em `backend/requirements.txt` para o addon
[Docs, Control Panels (bem limitado)](https://6.docs.plone.org/backend/control-panels.html)
[Docs, Control Panels (bem limitado)](https://6.docs.plone.org/backend/control-panels.html)
### Criando um endpoint para ser usado no frontend
#### Criando um endpoint para ser usado no frontend
Passos, grosso modo. Veja os exemplos para ter uma ideia melhor.
????
1. Se já não existir, crie um diretório `restapi` dentro da raiz do backend. O nome não importa, mas `restapi` segue o padrão dos projetos que vi.
2. Use `<include>` no `configure.zcml` da raiz para incluir o diretório recém-criado.
3. Crie um arquivo `configure.zcml` dentro do diretório. Use a diretiva `<plone:service>` para criar o endpoint.
4. Crie um arquivo python, exemplo `get.py`, dentro do diretório. Lá deve ser implementada uma classe para devolver os dados desejados.
5. No caso de dados guardados em como string e que se deseja servir como json, pode ser necessário um serializer/deserializer. Ainda não sei como funcionam....
Projetos de exemplo:
Projetos de exemplo:
- [eea.banner](https://github.com/eea/eea.banner) (usado pelo volto-banner)
- [eea.banner](https://github.com/eea/eea.banner) (usado pelo volto-banner)
O frontend é chamado de Volto. Escrito em react/javascript, é feito para substituir o antigo frontend do plone (feito em python, direto no backend).
### Arquivos De Interesse
|||
|---|---|
|`package.json`|Use para gerenciar addons|
|`volto.config.js`|Também usado para gerenciar addons|
### Receitas
#### Apontando para repositório externo
Ao desenvolver um addon reutilizável, o próprio costuma ter um repositório git separado. Para isto, usa-se o [mrs developer](https://github.com/collective/mrs-developer).
Ao desenvolver um addon reutilizável, o próprio costuma ter um repositório git separado. Para isto, usa-se o [mrs developer](https://github.com/collective/mrs-developer).
@ -117,13 +196,13 @@ Passos:
]
]
}
}
```
```
2. Configure o arquivo `frontend/mrs.developer.json`:
2. Configure o arquivo `frontend/mrs.developer.json`:
- [Acrescentando o componente no `appExtras`](https://github.com/eea/volto-banner/blob/master/src/index.js)
- [Acrescentando o componente no `appExtras`](https://github.com/eea/volto-banner/blob/master/src/index.js)
- [Usando `react-portal` para posicionar](https://github.com/eea/volto-banner/blob/master/src/StagingBanner.jsx)
- [Usando `react-portal` para posicionar](https://github.com/eea/volto-banner/blob/master/src/StagingBanner.jsx)
### Definindo interface de painel de control no frontend
### Definindo interface de painel de controle no frontend
A criação de painel de controle normalmente é através de interface no backend e o Volto monta os controles necessários para a edição dos itens desta interface.
A criação de painel de controle normalmente é através de interface no backend e o Volto monta os controles necessários para a edição dos itens desta interface.
@ -199,4 +278,4 @@ Uma outra opção é definir no backend a interface como uma string (contendo um
