diff --git a/README.md b/README.md index 2eed5d9..1643dd6 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Por defecto, en la página inicial no se listan todas las publicaciones, sino qu Las configuraciones generales del sitio se declaran en el fichero `_config.yml`, y el fichero Gemfile indica las dependencias de [Ruby](https://www.ruby-lang.org/) que necesita el sitio. ## Funcionamiento -La web es actualizada cada 5 minutos usando un script en la [crontab](https://pubs.opengroup.org/onlinepubs/007908775/xcu/crontab.html) del usuario donde estáá instalado Jekyll. +La web es actualizada cada 5 minutos usando un script en la [crontab](https://pubs.opengroup.org/onlinepubs/007908775/xcu/crontab.html) del usuario donde está instalado Jekyll. El script actualiza la copia del repositorio local, descarga o instala las dependencias de Ruby correspondientes y genera compila el sitio desde los ficheros fuente. @@ -34,7 +34,7 @@ Estos son: * Ser respetuoso con otros individuos ### Categorías -Las categorías clasifican los artículos tema. +Las categorías clasifican las publicaciones por tema. Existen 4 categorías iniciales: * Noticias @@ -49,8 +49,6 @@ Adicionalmente, tras la creación de una categoría, es necesario añadir el lis ### Páginas Las páginas son los elementos estáticos con menos flexibilidad de la web. -Para su creación y redacción se necesita acuerdo previo con el resto del personas que participan en la redacción y su contenido suele mantenerse sin modificar durante bastante tiempo a excepción de las que listan publicaciones y la que representa el equipo de redacción. - #### Tipos Actualmente, el sitio web cuenta con 3 tipos de páginas, declaradas en base a las plantillas del tema: * Básico @@ -60,10 +58,12 @@ Actualmente, el sitio web cuenta con 3 tipos de páginas, declaradas en base a l La diferencia principal entre cada tipo radica en la declaración de sus cabeceras donde las básicas cuentan con un número limitado y permanente de atributos y las complejas lo varían. -El tipo "Inicio" está reservado para la página de inicio del sitio web mientras del resto se pueden crear tantos como se necesiten. +El tipo «Inicio» está reservado para la página de inicio del sitio web mientras del resto se pueden crear tantos como se necesiten. #### Redacción -Para la redacción de páginas nuevas es necesario tener en cuenta lo que hay que incluir en su cabecera y lo acordado para el contenido. +La creación y redacción de una página es determinado por acuerdo previo con el resto del personas que participan en la redacción. + +Para la redacción, es necesario tener en cuenta lo que hay que incluir en su cabecera y lo acordado para el contenido. ##### Cacebera Para explicar la estructura de la cabecera es necesario un ejemplo de una compleja utilizada en una página de archivo de categoría. @@ -77,7 +77,7 @@ title: Publicaciones de noticias --- ``` -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. +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. @@ -92,12 +92,30 @@ Los valores posibles son los siguientes: ###### lang Es el segundo atributo básico y el primero de los opcionales. Declara el idioma establecido para el contenido de la página. -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/). +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 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. + +Sus valores se corresponden con los mismos nombres de las categorías en inglés y en minúscula, quedando de la siguiente forma: +* `news` +* `promotions` +* `tutorials` +* `opinions` + +###### title +Es el tercer atributo básico y el segundo de los obligatorios. Declara el título de la página. ##### 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 + + #### Cabecera ##### Fecha La fecha debe seguir el formato %Y-%m-%d %H:%M:%S %z en cada publicación.