API אוריון - בנייה

[טיוטה] Last updated by Joe Schaefer on יום א׳, 14 אפר׳ 2024    source
 

מסמך זה מכסה את Build System APIs


מס’ מערכות הבנייה

SunStarSys::תצוגה.

single_narrative(%args).

ארגומנטים חובה:

ארגומנטים אופציונליים:

news_page(%args).

sitemap(%args).

אינדקס יחסי תלות ספציפי לאזור, ממוין.

ארגומנטים חובה:

ארגומנטים אופציונליים:

asymptote(%args).

בניות ומטמונים אסימפטוטה.

ארגומנטים חובה:

דילוג(%args).

אל תבנו את זה בכלל. במקום זאת, בנה את קובצי המקור המשויכים שנוצרו (לדוגמה, .bib\$לנג \mapsto \$base.page/bibliography.yml\$lang

yml2ext(%args).

המר קובצי YAML.

ארגומנטים אופציונליים:

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

ארגומנטים חובה:

breadcrumbs($path).

מחזיר רשימת נתיבי HTML של נתיב.

memoize(%args).

מעביר למטמון את הבנייה; משמש בעיקר עם fetch_deps ו-quick_deps > 2.

compress(%args).

יצא משימוש.

next_view(%args).

כלי שירות לעיבוד $args{view}.

ssi(%args)

מעריך באופן רקורסיבי ssi.

offline(%args).

מריץ את next_view במצב לא מקוון.

snippet(%args).

מעבד קווי גזירים.

reconstruct(%args).

מעבד מחדש הנחיות תבנית בתוכן מובנה מ-next_view.

מעקם סיומות קובץ מקישורים מקומיים.

מנרמל קישורים מקומיים (./ ו- ../).


SunStarSys::כלי שירות.

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

מנתח כותרות+תוכן של קובץ מקודד UTF-8 קובץ $ מאחסן תוצאות ב- $out. $content_lines הוא המספר המרבי (אופציונלי) של שורות תוכן לקריאה.

קובץ $ יכולה להיות הפניה למחרוזת raw, המייצגת את כל התוכן של קובץ. התוצאות ב $out.

copy_if_newer($src, $dest).

עותקים $src עד $יעד אם חותמת הזמן של השינוי הקודם חדשה מזו של השנייה. על עותק, בנוסף gzip-דוחס את $יעד.

get_lock($lockfile).

לוקח נעילה בלעדית (f) עבור תהליך UNIX הנוכחי על $lockfile .

shuffle(\@deck).

רנדומלית במקום (דייג ייטס) של @deck.

sort_tables($content).

ממיין טבלאות סימון ב-$content בהתאם למפרט העמודה של כל טבלה. ניתן למיין עמודה אחת בדיוק לכל טבלה, אופציונלית, באופן מספרי nn, בירידה נגישות או בסדר עולה ^.

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

מסירה תחילית $ מכל ארגומנט ב-@_. הפונקציה של ארגומנט $type היא ספציפית למימוש, אך משמשת בעיקר לשתילת “מצב” editor.md לעיבוד תוכן זה ב-@_.

unload_package($pkg).

פורק באופן אגרסיבי את חבילת Perl חבילת $pkg.

purge_from_inc(@paths).

הסרה @paths מעמוד @INC.

touch(@_).

נגע בכל הקבצים ב- @_. . אם לא הועברו ארגומנטים, משתמש $_.

normalize_svn_path(@_).

מנרמל את כל הנתיבים ב- @_ לשימוש בטוח כארגומנטים גולמיים כדי SVN::לקוח.

sanitize_relative_path(@_).

אבטחת נתיבים ב- @_ לשימוש כנתיבים יחסיים טהורים ב- דוטיאק::DTL.

parse_filename($path).

Wrapper סביב קובץ::Basename::fileparse. . ללא טיעונים, שימושים $_.

walk_content_tree($code).

הליכות מותנות ./תוכן עץ הקופה של מערכת הבנייה, נרמול ראשון $_ כנתיב משנה רשמי ולאחר מכן מפעיל קוד $.

archived($path).

דגלים כל סטטוס: ארכיב נתיב. . שימושים $_.

seed_file_deps($path).

עדכונים %path::תלויות בשביל זה נתיבמבוסס על שלה יחסי תלות כותרות גלובליות. ברירות מחדל לשימוש $_.

seed_file_acl($path).

עדכונים @path::acl בשביל זה נתיבמבוסס על שלה רשימת בקרת גישה מפרט כותרת. ברירות מחדל לשימוש $_.

טעינה

זהה ל- YAML::XS::טעינה.

הטלה

זהה ל- YAML::XS::Dump.