README

Clases para simplificar la generación de archivos TeX.

Instalación

Composer

Este proyecto usa como gestor de dependencias Composer el cual puede ser instalado siguiendo las instrucciones especificadas en la documentación oficial del proyecto.

Para instalar el paquete jf/tex usando este manejador de paquetes se debe ejecutar:

composer require jf/tex

Dependencias

Cuando el proyecto es instalado, adicionalmente se instalan las siguientes dependencias:

Paquete	Versión
jf/base	^4.0

Control de versiones

Este proyecto puede ser instalado usando git. Primero se debe clonar el proyecto y luego instalar las dependencias:

git clone git@gitlab.com:jfphp/jfTex.git
cd jfTex
composer install

Archivos disponibles

Clases

Nombre	Descripción
jf\Tex\ABase	Clase base para el resto de clases del proyecto.
jf\Tex\Arguments	Gestiona los argumentos de una macro.
jf\Tex\Builder	Clase para construir diversos elementos.
jf\Tex\Document	Gestiona un archivo con formato `TeX`.
jf\Tex\Environment\Axis	Genera un gráfico usando el paquete `tikz`.
jf\Tex\Environment\Center	Centra el contenido.
jf\Tex\Environment\Environment	Bloque de macros.
jf\Tex\Environment\FlushLeft	Alineado a la izquierda.
jf\Tex\Environment\FlushRight	Alineado a la derecha.
jf\Tex\Environment\FootnoteSize	Tamaño de fuente (normal - 2).
jf\Tex\Environment\Huge	Tamaño de fuente (normal + 4).
jf\Tex\Environment\Huge2	Tamaño de fuente (normal + 5).
jf\Tex\Environment\Large	Tamaño de fuente (normal + 1).
jf\Tex\Environment\Large2	Tamaño de fuente (normal + 2).
jf\Tex\Environment\Large3	Tamaño de fuente (normal + 3).
jf\Tex\Environment\MiniPage	Páginas de tamaño reducido.
jf\Tex\Environment\NormalSize	Tamaño de fuente normal.
jf\Tex\Environment\PgfPlots	Genera un gráfico usando el paquete `pgfplots`.
jf\Tex\Environment\Quote	Entorno para citas.
jf\Tex\Environment\Scope	Ámbito Tikz.
jf\Tex\Environment\ScriptSize	Tamaño de fuente (normal - 3).
jf\Tex\Environment\Small	Tamaño de fuente (normal - 1).
jf\Tex\Environment\Spacing	Cambio de espacio entre líneas.
jf\Tex\Environment\Tabular	Bloque de macros.
jf\Tex\Environment\TikzPicture	Genera un gráfico usando el paquete `tikz`.
jf\Tex\Environment\Tiny	Tamaño de fuente (normal - 4).
jf\Tex\Environment\Verbatim	Entorno para contenido textual.
jf\Tex\Generator\Config\Plugin\Environments	Agrega de manera masiva el listado de entornos simples.
jf\Tex\Generator\Config\Plugin\Lists	Agrega de manera masiva el listado de entornos para listas simples.
jf\Tex\Generator\Config\Plugin\Macros	Agrega de manera masiva el listado de macros simples.
jf\Tex\Latex	Elemento que implementa la interfaz `ILatex`.
jf\Tex\List\AList	Genera una lista de elementos.
jf\Tex\List\Description	Listado de descripciones.
jf\Tex\List\Enumerate	Enumeración de elementos.
jf\Tex\List\Itemize	Listado de elementos.
jf\Tex\Macro\BfSeries	Fuente gruesa.
jf\Tex\Macro\Color	Color a usar para el texto.
jf\Tex\Macro\Colors	Gestiona los colores de un documento LaTeX.
jf\Tex\Macro\Counter	Define un contador.
jf\Tex\Macro\Def	Define una macro.
jf\Tex\Macro\DocumentClass	Macro para definir la clase del documento.
jf\Tex\Macro\Fill	Relleno horizontal.
jf\Tex\Macro\FontSize	Asigna el tamaño de la fuenta.
jf\Tex\Macro\FootnoteSize	Tamaño de fuente (normal - 2).
jf\Tex\Macro\Hfill	Relleno horizontal.
jf\Tex\Macro\Hline	Línea horizontal.
jf\Tex\Macro\Hspace	Deja un espacio horizontal.
jf\Tex\Macro\Huge	Tamaño de fuente (normal + 4).
jf\Tex\Macro\Huge2	Tamaño de fuente (normal + 5).
jf\Tex\Macro\IncludeGraphics	Gestiona la inclusión de imágenes.
jf\Tex\Macro\Item	Elemento de una lista.
jf\Tex\Macro\Large	Tamaño de fuente (normal + 1).
jf\Tex\Macro\Large2	Tamaño de fuente (normal + 2).
jf\Tex\Macro\Large3	Tamaño de fuente (normal + 3).
jf\Tex\Macro\Macro	Representa una macro que forma parte de una sección o que puede insertarse directamente en el documento.
jf\Tex\Macro\MdSeries	Fuente mediana.
jf\Tex\Macro\MultiColumn	Celda que ocupa varias columnas.
jf\Tex\Macro\MultiRow	Celda que ocupa varias filas.
jf\Tex\Macro\NewCommand	Crea un comando nuevo.
jf\Tex\Macro\NewPage	Empieza una página nueva.
jf\Tex\Macro\Node	Nodo Tikz.
jf\Tex\Macro\NormalSize	Tamaño de fuente normal.
jf\Tex\Macro\RaiseBox	Eleva el tamaño especificado una caja de texto.
jf\Tex\Macro\RelSize	Aumenta o disminuye el tamaño de la fuente.
jf\Tex\Macro\RenewCommand	Renueva un comando ya existente.
jf\Tex\Macro\RmFamily	Fuente tipo `Roman`.
jf\Tex\Macro\ScriptSize	Tamaño de fuente (normal - 3).
jf\Tex\Macro\SelectFont	Selecciona la fuente a usar.
jf\Tex\Macro\SetLength	Asigna el valor de una longitud.
jf\Tex\Macro\SfFamily	Fuente tipo `Sans Serif`.
jf\Tex\Macro\ShortStack	Apila verticalmente los elementos.
jf\Tex\Macro\Small	Tamaño de fuente (normal - 1).
jf\Tex\Macro\Strut	Evita que el elemento ocupe espacio horizontal.
jf\Tex\Macro\TextBf	Texto en negritas.
jf\Tex\Macro\TextMd	Texto normal.
jf\Tex\Macro\TextSc	Texto en versalitas.
jf\Tex\Macro\TextSl	Texto inclinado.
jf\Tex\Macro\TextTt	Texto monoespaciado.
jf\Tex\Macro\Tiny	Tamaño de fuente (normal - 4).
jf\Tex\Macro\TtFamily	Fuente monoespaciada.
jf\Tex\Macro\UsePackage	Importa un paquete.
jf\Tex\Macro\Vfill	Relleno vertical.
jf\Tex\Macro\Vline	Línea vertical.
jf\Tex\Macro\Vspace	Deja un espacio vertical.
jf\Tex\Options	Representa una macro que forma parte de una sección o que puede insertarse directamente en el documento.
jf\Tex\Package\ColorBox	Gestiona los cuadros de texto coloreados.
jf\Tex\Package\FancyHeader	Configura las secciones de la página usando el paquete `sectsty`.
jf\Tex\Package\Geometry	Configura las dimensiones de la página usando el paquete `geometry`.
jf\Tex\Package\PdfInfo	Gestiona los metadatos PDF del documento.
jf\Tex\Package\Sectsty	Configura las secciones de la página usando el paquete `sectsty`.
jf\Tex\Page	Gestiona una página en formato `LaTeX`.

Interfaces

Nombre	Descripción
jf\Tex\IItems	Interfaz para las clases que gestionan elementos.
jf\Tex\ILatex	Interfaz que deben cumplir los elementos que generan código LaTeX que será agregado al documento.

Traits

Nombre	Descripción
jf\Tex\TWrap	Facilita el envolver los textos entre llaves y corchetes.

Scripts

scripts/generate

Genera el código fuente de todo los archivos del repositorio dentro de directorio src.

Ver archivo scripts/generate.

jf / tex

Maintainers

Details