microCMS

History

…
..
bloque_imagen_texto.png
bloque_imagen.png
bloque_texto.png
ejemplo_articulo.png
README.md

README.md

Normas y Formatos de Publicación

Un resumen de cómo tienes que preparar tus artículos para que puedan ser publicados

Formato de los artículos e imágenes

Todos los artículos deben de venir en texto plano .txt
Se admiten imágenes en formato .png, .jpg o .gif.
Intenta que no sean demasiado grandes para que se carguen más rápido.

Completa la autoría del artículo con tu Nombre y Apellidos

Si has usado alguna fuente externa incluyelo como Bibliografía al final de tu artículo.

Numeración de los textos e imágenes

El CMS interno (fichero PHP) utiliza unicamente ficheros de texto e imágenes que estén numerados, esto se ha diseñado así para que la publicación y orden de las imágenes y textos a la hora de crear y generar las páginas html al vuelo sea rápida y sencila.
Se utiliza una nomenclatura especial para renderizar y mostrar el html final que se muestra en la web.
De forma general, numera todos los ficheros con 3 digitos, más un punto y la extensión del tipo de fichero para que sean procesados. Todos los ficheros van numerados del 000 al 999.

Ficheros con formato de nomenclatura y extensión obligatoria

000.txt: Contiene en su primera línea el título del artículo. En su segunda línea debe de aparecer una pequeña y breve descripción del artículo. Solo puede contener 2 líneas de texto.
000.png: Obligatoriamente debe ser un PNG. Es la imagen que aparecerá como referencia al artículo. Debe de tener un tamaño de 253×182 píxeles o un tamaño proporcional.

Ficheros del Contenido del Artículo

Para elaborar el resto del artículo, las imágenes y los textos van numerados del 001 al 999.

El formato admitido para las imágenes es .png, .jpg y .gif
Para los textos, solo se admite texto plano en un fichero .txt

El formato de estos ficheros es: NNN..ext

En donde:

*NNN*: Tres dígitos del 001 al 999.
*<descripción>*: Su uso es opcional. Pero aporta claridad a la hora de revisar los artículos.
*ext*: Extensión del fichero (.jpg, .png, .gif o .txt)

El CMS de Solo Con Linux genera la salida en formato HTML organizado por bloques, por simplificación del código sólo existen tres tipos de bloques en la generación del contenido web, aunque suficientes para generar un contenido web sencillo y elegante.

Tipos de Bloques en los artículos

Bloque de Imagen

Sigue el formato NNN..ext No puede existir ningun otro fichero con la misma numeración que él.

Bloque de Texto

Sigue el formato NNN..ext El contenido es texto plano y admite acentos y símbolos especiales. El texto siempre se muestra justificado.

Los saltos de línea se fuerzan con
o el símbolo · (punto medio), que está sobre la tecla · 3 No puede existir ningun otro fichero con la misma numeración que él.

Bloque de Imagen con Texto Se compone de 2 ficheros que tienen que tener la misma numeracion y descripción. Ambos ficheros usarán el formato de nombre de fichero: NNN..ext No puede existir un tercer fichero con la misma numeración.

Formatos HTML especiales en los ficheros TXT

Los ficheros de texto .txt admiten el uso de etiquetas html dentro de ellos y son compatibles con Bootstrap 4.

Etiquetas html permitidas:

    <b> ...</b>: Poner texto en negrita
    <i> ...</i>: Poner texto en cursiva/itálica
    <code> ...</code>: Resaltar texto, aparece en color rojo
    <kbd> ...</kbd>: Simular una Tecla del teclado
    <span class="text-info"> ...</span>: Poner un color Bootstrap 4 a un texto
    <small> ...</small>: Poner texto en un tamaño menor
    <pre> ...</pre>: Muestra el texto tal y como se escribe, util para poner código o comandos Linux.

Caracteres Especiales

Algunos caracteres especiales de HTML pueden no ser interpretados correctamente. Si ocurre esto simplemente reemplaza ese caracter por su codificación html.

Ejemplo:

    <  El símbolo de menor se escribe como &lt;
    >  El símbolo de mayor se escribe como &gt;

Si quieres forzar varios espacios, puedes usar   tantas veces como espacios desees incorporar.

Ejemplo del Contenido de un Artículo

Te muestro un ejemplo de los ficheros que pueder usar a la hora de elaborar tu artículo para que sean correctamente leidos por el CMS de Solo Con Linux.

Imágenes y Archivos de Texto

Debes de seguir unas normas a la hora de numerar o etiquetar los ficheros para que el CMS pueda gestionar correctamente las publicaciones y generar las página web al vuelo:

.				    ───> Directorio de tu artículo o pagina a mostrar
├── 000.png			    ───> Obligatorio: Nombre y extensión fija (000.png). Resolución: 253×182 píxeles 
├── 000.txt			    ───> Obligatorio: Nombre y extensión fija (000.txt). 2 líneas: Titulo + Descripción breve
│
├── 001.introduccion.jpg	    ─┬─> BLOQUE DE IMAGEN + TEXTO. Ambos ficheros (2) con la misma numeración y descripción.	
├── 001.introduccion.txt	    ─┘   Imagen en formato .jpg, .png o .gif  El fichero en formato de texto plano .txt
│
├── 002.captura_aplicacion.png 	    ───> BLOQUE SOLO IMAGEN. Solo puede existir un fichero de imagen con esa numeración.
│
├── 003.descripcion_instalacion.txt ───> BLOQUE SOLO TEXTO. Sólo puede existir un fichero .txt con esa numeración
│
├── 005.txt			    ───> BLOQUE SOLO TEXTO. También se puede usar sin completar la 'descripción'. 
│
├── 006.autor.jpg		    ─┬─> BLOQUE DE IMAGEN + TEXTO. Con igual numeración y Descripción.
└── 006.autor.txt		    ─┘

Ejemplo de visualización del artículo:

Titulo y Descripción: Linea 1: Título del artículo - Línea 2: Descripción breve
Bloque de Imagen + Texto: Dos ficheros. Una imagen con extension .png, .jpg ó .gif y un fichero de texto plano con extensión .txt
Bloque de Imagen: Un único fichero con extension .png, .jpg ó .gif
Bloque de Texto: Un único fichero en texto plano .txt

README.md Unescape Escape