Orion API - ビルド

[下書き] Last updated by Joe Schaefer on 土, 13 4月 2024    source
 

このドキュメントでは、ビルド・システム APIについて説明します.


システム構築

SunStarSys:: ビュー.

single_narrative(%args).

必須引数:

オプションの引数:

news_page(%args).

サイトマップ(%args).

依存関係のロケール固有のソートされた索引。

必須引数:

オプションの引数:

asymptote(%args).

ビルドおよびキャッシュ漸近線 トリプルバッククォートコードブロック。

必須引数:

スキップ(%args).

ドン’これらを全部作る。かわりに、関連する生成されたソース・ファイル(例: .bib\$lang \mapsto \$base.page/bibliography.yml\$lang)は、セカンダリビルドシステムの実行に基づいて構築されます。

yml2ext(%args).

YAMLファイルを変換します。

オプションの引数:

fetch_deps($path、$data、$quick).

必須引数:

ブレッドクラム($path).

HTMLブレッドクラム・リストを返します。パス.

memoize(%args).

ビルドをキャッシュします。主にfetch_depsおよびquick_deps > 2で使用されます。

compress(%args).

非推奨。

next_view(%args).

$argsを処理するためのユーティリティ{ビュー}.

ssi(%args).

再帰的評価ssi タグ

offline(%args).

next_viewをオフライン・モードで実行します。

スニペット(%args).

スニペット明細を処理します。

再構築(%args).

next_viewからビルドされたコンテンツのテンプレート・ディレクティブを再処理します。

ローカル・リンクからファイル拡張子を切り捨てます。

ローカル・リンク(./および../)を正規化します。


SunStarSys:: ユーティリティ.

read_text_file($file、$out、$content_lines).

UTF-8でエンコードされたファイルのheaders+contentを解析します$file 結果を格納する$out. $content_lines は、読み取るコンテンツ行の最大数です(オプション)。
実際に読み取られた行数(ヘッダーを含む)を返します。

$file ファイルの完全な内容を表すraw文字列への参照である可能性があります。結果$out UTF-8がエンコードされます。

copy_if_newer($src、$dest).

コピー数$src から最低 前者の場合’変更タイムスタンプが後者より新しい’s。コピー時に、さらにgzip-compress 最低 ファイルの場合’テキストファイルを追加し、”.gz” 名前の拡張。

get_lock($lockfile).

排他(f)ロック(現在のUNIXプロセスの場合)をオンにします。$lockfile.

シャッフル(\@deck).

インプレイスランダム(Fisher-Yates)シャッフル@deck.

sort_tables($コンテンツ).

$content内の値下げ表を各表に従ってソートします’カラム仕様表ごとに正確に1つの列をソートできます(オプション)。n降順v または昇順^ オーダー

fixup_code($prefix、$type、@_).

@_のすべての引数から$prefixを削除します。$type引数の関数は実装固有ですが、主にeditor.mdのシードに使用されます。”モード” このコンテンツを@_で処理するため。

unload_package($pkg).

Perlパッケージを積極的にアンロード$pkg シンボルテーブル(STASH).

purge_from_inc(@paths).

削除@paths 場所@INC.

タッチ(@_).

すべてのファイルを@_。引数が渡されない場合、$_.

normalize_svn_path(@_).

すべてのパスを正規化します。@_ RAW引数として安全に使用できます。SVN:: クライアント コマンド

sanitize_relative_path(@_).

パスを保護する@_ 純粋な相対パスとして使用ドチアク::DTL (Djangoテンプレート)パス固有のコマンド。

parse_filename($path).

ラッパー周りファイル::Basename::fileparse。引数を指定しない場合、$_ 解析するファイル名を指定します。

walk_content_tree($コード).

条件付きで歩く./コンテンツ ビルドシステムチェックアウトのツリー、最初に正規化$_ 正式なサブパスとして起動$codeツリーウォークの各項目

アーカイブ済み($path).

各フラグステータス: アーカイブ パス。使用$_ 引数が渡されない場合。

seed_file_deps($path).

更新%path:: 依存関係 このパスに基づいて、依存関係 ヘッダーglob。使用するデフォルト$_ 引数が渡されない場合のパス。

seed_file_acl($path).

更新@path::acl このパスに基づいて、ACL ヘッダー仕様使用するデフォルト$_ 引数が渡されない場合のパス。

ロード

同じYAML::XS:: ロード.

ダンプ

同じYAML::XS:: ダンプ.