API de Orion - Crear
Joe SchaeferEn este documento se tratan las API del sistema de creación
- Sistema de creación
- SunStarSys::Ver .
- single_narrative(%args).
- news_page(%args).
- sitemap(%args).
- asymptote(%args).
- omitir(%args).
- yml2ext(%args).
- fetch_deps($path, $data, $quick).
- breadcrumbs($path).
- memoize(%args).
- compress(%args).
- next_view(%args).
- ssi(%args).
- offline(%args).
- snippet(%args).
- reconstruct(%args).
- trim_local_links(%args).
- normalize_links(%args).
- SunStarSys::Util .
- read_text_file($file, $out, $content_lines).
- copy_if_newer($src, $dest).
- get_lock(archivo_bloque).
- mezclar(\@deck).
- sort_tables($content).
- fixup_code($prefix, $type, @_).
- unload_package($pkg).
- purge_from_inc(@paths).
- contacto(@_).
- normalize_svn_path(@_).
- sanitize_relative_path(@_).
- parse_filename(ruta $).
- walk_content_tree(código $).
- Carga
- Volcado
- SunStarSys::Ver .
Sistema de creación
SunStarSys::Ver.
single_narrative(%args).
Argumentos obligatorios:
Argmuents opcionales:
news_page(%args).
sitemap(%args).
Índice de dependencias ordenado específico de la configuración regional.
Argumentos obligatorios:
Argumentos opcionales:
asymptote(%args).
Ensamblajes y cachés asínto.
Argumentos obligatorios:
omitir(%args).
No los construyas en absoluto. En su lugar, cree los archivos de origen generados asociados (por ejemplo, .bib\$lang \$base.page/bibliography.yml\$lang
yml2ext(%args).
Convertir archivos YAML.
Argumentos opcionales:
fetch_deps($path, $data, $quick).
Argumentos obligatorios:
breadcrumbs($path).
Devuelve la lista de rutas de navegación HTML para $ruta.
memoize(%args).
almacena en caché la compilación; se utiliza principalmente con fetch_deps y quick_deps > 2.
compress(%args).
En desuso.
next_view(%args).
Utilidad para procesar $args{view}.
ssi(%args).
Evaluaciones recursivas ssi.
offline(%args).
Ejecuta next_view en modo fuera de línea.
snippet(%args).
Permite procesar líneas de fragmentos.
reconstruct(%args).
Vuelve a procesar las directivas de plantilla en el contenido creado de next_view.
trim_local_links(%args).
Recorta extensiones de archivo desde enlaces locales.
normalize_links(%args).
Normaliza los enlaces locales (./ y ../).
SunStarSys::Util.
read_text_file($file, $out, $content_lines).
Analiza cabeceras + contenido del archivo codificado UTF-8 Archivo $ y almacena los resultados en $out. $content_lines es el número máximo (opcional) de líneas de contenido para leer.
Archivo $ puede ser una referencia a una cadena raw, que representa el contenido completo de un archivo. Los resultados en $out.
copy_if_newer($src, $dest).
Copias Origen $ para $est si el registro de hora de modificación del primero es más nuevo que el del segundo. Al copiar, además gzip-comprime el $est.
get_lock(archivo_bloque).
Realiza un bloqueo (f) exclusivo (para el proceso UNIX actual) activado Archivo $lock.
mezclar(\@deck).
aleatorio (Fisher-Yates) barajado de @deck.
sort_tables($content).
Ordena las tablas de rebaja en $content según la especificación de columna de cada tabla. Se puede ordenar exactamente una columna por tabla, opcionalmente numérica n, ya sea descendente v o ascendente ^.
fixup_code($prefix, $type, @_).
Borra $prefix de cada argumento en @_. La función del argumento $type es específica de la implantación, pero se utiliza principalmente para iniciar el “modo” editor.md para procesar este contenido en @_.
unload_package($pkg).
Descarga agresivamente el paquete Perl $paquete.
purge_from_inc(@paths).
contacto(@_).
Toca todos los archivos en @_. Si no se transfieren argumentos, se utilizan $_.
normalize_svn_path(@_).
Normaliza todas las rutas de @_ para un uso seguro como argumentos SVN::Cliente.
sanitize_relative_path(@_).
Protege las rutas en @_ para su uso como rutas relativas puras en Dotiac::DTL.
parse_filename(ruta $).
Envoltorio alrededor Archivo::Basename::fileparse. Sin argumentos, utiliza $_.
walk_content_tree(código $).
Pasea condicionalmente por . / contenido árbol de la salida del sistema de creación, primera normalización $_ como subruta formal y, a continuación, llamar a Código $.
archived($path).
Indicadores cada Estado: archivo $ruta. Usos $_.
seed_file_deps(ruta $).
Actualizaciones %path::dependencias para esto $ruta, basado en su Dependencias glob de cabecera. Se utiliza por defecto $_.
seed_file_acl(ruta $).
Actualizaciones @path::acl para esto $ruta, basado en su ACL especificación de cabecera Se utiliza por defecto $_.
Carga
Igual que YAML::XS::Cargar.
Volcado
Igual que YAML::XS::Volver.