|
| 1 | +# Guía de personalización de ckanext-gobar-theme |
| 2 | + |
| 3 | +Todo lo personalizable del theme se configura por **variables de entorno o |
| 4 | +claves del `ckan.ini`** — nunca editando templates ni código para un nodo |
| 5 | +puntual. Esto cumple el invariante de "redistribuible con mínima config" de |
| 6 | +Portal Andino V2: para adaptar un nodo alcanza con tocar el `.env`. |
| 7 | + |
| 8 | +Las variables de entorno siguen la convención de `envvars` (el plugin que |
| 9 | +CKAN ya usa en este stack): una clave `ckanext.gobar_theme.mi_clave` se |
| 10 | +setea como `CKANEXT__GOBAR_THEME__MI_CLAVE=valor` en el `.env` del |
| 11 | +despliegue. En desarrollo también se puede probar en caliente con |
| 12 | +`ckan config-tool /srv/app/ckan.ini 'ckanext.gobar_theme.mi_clave=valor'` |
| 13 | +seguido de un reload, pero eso no persiste si se recrea el contenedor — |
| 14 | +para dejarlo fijo, siempre por `.env`. |
| 15 | + |
| 16 | +## El perfil (`ckanext.gobar_theme.profile`) |
| 17 | + |
| 18 | +Switch central de identidad visual. Valores: `nacional` (default) | `apn` | |
| 19 | +`subnacional` | `base`. |
| 20 | + |
| 21 | +- **`nacional`**: identidad "Datos Abiertos" completa (navy + índigo + |
| 22 | + violeta, Montserrat, mosaico) — la del portal nacional datos.gob.ar. |
| 23 | + Ninguna de las variables de esta guía cambia su comportamiento salvo que |
| 24 | + se configuren explícitamente. |
| 25 | +- **`apn`**: organismos de la Administración Pública Nacional. Estética |
| 26 | + Poncho (navy + celeste, Lora en títulos) por defecto, y habilita todo lo |
| 27 | + personalizable de esta guía (título de una línea, subtítulo opcional, |
| 28 | + sección Recursos apagada, Acerca genérico, etc.) |
| 29 | +- **`subnacional`** y **`base`**: hoy se comportan igual que `nacional` |
| 30 | + (no tienen identidad propia definida todavía) — quedan reservados para |
| 31 | + cuando se diseñe esa variante. |
| 32 | + |
| 33 | +``` |
| 34 | +CKANEXT__GOBAR_THEME__PROFILE=apn |
| 35 | +``` |
| 36 | + |
| 37 | +## Colores e imagen de fondo |
| 38 | + |
| 39 | +Pisan el preset del perfil, sea cual sea. Vacíos por defecto (no cambian |
| 40 | +nada). |
| 41 | + |
| 42 | +| Variable | Efecto | |
| 43 | +|---|---| |
| 44 | +| `ckanext.gobar_theme.color_primary` | Color primario (navbar, botones, acentos) | |
| 45 | +| `ckanext.gobar_theme.color_primary_dark` | Variante oscura (hover) | |
| 46 | +| `ckanext.gobar_theme.color_accent` | Color de acento | |
| 47 | +| `ckanext.gobar_theme.hero_background_image` | URL de una imagen de fondo para el hero de la home (con un overlay claro automático para que el texto se siga leyendo) | |
| 48 | + |
| 49 | +``` |
| 50 | +CKANEXT__GOBAR_THEME__COLOR_PRIMARY=#232D4F |
| 51 | +CKANEXT__GOBAR_THEME__HERO_BACKGROUND_IMAGE=https://miorganismo.gob.ar/fondo.jpg |
| 52 | +``` |
| 53 | + |
| 54 | +## Título y subtítulo de la home (perfil `apn`) |
| 55 | + |
| 56 | +- El título del hero sale de `ckan.site_title` (config nativa de CKAN, no |
| 57 | + específica de este theme) en una sola línea, con la última palabra en el |
| 58 | + color de acento. |
| 59 | +- `ckanext.gobar_theme.subtitle`: frase opcional debajo del título. Vacío |
| 60 | + por defecto (no se muestra). Ejemplo (MAGyP): |
| 61 | + |
| 62 | +``` |
| 63 | +CKAN__SITE_TITLE=Datos Agro |
| 64 | +CKANEXT__GOBAR_THEME__SUBTITLE=En este portal podrás obtener datos numéricos y estadísticos del sector agropecuario y sus temas relacionados. Ingresá periódicamente y descubrí nuestros datos. |
| 65 | +``` |
| 66 | + |
| 67 | +## "Organizaciones" → otro nombre |
| 68 | + |
| 69 | +Algunos organismos APN son en rigor una Secretaría/Subsecretaría/Dirección |
| 70 | +dentro de un ministerio, no una "organización" independiente. El texto es |
| 71 | +configurable en los 5 lugares donde aparece (nav, footer, contador y título |
| 72 | +de sección de la home, faceta de búsqueda): |
| 73 | + |
| 74 | +``` |
| 75 | +CKANEXT__GOBAR_THEME__ORGANIZATIONS_LABEL=Organismos |
| 76 | +``` |
| 77 | + |
| 78 | +Default: `Organizaciones` (sin cambios si no se configura). |
| 79 | + |
| 80 | +## Footer: sección Institucional y logo de la Secretaría |
| 81 | + |
| 82 | +| Variable | Default | Efecto | |
| 83 | +|---|---|---| |
| 84 | +| `ckanext.gobar_theme.institutional_name` | vacío (`Dirección de Datos Abiertos` en perfiles ≠ apn) | Texto del link institucional del footer | |
| 85 | +| `ckanext.gobar_theme.institutional_url` | vacío (link a datos-abiertos en perfiles ≠ apn) | URL de ese link | |
| 86 | +| `ckanext.gobar_theme.show_secretariat_logo` | `true` | Mostrar/ocultar el logo institucional de la esquina inferior derecha del footer | |
| 87 | +| `ckanext.gobar_theme.secretariat_logo_url` | vacío (usa el logo de Secretaría de Innovación del theme) | URL de un logo propio | |
| 88 | +| `ckanext.gobar_theme.secretariat_logo_alt` | `Secretaría de Innovación, Ciencia y Tecnología` | Texto alternativo de ese logo | |
| 89 | + |
| 90 | +``` |
| 91 | +CKANEXT__GOBAR_THEME__INSTITUTIONAL_NAME=Ministerio de Agricultura, Ganadería y Pesca |
| 92 | +CKANEXT__GOBAR_THEME__INSTITUTIONAL_URL=https://www.magyp.gob.ar |
| 93 | +CKANEXT__GOBAR_THEME__SECRETARIAT_LOGO_URL=https://miorganismo.gob.ar/logo-blanco.png |
| 94 | +CKANEXT__GOBAR_THEME__SECRETARIAT_LOGO_ALT=Ministerio de Agricultura, Ganadería y Pesca |
| 95 | +``` |
| 96 | + |
| 97 | +## Sección /recursos (productos de la Dirección de Datos Abiertos) |
| 98 | + |
| 99 | +Es contenido específico del portal nacional (datos.gob.ar, Georef, Series |
| 100 | +de Tiempo...). `ckanext.gobar_theme.show_recursos`: `true` | `false` | |
| 101 | +`auto` (default). En `auto`, se muestra en todos los perfiles salvo `apn`. |
| 102 | +`true`/`false` fuerza el valor sin importar el perfil. |
| 103 | + |
| 104 | +``` |
| 105 | +CKANEXT__GOBAR_THEME__SHOW_RECURSOS=true |
| 106 | +``` |
| 107 | + |
| 108 | +## Otras variables existentes (no específicas de esta guía) |
| 109 | + |
| 110 | +- `ckanext.gobar_theme.contact_email` — destino del formulario de `/paginas/contacto`. |
| 111 | +- `ckanext.gobar_theme.featured_datasets_limit` — cantidad de datasets destacados en la home. |
| 112 | +- `ckanext.gobar_theme.spatial_map_max_results` — tope de resultados en el mapa espacial. |
| 113 | +- `ckanext.gobar_theme.show_api_docs` — muestra/oculta `/paginas/api-docs`. |
| 114 | + |
| 115 | +## Cómo agregar una nueva variable personalizable |
| 116 | + |
| 117 | +1. Declararla en `plugin.py` → `declare_config_options` (con su default, |
| 118 | + preservando el comportamiento actual de todos los perfiles). |
| 119 | +2. Exponer un helper en `helpers.py` (mejor un helper con nombre propio, |
| 120 | + p. ej. `gobar_mi_cosa()`, que un `gobar_get_config()` inline repetido en |
| 121 | + varios templates) y registrarlo en `get_helpers()`. |
| 122 | +3. Usarlo desde el/los templates que corresponda. |
| 123 | +4. Documentarla acá. |
0 commit comments