📝 Homogeneiza README y documentación de crates
This commit is contained in:
parent
15a96a8310
commit
3fba1ca875
13 changed files with 460 additions and 49 deletions
19
README.md
19
README.md
|
|
@ -101,6 +101,10 @@ El código se organiza en un *workspace* donde actualmente se incluyen los sigui
|
||||||
|
|
||||||
### Extensiones
|
### Extensiones
|
||||||
|
|
||||||
|
* **[pagetop-admin](https://git.cillero.es/manuelcillero/pagetop/src/branch/main/extensions/pagetop-admin)**,
|
||||||
|
panel de administración extensible, al que cada extensión añade sus secciones, páginas y
|
||||||
|
formularios de configuración.
|
||||||
|
|
||||||
* **[pagetop-aliner](https://git.cillero.es/manuelcillero/pagetop/src/branch/main/extensions/pagetop-aliner)**,
|
* **[pagetop-aliner](https://git.cillero.es/manuelcillero/pagetop/src/branch/main/extensions/pagetop-aliner)**,
|
||||||
es un tema para demos y pruebas que muestra esquemáticamente la composición de las páginas HTML.
|
es un tema para demos y pruebas que muestra esquemáticamente la composición de las páginas HTML.
|
||||||
|
|
||||||
|
|
@ -108,9 +112,24 @@ El código se organiza en un *workspace* donde actualmente se incluyen los sigui
|
||||||
tema basado en [Bootstrap](https://getbootstrap.com) para integrar su catálogo de estilos y
|
tema basado en [Bootstrap](https://getbootstrap.com) para integrar su catálogo de estilos y
|
||||||
componentes flexibles.
|
componentes flexibles.
|
||||||
|
|
||||||
|
* **[pagetop-cron](https://git.cillero.es/manuelcillero/pagetop/src/branch/main/extensions/pagetop-cron)**,
|
||||||
|
programa trabajos periódicos con expresiones cron o intervalos, y los ejecuta también bajo
|
||||||
|
demanda.
|
||||||
|
|
||||||
|
* **[pagetop-htmx](https://git.cillero.es/manuelcillero/pagetop/src/branch/main/extensions/pagetop-htmx)**,
|
||||||
|
integra [HTMX](https://htmx.org) para enriquecer las páginas con interacciones dinámicas sin
|
||||||
|
escribir JavaScript.
|
||||||
|
|
||||||
|
* **[pagetop-mail](https://git.cillero.es/manuelcillero/pagetop/src/branch/main/extensions/pagetop-mail)**,
|
||||||
|
envía correo electrónico por SMTP o *sendmail*, con plantillas traducidas, HTML y archivos
|
||||||
|
adjuntos.
|
||||||
|
|
||||||
* **[pagetop-seaorm](https://git.cillero.es/manuelcillero/pagetop/src/branch/main/extensions/pagetop-seaorm)**,
|
* **[pagetop-seaorm](https://git.cillero.es/manuelcillero/pagetop/src/branch/main/extensions/pagetop-seaorm)**,
|
||||||
integra [SeaORM](https://www.sea-ql.org/SeaORM) para acceder a bases de datos relacionales.
|
integra [SeaORM](https://www.sea-ql.org/SeaORM) para acceder a bases de datos relacionales.
|
||||||
|
|
||||||
|
* **[pagetop-user](https://git.cillero.es/manuelcillero/pagetop/src/branch/main/extensions/pagetop-user)**,
|
||||||
|
gestiona usuarios, autenticación, roles y permisos, con su administración en `pagetop-admin`.
|
||||||
|
|
||||||
## Pruebas
|
## Pruebas
|
||||||
|
|
||||||
Para simplificar el flujo de trabajo, el repositorio incluye varios **alias de Cargo** declarados en
|
Para simplificar el flujo de trabajo, el repositorio incluye varios **alias de Cargo** declarados en
|
||||||
|
|
|
||||||
201
extensions/pagetop-admin/LICENSE-APACHE
Normal file
201
extensions/pagetop-admin/LICENSE-APACHE
Normal file
|
|
@ -0,0 +1,201 @@
|
||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following
|
||||||
|
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||||
|
replaced with your own identifying information. (Don't include
|
||||||
|
the brackets!) The text should be enclosed in the appropriate
|
||||||
|
comment syntax for the file format. We also recommend that a
|
||||||
|
file or class name and description of purpose be included on the
|
||||||
|
same "printed page" as the copyright notice for easier
|
||||||
|
identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright 2026 Manuel Cillero
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
21
extensions/pagetop-admin/LICENSE-MIT
Normal file
21
extensions/pagetop-admin/LICENSE-MIT
Normal file
|
|
@ -0,0 +1,21 @@
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2026 Manuel Cillero
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
132
extensions/pagetop-admin/README.md
Normal file
132
extensions/pagetop-admin/README.md
Normal file
|
|
@ -0,0 +1,132 @@
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
|
<h1>PageTop Admin</h1>
|
||||||
|
|
||||||
|
<p>Panel de administración extensible para <strong>PageTop</strong>.</p>
|
||||||
|
|
||||||
|
[](https://docs.rs/pagetop-admin)
|
||||||
|
[](https://crates.io/crates/pagetop-admin)
|
||||||
|
[](https://crates.io/crates/pagetop-admin)
|
||||||
|
[](https://git.cillero.es/manuelcillero/pagetop/src/branch/main/extensions/pagetop-admin#licencia)
|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Añade a una aplicación PageTop un panel de administración en `/admin` que cada extensión amplía con
|
||||||
|
sus propias secciones, páginas, pestañas y botones, declarados con acciones. Trae las secciones
|
||||||
|
habituales (personas, estructura, configuración, informes y ayuda), formularios de configuración
|
||||||
|
que se guardan en la base de datos y un menú de navegación hecho sólo con componentes del núcleo,
|
||||||
|
para que funcione con cualquier tema.
|
||||||
|
|
||||||
|
## Sobre PageTop
|
||||||
|
|
||||||
|
[PageTop](https://docs.rs/pagetop) es un entorno de desarrollo que reivindica la esencia de la web
|
||||||
|
clásica para crear soluciones web SSR (*renderizadas en el servidor*) modulares, extensibles y
|
||||||
|
configurables, basadas en HTML, CSS y JavaScript.
|
||||||
|
|
||||||
|
## Guía rápida
|
||||||
|
|
||||||
|
**Añade la dependencia** a tu `Cargo.toml`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[dependencies]
|
||||||
|
pagetop-admin = "..."
|
||||||
|
```
|
||||||
|
|
||||||
|
La configuración se guarda con `pagetop-seaorm`: la aplicación elige el motor de base de datos con
|
||||||
|
su *feature* (`postgres`, `mysql` o `sqlite`) y configura la conexión en la sección `[database]`.
|
||||||
|
|
||||||
|
**Declara la extensión** como dependencia de la tuya (`&pagetop_admin::Admin`) y **añade al panel**
|
||||||
|
tus secciones, páginas o formularios de configuración:
|
||||||
|
|
||||||
|
```rust,no_run
|
||||||
|
use pagetop::prelude::*;
|
||||||
|
use pagetop_admin::prelude::*;
|
||||||
|
use pagetop_admin::settings::{SettingField, SettingsSchema};
|
||||||
|
|
||||||
|
pub struct MyApp;
|
||||||
|
|
||||||
|
#[async_trait]
|
||||||
|
impl Extension for MyApp {
|
||||||
|
fn dependencies(&self) -> Vec<ExtensionRef> {
|
||||||
|
vec![&pagetop_admin::Admin]
|
||||||
|
}
|
||||||
|
|
||||||
|
fn actions(&self) -> Vec<ActionBox> {
|
||||||
|
actions![
|
||||||
|
DeclareAdminPages::new(declare_pages),
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
fn configure_router(&self, router: Router) -> Router {
|
||||||
|
router.route("/admin/config/myapp", web::get(config_handler))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn declare_pages(bag: &mut PageBag) {
|
||||||
|
bag.add(AdminPage {
|
||||||
|
path: "/admin/config/myapp".to_owned(),
|
||||||
|
section: "config".to_owned(),
|
||||||
|
title: Lc::n("My App"),
|
||||||
|
description: Some(Lc::n("Configure My App.")),
|
||||||
|
weight: 0,
|
||||||
|
permission: &MyPermission::Config,
|
||||||
|
kind: AdminPageKind::View,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Copy, Debug)]
|
||||||
|
enum MyPermission {
|
||||||
|
Config,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Permission for MyPermission {
|
||||||
|
fn key(&self) -> CowStr {
|
||||||
|
match self {
|
||||||
|
Self::Config => "myapp:config".into(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn config_handler(request: HttpRequest) -> Result<Markup, ErrorPage> {
|
||||||
|
let schema = SettingsSchema::new("myapp.config")
|
||||||
|
.with_field(SettingField::text("site_name", "Site name").with_required(true));
|
||||||
|
|
||||||
|
let title = "My App configuration";
|
||||||
|
let mut form = ConfigForm::with_schema(schema);
|
||||||
|
let mut cx = Context::new(request.clone());
|
||||||
|
let content = form.render(&mut cx).await;
|
||||||
|
|
||||||
|
Page::admin(request)
|
||||||
|
.with_title(Lc::n(title))
|
||||||
|
.with_child(
|
||||||
|
AdminFrame::new()
|
||||||
|
.with_title(Lc::n(title))
|
||||||
|
.with_child(Html::with(move |_| content.clone())),
|
||||||
|
)
|
||||||
|
.render()
|
||||||
|
.await
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Para formularios de configuración enteramente automáticos (GET y POST gestionados por
|
||||||
|
`pagetop-admin`), usa `AdminPageKind::ConfigForm(schema)` en lugar de `View` y no registres la ruta
|
||||||
|
tú mismo.
|
||||||
|
|
||||||
|
## Advertencia
|
||||||
|
|
||||||
|
**PageTop** es un proyecto personal para aprender [Rust](https://www.rust-lang.org/es) y conocer su
|
||||||
|
ecosistema. Su API está sujeta a cambios frecuentes. No se recomienda su uso en producción, al menos
|
||||||
|
hasta que se libere la versión **1.0.0**.
|
||||||
|
|
||||||
|
## Licencia
|
||||||
|
|
||||||
|
El código está disponible bajo una doble licencia:
|
||||||
|
|
||||||
|
* **Licencia MIT**
|
||||||
|
([LICENSE-MIT](LICENSE-MIT) o también https://opensource.org/licenses/MIT)
|
||||||
|
|
||||||
|
* **Licencia Apache, Versión 2.0**
|
||||||
|
([LICENSE-APACHE](LICENSE-APACHE) o también https://www.apache.org/licenses/LICENSE-2.0)
|
||||||
|
|
||||||
|
Puedes elegir la licencia que prefieras. Este enfoque de doble licencia es el estándar de facto en
|
||||||
|
el ecosistema Rust.
|
||||||
|
|
@ -5,19 +5,39 @@
|
||||||
|
|
||||||
<p>Panel de administración extensible para <strong>PageTop</strong>.</p>
|
<p>Panel de administración extensible para <strong>PageTop</strong>.</p>
|
||||||
|
|
||||||
|
[](https://docs.rs/pagetop-admin)
|
||||||
|
[](https://crates.io/crates/pagetop-admin)
|
||||||
|
[](https://crates.io/crates/pagetop-admin)
|
||||||
|
[](https://git.cillero.es/manuelcillero/pagetop/src/branch/main/extensions/pagetop-admin#licencia)
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
Añade a una aplicación PageTop un panel de administración en `/admin` que cada extensión amplía con
|
||||||
|
sus propias secciones, páginas, pestañas y botones, declarados con acciones. Trae las secciones
|
||||||
|
habituales (personas, estructura, configuración, informes y ayuda), formularios de configuración
|
||||||
|
que se guardan en la base de datos y un menú de navegación hecho sólo con componentes del núcleo,
|
||||||
|
para que funcione con cualquier tema.
|
||||||
|
|
||||||
|
## Sobre PageTop
|
||||||
|
|
||||||
|
[PageTop](https://docs.rs/pagetop) es un entorno de desarrollo que reivindica la esencia de la web
|
||||||
|
clásica para crear soluciones web SSR (*renderizadas en el servidor*) modulares, extensibles y
|
||||||
|
configurables, basadas en HTML, CSS y JavaScript.
|
||||||
|
|
||||||
## Guía rápida
|
## Guía rápida
|
||||||
|
|
||||||
Declara la dependencia en tu `Cargo.toml`:
|
**Añade la dependencia** a tu `Cargo.toml`:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[dependencies]
|
[dependencies]
|
||||||
pagetop-admin = "..."
|
pagetop-admin = "..."
|
||||||
```
|
```
|
||||||
|
|
||||||
Añade `&pagetop_admin::Admin` a las dependencias de tu extensión y declara tus
|
La configuración se guarda con `pagetop-seaorm`: la aplicación elige el motor de base de datos con
|
||||||
secciones, páginas o configuración:
|
su *feature* (`postgres`, `mysql` o `sqlite`) y configura la conexión en la sección `[database]`.
|
||||||
|
|
||||||
|
**Declara la extensión** como dependencia de la tuya (`&pagetop_admin::Admin`) y **añade al panel**
|
||||||
|
tus secciones, páginas o formularios de configuración:
|
||||||
|
|
||||||
```rust,no_run
|
```rust,no_run
|
||||||
use pagetop::prelude::*;
|
use pagetop::prelude::*;
|
||||||
|
|
@ -89,9 +109,9 @@ async fn config_handler(request: HttpRequest) -> Result<Markup, ErrorPage> {
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Para formularios de configuración enteramente automáticos (GET y POST gestionados
|
Para formularios de configuración enteramente automáticos (GET y POST gestionados por
|
||||||
por `pagetop-admin`), usa `AdminPageKind::ConfigForm(schema)` en lugar de `View` y
|
`pagetop-admin`), usa `AdminPageKind::ConfigForm(schema)` en lugar de `View` y no registres la ruta
|
||||||
no registres la ruta tú mismo.
|
tú mismo.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
use pagetop::prelude::*;
|
use pagetop::prelude::*;
|
||||||
|
|
|
||||||
|
|
@ -75,12 +75,12 @@ async fn homepage(request: HttpRequest) -> Result<Markup, ErrorPage> {
|
||||||
|
|
||||||
## Plantillas
|
## Plantillas
|
||||||
|
|
||||||
Bootsier maqueta las dos plantillas de PageTop (`CoreTemplates`) con la misma cabecera, contenido
|
Bootsier maqueta las dos plantillas de PageTop (`CoreTemplates`) con las mismas regiones (cabecera,
|
||||||
y pie: `Standard`, la plantilla por defecto de cualquier página; y `Admin`, que se activa creando
|
lateral, contenido y pie): `Standard`, la plantilla por defecto de cualquier página; y `Admin`, que
|
||||||
la página con `Page::admin()` en lugar de `Page::new()`. Ambas se maquetan igual hoy -- la
|
se activa creando la página con `Page::admin()` en lugar de `Page::new()`. Ambas se maquetan igual
|
||||||
distinción entre página "normal" y de administración no vive en el maquetado, sino en qué
|
hoy -- la distinción entre página "normal" y de administración no vive en el maquetado, sino en qué
|
||||||
extensión registra contenido en cada región y para qué plantilla se autolimita (por ejemplo, el
|
extensión registra contenido en cada región y para qué plantilla se autolimita (por ejemplo, el menú
|
||||||
menú de `pagetop-admin`, ver más abajo).
|
de `pagetop-admin`, ver más abajo).
|
||||||
|
|
||||||
```rust,no_run
|
```rust,no_run
|
||||||
use pagetop::prelude::*;
|
use pagetop::prelude::*;
|
||||||
|
|
@ -91,7 +91,7 @@ async fn about(request: HttpRequest) -> Result<Markup, ErrorPage> {
|
||||||
h1 { "Sobre nosotros" }
|
h1 { "Sobre nosotros" }
|
||||||
p { "Texto de presentación." }
|
p { "Texto de presentación." }
|
||||||
}))
|
}))
|
||||||
.render()
|
.render().await
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -125,6 +125,11 @@ Este *crate* integra la biblioteca de estilos [Bootstrap 5.3.8](https://getboots
|
||||||
definir el comportamiento, la apariencia y los componentes de la interfaz. Bootstrap se distribuye
|
definir el comportamiento, la apariencia y los componentes de la interfaz. Bootstrap se distribuye
|
||||||
bajo licencia [MIT](https://github.com/twbs/bootstrap/blob/main/LICENSE).
|
bajo licencia [MIT](https://github.com/twbs/bootstrap/blob/main/LICENSE).
|
||||||
|
|
||||||
|
Los iconos son los de [Bootstrap Icons 1.13.1](https://icons.getbootstrap.com/), bajo licencia
|
||||||
|
[MIT](https://github.com/twbs/icons/blob/main/LICENSE), y la tipografía es
|
||||||
|
[Source Sans 3](https://github.com/adobe-fonts/source-sans), de Adobe, bajo licencia
|
||||||
|
[SIL Open Font License 1.1](https://github.com/adobe-fonts/source-sans/blob/release/LICENSE.md).
|
||||||
|
|
||||||
## Advertencia
|
## Advertencia
|
||||||
|
|
||||||
**PageTop** es un proyecto personal para aprender [Rust](https://www.rust-lang.org/es) y conocer su
|
**PageTop** es un proyecto personal para aprender [Rust](https://www.rust-lang.org/es) y conocer su
|
||||||
|
|
|
||||||
|
|
@ -73,6 +73,52 @@ async fn homepage(request: HttpRequest) -> Result<Markup, ErrorPage> {
|
||||||
.render().await
|
.render().await
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Plantillas
|
||||||
|
|
||||||
|
Bootsier maqueta las dos plantillas de PageTop (`CoreTemplates`) con las mismas regiones (cabecera,
|
||||||
|
lateral, contenido y pie): `Standard`, la plantilla por defecto de cualquier página; y `Admin`, que
|
||||||
|
se activa creando la página con `Page::admin()` en lugar de `Page::new()`. Ambas se maquetan igual
|
||||||
|
hoy -- la distinción entre página "normal" y de administración no vive en el maquetado, sino en qué
|
||||||
|
extensión registra contenido en cada región y para qué plantilla se autolimita (por ejemplo, el menú
|
||||||
|
de `pagetop-admin`, ver más abajo).
|
||||||
|
|
||||||
|
```rust,no_run
|
||||||
|
use pagetop::prelude::*;
|
||||||
|
|
||||||
|
async fn about(request: HttpRequest) -> Result<Markup, ErrorPage> {
|
||||||
|
Page::new(request)
|
||||||
|
.with_child(Html::with(|_| html! {
|
||||||
|
h1 { "Sobre nosotros" }
|
||||||
|
p { "Texto de presentación." }
|
||||||
|
}))
|
||||||
|
.render().await
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Menú de administración
|
||||||
|
|
||||||
|
`pagetop-admin` (si está presente en la aplicación) registra su propio menú de secciones y
|
||||||
|
páginas en `CoreRegions::Aside`, autolimitado a páginas con la plantilla `Admin` -- no requiere
|
||||||
|
ningún registro por parte de Bootsier. Se construye con `Navbar`/`Nav`/`Dropdown`, los mismos
|
||||||
|
componentes disponibles para cualquier página de la aplicación.
|
||||||
|
|
||||||
|
## Selector de modo de color
|
||||||
|
|
||||||
|
`bs::theme_toggle()` crea un ítem de menú con el selector de modo de color (claro / oscuro /
|
||||||
|
automático), pensado para añadirse a cualquier `Nav` de la aplicación, no sólo a las páginas de
|
||||||
|
administración:
|
||||||
|
|
||||||
|
```rust,no_run
|
||||||
|
use pagetop::prelude::*;
|
||||||
|
use pagetop_bootsier::theme::*;
|
||||||
|
|
||||||
|
let navbar = bs::Navbar::simple().with_item(bs::navbar::Item::nav(
|
||||||
|
bs::Nav::new()
|
||||||
|
.with_item(bs::nav::Item::link(Lc::n("Home"), "/"))
|
||||||
|
.with_item(bs::theme_toggle()),
|
||||||
|
));
|
||||||
|
```
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#![doc(
|
#![doc(
|
||||||
|
|
|
||||||
|
|
@ -319,12 +319,6 @@ Para mantenerse sencilla, la extensión no guarda nada fuera de la memoria:
|
||||||
|
|
||||||
[`Application::run()`]: pagetop::app::Application::run
|
[`Application::run()`]: pagetop::app::Application::run
|
||||||
[`Application::test()`]: pagetop::app::Application::test
|
[`Application::test()`]: pagetop::app::Application::test
|
||||||
|
|
||||||
## Créditos
|
|
||||||
|
|
||||||
Las expresiones cron se interpretan con [croner](https://github.com/hexagon/croner-rust), la misma
|
|
||||||
biblioteca que usa *tokio-cron-scheduler*, distribuida bajo licencia
|
|
||||||
[MIT](https://github.com/hexagon/croner-rust/blob/master/LICENSE).
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#![doc(
|
#![doc(
|
||||||
|
|
|
||||||
|
|
@ -169,7 +169,8 @@ de otras extensiones, registrando la acción `RenderMailLayout`.
|
||||||
|
|
||||||
Con `previews = true` en `[mail]` (sólo en desarrollo), `/mail/preview` lista los correos que las
|
Con `previews = true` en `[mail]` (sólo en desarrollo), `/mail/preview` lista los correos que las
|
||||||
extensiones declaran con la acción `DeclareMailPreviews`, y muestra cada uno con datos de ejemplo:
|
extensiones declaran con la acción `DeclareMailPreviews`, y muestra cada uno con datos de ejemplo:
|
||||||
cabeceras, HTML con el diseño común, texto plano y adjuntos, sin enviar nada.
|
cabeceras, HTML con el diseño común, texto plano y adjuntos, sin enviar nada. Ver el módulo
|
||||||
|
`preview`.
|
||||||
|
|
||||||
## Texto plano automático
|
## Texto plano automático
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -146,7 +146,7 @@ del nombre. Con [`Attachment::with_content_id()`] se incrusta en el HTML, que lo
|
||||||
```rust,no_run
|
```rust,no_run
|
||||||
# use pagetop::prelude::*;
|
# use pagetop::prelude::*;
|
||||||
# use pagetop_mail::prelude::*;
|
# use pagetop_mail::prelude::*;
|
||||||
# async fn example(png: Vec<u8>) -> Result<(), MailError> {
|
# async fn report(png: Vec<u8>) -> Result<(), MailError> {
|
||||||
Email::new()
|
Email::new()
|
||||||
.with_to("ana@example.com")
|
.with_to("ana@example.com")
|
||||||
.with_subject("Informe")
|
.with_subject("Informe")
|
||||||
|
|
|
||||||
|
|
@ -17,17 +17,6 @@
|
||||||
[PageTop](https://docs.rs/pagetop) es un entorno de desarrollo que reivindica la esencia de la web
|
[PageTop](https://docs.rs/pagetop) es un entorno de desarrollo que reivindica la esencia de la web
|
||||||
clásica para crear soluciones web SSR (*renderizadas en el servidor*) modulares, extensibles y
|
clásica para crear soluciones web SSR (*renderizadas en el servidor*) modulares, extensibles y
|
||||||
configurables, basadas en HTML, CSS y JavaScript.
|
configurables, basadas en HTML, CSS y JavaScript.
|
||||||
|
|
||||||
## Créditos
|
|
||||||
|
|
||||||
Este *crate* incluye entre sus macros una adaptación de
|
|
||||||
[maud-macros](https://crates.io/crates/maud_macros)
|
|
||||||
([0.27.0](https://github.com/lambda-fairy/maud/tree/v0.27.0/maud_macros)) de
|
|
||||||
[Chris Wong](https://crates.io/users/lambda-fairy) y una versión renombrada de
|
|
||||||
[SmartDefault](https://crates.io/crates/smart_default) (0.7.1) de
|
|
||||||
[Jane Doe](https://crates.io/users/jane-doe), llamada `AutoDefault`. Estas macros eliminan la
|
|
||||||
necesidad de referenciar `maud` o `smart_default` en las dependencias del archivo `Cargo.toml` de
|
|
||||||
cada proyecto PageTop.
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
# de [David Tolnay](https://crates.io/users/dtolnay).
|
|
||||||
|
|
||||||
La macro para generar identificadores dinámicos **`paste!`** se reexporta del *crate*
|
|
||||||
[pastey](https://crates.io/crates/pastey), una implementación avanzada y soportada del popular
|
|
||||||
`paste!` de [David Tolnay](https://crates.io/users/dtolnay).
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
# (versión
|
|
||||||
[0.2.5](https://github.com/static-files-rs/static-files/tree/v0.2.5)) desarrollado por
|
|
||||||
[Alexander Korolev](https://crates.io/users/kilork), bajo licencia MIT/Apache 2.0. La implementación
|
|
||||||
se integra en PageTop para evitar que cada proyecto tenga que declarar `static-files` manualmente
|
|
||||||
como dependencia en su `Cargo.toml`.
|
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#![doc(test(no_crate_inject))]
|
#![doc(test(no_crate_inject))]
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue