# Documental.xyz

🇬🇧 [Translate to English](https://docs-documental-xyz.translate.goog/?_x_tr_sl=pt&_x_tr_tl=en&_x_tr_hl=en) 

🇪🇸 [Traducir para español](https://docs-documental-xyz.translate.goog/?_x_tr_sl=pt&_x_tr_tl=es&_x_tr_hl=es)

[Documental.xyz](https://documental.xyz) é uma ferramenta para narrativas baseadas em mapas, que faz uso de recursos de *scrollytelling (interações a partir da rolagem de página)* para navegação em dados geográficos. Ela é baseada na integração de recursos do sistema de publicação [Statamic](https://statamic.com) com o serviço de mapas online [Mapbox](https://mapbox.com).

O Documental.xyz é um complemento (um "starter kit") do Statamic e está disponível em [código aberto](https://github.com/medialabufrj/documentalxyz). Por sua vez, o Statamic é um sistema gerenciador de conteúdo (CMS) baseado no [Laravel](https://laravel.com/), um *framework* da linguagem PHP. 

Confira abaixo um resumo do conteúdo de nossa documentação:

* [Configuração da plataforma](https://docs.documental.xyz/configuracao-da-plataforma): requisitos técnicos e passo a passo para instalação do Statamic;
* [Organizando os gedados no Mapbox](https://docs.documental.xyz/organizando-os-geodados-no-mapbox): breve tutorial sobre a organização dos dados geográficos no Mapbox e sua integração com o Statamic;
* [Publicando uma história:](https://docs.documental.xyz/publicando-uma-historia) breve tutorial sobre a inserção de histórias no Statamic e como chamar os geodados do Mapbox.
* [Técnicas de scrollytelling](https://docs.documental.xyz/tecnicas-de-scrollytelling): revisão de alternativas e tecnologias para construção de histórias com scrollytelling, para além do Documental;
* [Métodos de scrollytelling](https://docs.documental.xyz/metodos-de-scrollytelling): revisão de metodologias e estratégias para construção de narrativas de scrollytelling baseadas em mapas;
* [Como colaborar?](https://docs.documental.xyz/como-colaborar): lista de funcionalidades futuras desejáveis e informações para pessoas desenvolvedoras interessadas em colaborar com o projeto.
* [Referências e recursos](https://docs.documental.xyz/recursos-uteis): compilado parcial e inicial de materiais externos úteis.
* [Equipe](https://docs.documental.xyz/equipe): pessoas e organizações envolvidas com o Documental.

### Para quem esta documentação se destina?

Qualquer pessoa interessada pode ler a documentação sobre a ferramenta, porém, para implementar uma instância da plataforma "do zero" e publicar uma história usando os recursos do Documental, é recomendável que uma ou mais pessoas tenham conhecimentos técnicos sobre os seguintes temas:

* Noções básicas sobre a manipulação de dados geográficos;
* Configuração de servidores na web;
* Familiaridade com desenvolvimento para web e tecnologias de front-end (HTML, CSS, JavaScript);

### Preciso pagar?

O Statamic e o Mapbox adotam um modelo *freemium*, onde é possível usufruir de certas soluções com uma conta gratuita, mas é preciso assinar um serviço pago para obter recursos mais avançados. Utilizando tais recursos gratuitos ou de código aberto, qualquer pessoa pode também configurar uma instância simples da plataforma Documental.

O Documental é uma solução baseada em softwares de código aberto. Para rodar a plataforma em seu próprio computador, você pode instalar as versões gratuitas do Statamic e Mapbox, mas para publicar a plataforma em seu próprio site é necessário contratar um servidor. Na seção de [configuração da plataforma](https://docs.documental.xyz/configuracao-da-plataforma), é possível obter mais informações sobre os requisitos de hardware e software necessário.

As versões gratuitas do Statamic e Mapbox servem para a maioria dos casos.

| Características       | Statamic                                                                                                                          | Mapbox                                                                                                             |
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| Plano gratuito        | Limitado a 1 idioma e 1 usuário administrador.                                                                                    | Até 50 mil visualizações do mapa por mês.                                                                          |
| Valor do plano pago   | A partir de 259 dólares por projeto, com atualizações incluídas por um ano. Após o período, é cobrado 59 USD/ano por atualização. | Preços a partir de 50 dólares por mês ou sob demanda, a depender dos serviços utilizados ou quantidade de acessos. |
| Funcionalidades pagas | Suporte para desenvolvedores, usuários e perfis ilimitados, etc.                                                                  | Mais camadas, mais visualizações de mapas, suporte,etc.                                                            |

Para mais informações sobre os recursos pagos, confira as respectivas páginas do [Mapbox](https://www.mapbox.com/pricing) e [Statamic](https://statamic.com/pricing)

### Como creditar o projeto?

Solicitamos que projetos que façam uso da plataforma incluam a seguinte menção ao projeto, como forma de apoiar o desenvolvimento da plataforma:

`powered by Documental.xyz`

***