أوريون API - بناء
Joe Schaeferيغطي هذا المستند واجهات برمجة تطبيقات نظام الإنشاء.
- نظام الإنشاء
- SunStarSys::عرض .
- single_narrative(%args).
- news_page(%args).
- خريطة الموقع(%args).
- علامة(%args).
- تخطي(%args).
- yml2ext(%args).
- fetch_deps($path، $data، $quick).
- علامات التتبع($path).
- حفظ(%args).
- يضغط(%args).
- next_view(%args).
- ssi(%args).
- غير متصل(%args).
- قصاصة(%args).
- إعادة الإعمار(%args).
- trim_local_links(%args).
- normalize_links(%args).
- SunStarSys::Util .
- read_text_file($file, $out, $content_lines).
- copy_if_newer($src، $dest).
- get_lock($lockfile).
- shuffle(\@deck).
- sort_tables($content).
- fixup_code($prefix، $type، @_).
- unload_package($pkg).
- purge_from_inc(@paths).
- لمس(@_).
- normalize_svn_path(@_).
- sanitize_relative_path(@_).
- parse_filename(مسار$).
- walk_content_tree($code).
- تحميل
- تفريغ
- SunStarSys::عرض .
نظام الإنشاء
SunStarSys::عرض.
single_narrative(%args).
الوسائط الإلزامية:
الوسائل الاختيارية:
news_page(%args).
خريطة الموقع(%args).
الفهرس المفروز للتبعيات الخاص بالمنطقة اللغوية.
الوسائط الإلزامية:
الوسائط الاختيارية:
علامة(%args).
الإنشاءات والذاكرة المخبئية مُقَارِبًا ثلاث كتل التعليمات البرمجية ذات علامات الاقتباس الخلفية.
الوسائط الإلزامية:
تخطي(%args).
دون’لا تبني هذه على الإطلاق. بدلاً من ذلك، قم بإنشاء ملفات المصدر المرتبطة (على سبيل المثال. .bib\$lang \$base.page/bibliography.yml\$lang) ليتم بناؤها على تشغيل نظام بناء ثانوي.
yml2ext(%args).
تحويل ملفات YAML.
الوسائط الاختيارية:
fetch_deps($path، $data، $quick).
الوسائط الإلزامية:
علامات التتبع($path).
إرجاع قائمة علامات تتبع HTML لـ مسار $.
حفظ(%args).
تخزين البناء تخزينًا مؤقتًا؛ يتم استخدامه بشكل أساسي مع fetch_deps وquick_deps > 2.
يضغط(%args).
قديم.
next_view(%args).
الأداة المساعدة لمعالجة $args{شاهد}.
ssi(%args).
التقييمات المتكررة تسي العلامات.
غير متصل(%args).
تشغيل next_view في وضع عدم الاتصال.
قصاصة(%args).
معالجة سطور القصاصة.
إعادة الإعمار(%args).
إعادة معالجة توجيهات القالب في المحتوى المضمن من next_view.
trim_local_links(%args).
إزالة امتدادات الملفات من الارتباطات المحلية.
normalize_links(%args).
تطبيع الارتباطات المحلية (./ و../).
SunStarSys::Util.
read_text_file($file, $out, $content_lines).
تحليل الرؤوس + محتوى ملف UTF-8 المشفر ملف $ ويخزن النتائج في $out. $content_lines هو الحد الأقصى (اختياري) لعدد سطور المحتوى المطلوب قراءتها.
إرجاع العدد الفعلي للسطور المقروءة (بما في ذلك الرؤوس).
ملف $ قد يكون مرجعًا لسلسلة أولية، تمثل المحتويات الكاملة للملف. النتائج في $out سيظل UTF-8 مشفرًا.
copy_if_newer($src، $dest).
النُسخ $src لكي $dest إذا كان الأول’الطابع الزمني للتعديل هو أحدث من الأخير’ث. على نسخة، بالإضافة إلى ذلك gzip يضغط على $dest ملف إذا’ملف نصي، ويضيف “.gz” امتداد للاسم.
get_lock($lockfile).
يأخذ (و) قفل حصري (لعملية UNIX الحالية) على $lockfile.
shuffle(\@deck).
في مكان عشوائي (فيشر ييتس) shuffle من @deck.
sort_tables($content).
فرز جداول تخفيض السعر في $content وفقًا لكل جدول’مواصفات العمود s. يمكن فرز عمود واحد فقط لكل جدول، اختياريًا رقميًا لا، في أي تنازلي v أو تصاعدي ^ الطلب.
fixup_code($prefix، $type، @_).
إزالة $prefix من كل وسيطة في @_. وظيفة وسيطة $type محددة للتنفيذ، ولكنها تستخدم بشكل أساسي لإدخال editor.md “الوضع” لمعالجة هذا المحتوى في @_.
unload_package($pkg).
تفريغ حزمة Perl بقوة حزمة $ من جدول الرموز (STASH).
purge_from_inc(@paths).
عمليات الإزالة @paths من @INC.
لمس(@_).
يمسح كل الملفات في @_. في حالة عدم تمرير وسائط، يتم استخدام $_.
normalize_svn_path(@_).
تطبيع كل المسارات في @_ للاستخدام الآمن كحجج خام SVN::العميل الأوامر.
sanitize_relative_path(@_).
تأمين المسارات في @_ للاستخدام كمسارات نسبية نقية في دوتياك::DTL الأوامر الخاصة بمسار (Django Template).
parse_filename(مسار$).
مغلف حول ملف::اسم القاعدة::fileparse. بدون وسائط، استخدامات $_ مثل اسم الملف للتحليل اللغوي.
walk_content_tree($code).
مشياً مشروطاً ./المحتوى شجرة الخروج من نظام البناء، أولا تطبيع $_ كمسار فرعي رسمي ثم استدعاء رمز $، على كل عنصر في الرصيف.
مؤرشف ($path).
علامات لكل الحالة: أرشيف مسار $. الاستخدامات $_ إذا لم يتم تمرير وسائط.
seed_file_deps(مسار$).
التحديثات %path::dependencies لهذا مسار $، بناءً على التبعيات عناوين عامة. الإعدادات الافتراضية المطلوب استخدامها $_ كالمسار في حالة عدم تمرير وسائط.
seed_file_acl(مسار$).
التحديثات @path::acl لهذا مسار $، بناءً على قائمة التحكم بالوصول مواصفات الرأس. الإعدادات الافتراضية المطلوب استخدامها $_ كالمسار في حالة عدم تمرير وسائط.
تحميل
مماثل لـ YAML::XS::تحميل.
تفريغ
مماثل لـ YAML::XS:: تفريغ.