Finalizado readme

This commit is contained in:
Echedelle López Romero 2021-01-07 22:30:18 +00:00
parent 0ef212a543
commit 877659712a

View file

@ -89,9 +89,9 @@ Su valor es el mismo que lleva el atributo `lang` asociado a la etiqueta `HTML`
Posee el valor por defecto `en` por lo que, aunque no es obligatorio, es necesario establecer el atributo en la creación de cada página para indicar que está en español.
###### which_category
Es un atributo complejo y opcional para las páginas de archivos. Declara la categoría de las publicaciones a listar en la misma.
Es el primer y único atributo complejo y el segundo de los opcionales, específico para las páginas de archivos. Declara la categoría de las publicaciones a listar en la misma.
Sus valores se corresponden con los mismos nombres de las categorías en inglés y en minúscula, quedando de la siguiente forma:
Su valor se corresponde con los mismos nombres de las categorías en inglés y en minúscula, quedando de la siguiente forma:
* `news`
* `promotions`
* `tutorials`
@ -100,13 +100,17 @@ Sus valores se corresponden con los mismos nombres de las categorías en inglés
###### title
Es el tercer atributo básico y el segundo de los obligatorios. Declara el título de la página.
Es necesario que el título tenga una relación directa con la página y contenga una o dos palabras indicando su contenido.
##### Contenido
El contenido de las páginas suele mantenerse sin modificar durante bastante tiempo a excepción de las que listan publicaciones, que lo realiza de forma automática, y la que representa el equipo de redacción.
Como se ha indicado anteriormente, debe estar en Markdown.
### Publicaciones
Las páginas son los elementos estáticos con mayor flexibilidad del sitio web.
Las publicaciones son los elementos estáticos con mayor flexibilidad del sitio web.
Son, elementalmente, un tipo de páginas complejas con una serie de atributos específicos.
#### Categorías
Las categorías clasifican las publicaciones por tema.
@ -127,25 +131,67 @@ La creación y redacción de una publicación es determinado por cualquier perso
Para la redacción, es necesario tener en cuenta el formato del fichero que representa cada publicación, lo que hay que incluir en su cabecera y cumplir los objetivos al elaborar el contenido. Por otro lado, la persona o personas encargadas de redactar el artículo deberán añadirse en el fichero de redacción junto con una descripción propia como introducción.
##### Fichero
Las publicaciones se crean como ficheros sueltos con extensión `.md` en el directorio `_posts`. Sus nombres deberán incluir la fecha en el formato `AAAA-MM-DD` seguido con un guión (`-`) con su nombre en minúscula usando caracteres ASCII.
Las publicaciones se crean como ficheros sueltos con extensión `.md` en el directorio `_posts`. Sus nombres deberán incluir la fecha en el formato `AAAA-mm-dd` seguido con un guión (`-`) y, finalmente, el título de la publicación en minúscula usando caracteres ASCII.
##### Cabecera
Para explicar la estructura de la cabecera es necesario un ejemplo de una compleja utilizada en una publicación de prueba.
```
---
layout: archive
layout: post
lang: es
which_category: news
title: Publicaciones de noticias
title: "Welcome to Jekyll!"
date: 2021-01-03 13:31:05 -0800
categories: news
---
```
Cada uno de los elementos previos a los dos puntos, entre el bloque de tres guiones (`---`), es un atributo de la cabecera, junto a su correspondiente valor a la derecha de los dos puntos.
###### layout
Es el primer atributo básico y obligatorio de toda cabecera. Declara el tipo de página.
Su valor, para indicar que es una publicación, debe ser `post`.
###### lang
Es el segundo atributo básico y el primero de los opcionales. Declara el idioma establecido para el contenido de la publicación.
Su valor es el mismo que lleva el atributo `lang` asociado a la etiqueta `HTML` al crear páginas en [HTML](https://www.w3.org/html/).
Posee el valor por defecto `en` por lo que, aunque no es obligatorio, es necesario establecer el atributo en la creación de cada publicación para indicar que está en español.
###### title
Es el tercer atributo básico y el segundo de los obligatorios. Declara el título de la publicación.
Es necesario que el título tenga una relación directa con la publicación, contenga varias palabras, indique algo de su contenido y además intente ser llamativo.
###### date
La fecha debe seguir el formato `%Y-%m-%d %H:%M:%S %z` en cada publicación.
Es el primer atributo complejo y el tercero de los obligatorios. Declara la fecha de la publicación.
Una buena forma de obtenerla es especificándola como entrada al programa `date` de la siguiente forma.
La fecha debe seguir el formato `AAAA-mm-dd HH:MM:SS DIFERENCIA-HORARIA` en cada publicación.
`date +"%Y-%m-%d %H:%M:%S %z"`
Una buena forma de obtenerla es especificándola como entrada al programa `date` de la siguiente forma:
```
date +"%Y-%m-%d %H:%M:%S %z"
```
###### categories
Es el segundo atributo complejo y el segundo de los opcionales. Declara la categoría de la publicación.
Su valor se corresponde con los mismos nombres de las categorías en inglés y en minúscula, quedando de la siguiente forma:
* `news`
* `promotions`
* `tutorials`
* `opinions`
Como sugiere el nombre, este atributo soporta especificar más de una categoría pero en este sitio web solo utilizaremos una por artículo en caso de así decidirlo.
## Problemas
Aquí listan los problemas pendientes en la página junto a sus posibles soluciones.
### Nombres en la lista de publicaciones
El problema consiste en que, en la lista de publicaciones en la página principal, los nombres de las publicaciones aparecen en minúscula.
La razón de la existencia de este problema es que la persona que desarrolló el tema que usamos en el sitio web, indicó en la plantilla que los títulos cambiasen su capitalización a minúsculas al ser listados.
La solución propuesta, de forma temporal, ha sido re-escribir dicha plantilla sin dicha transformación y situarla en el directorio `_includes/` con el mismo nombre de la plantilla original, `post_list.html`.