a2x - מקוון בענן

תָכְנִית:

שֵׁם

a2x - מנהל שרשרת כלים עבור AsciiDoc (ממיר קבצי טקסט Asciidoc לקובץ אחר
פורמטים)

תַקצִיר

a2x [אפשרויות] קובץ מקור

תיאור

מנהל שרשרת כלים של DocBook שמתרגם קובץ טקסט AsciiDoc קובץ מקור ל-PDF,
EPUB, DVI, PS, LaTeX, XHTML (דף בודד או חלק), דף אדם, HTML עזרה או טקסט רגיל
פורמטים באמצעות asciidoc(1) ויישומים אחרים (ראה סעיף דרישות). קובץ מקור יכול
יהיה גם קובץ DocBook עם סיומת .xml.

אפשרויות

-א, --תְכוּנָה=תְכוּנָה
לקבוע asciidoc(1) ערך תכונה (קיצור דרך עבור --asciidoc-opts="-א תְכוּנָה" אוֹפְּצִיָה).
ניתן לציין אפשרות זו יותר מפעם אחת.

--asciidoc-opts=ASCIIDOC_OPTS
נוסף asciidoc(1) אפשרויות. ניתן לציין אפשרות זו יותר מפעם אחת.

--conf-קובץ=CONF_FILE
טען קובץ תצורה. ראה סעיף קבצי CONF.

-ד, --destination-dir=DESTINATION_DIR
ספריית פלט. ברירת מחדל ל קובץ מקור מַדרִיך. אפשרות זו חלה רק על
פורמטי פלט מבוססי HTML (נתח, ePub, html עזרה, xhtml).

-ד, --doctype=דוקטיפה
סוג מסמך DocBook: מאמר, דף אדם or ספר. סוג המסמך המוגדר כברירת מחדל הוא מאמר
אלא אם כן הפורמט הוא דף אדם (במקרה זה כברירת מחדל דף אדם).

-ב, - גב=גב
גב הוא השם של תוסף אחורי המותקן. כאשר אפשרות זו מצוינת a2x
ניסיונות לטעון שם קובץ a2x-backend.py מ גב ספריית התוספים זה אז
ממיר את קובץ מקור כדי גב קובץ פלט מעוצב באמצעות פונקציה גלובלית
מוגדר ב a2x-backend.py נקרא to_BACKEND.

-ו, --פוּרמָט=פורמט
פורמטים של פלט: נתח, ספר דוקטור, דוי, ePub, html עזרה, דף אדם, PDF (ברירת מחדל), ps,
טקס, טֶקסט, xhtml. ה-AsciiDoc בפורמט a2x ערך התכונה מוגדר ל פורמט.

-ח, - עזרה
הדפס את תחביר שורת הפקודה ואפשרויות תוכנית ל-stdout.

--אייקונים
השתמש בתמונות של אזהרה או סמל ניווט במסמכי פלט. התנהגות ברירת המחדל היא
להשתמש בטקסט במקום סמלים.

--icons-dir=נתיב
נתיב (ביחס לקבצי פלט) המכיל סמלי התראה וניווט. ברירות מחדל
לתמונות/אייקונים. ה --אייקונים האפשרות משתמעת אם משתמשים באפשרות זו.

-ק, --שמור-חפצים
אל תמחק קבצי בנייה זמניים.

--לִינקס
השתמש לִינקס(1) כדי ליצור פלט בפורמט טקסט. התנהגות ברירת המחדל היא להשתמש w3m(1).

-ל, --no-xmllint
אל תבדוק פלט asciidoc עם xmllint(1).

---epubcheck
בדוק פלט EPUB עם epubcheck(1).

-נ, --ריצה יבשה
אל תעשה שום דבר רק תדפיס את מה שהיה נעשה.

-ר, --מַשׁאָב=RESOURCE_SPEC
ציין משאב. ניתן לציין אפשרות זו יותר מפעם אחת. ראה את מקורות
סעיף לפרטים נוספים.

-M, --משאב-מניפסט=קובץ
קובץ מכיל משאבים ברשימה (אחד בכל שורה). לְהַפְגִין קובץ ערכים מעוצבים
בדיוק כמו --מַשׁאָב טיעוני אופציה. משתני סביבה וטילדה בית
ספריות מותרות.

--גיליון סגנונות=גיליון סגנונות
רשימה מופרדת ברווח של שם קובץ גיליון סגנונות CSS אחד או יותר המשמשים לסגנון
פלט HTML שנוצר על ידי DocBook XSL Stylesheets. ברירת מחדל ל docbook-xsl.css. ה
גיליונות הסגנונות מעובדים לפי סדר רשימה. גיליונות הסגנונות חייבים להימצא בתקף
מיקום קובץ המשאב. חל על פורמטי HTML: xhtml, ePub, נתח, html עזרה
פורמטים.

-ב, --מִלוּלִי
הדפס פרטים תפעוליים לסטדרר. שנייה -v האופציה מחילה את האופציה המילולית על
פקודות שרשרת הכלים.

--גִרְסָה
הדפס את גרסת התוכנית ל-stdout.

--xsltproc-opts=XSLTPROC_OPTS
נוסף xsltproc(1) אפשרויות. ניתן לציין אפשרות זו יותר מפעם אחת.

--xsl-קובץ=XSL_FILE
החלף את גיליון הסגנונות המובנה של XSL עם גיליון הסגנונות המותאם אישית של XSL XSL_FILE.

--גַנדְרָן
השתמש ב-FOP כדי ליצור קובצי PDF. התנהגות ברירת המחדל היא להשתמש dblatex(1). ה --גַנדְרָן אוֹפְּצִיָה
משתמע אם נעשה שימוש באפשרות זו.

--fop-opts=FOP_OPTS
נוסף גַנדְרָן(1) אפשרויות. אם אפשרות זו מצוינת, FOP משמש ליצירת קובצי PDF.
ניתן לציין אפשרות זו יותר מפעם אחת.

--dblatex-opts=DBLATEX_OPTS
נוסף dblatex(1) אפשרויות. ניתן לציין אפשרות זו יותר מפעם אחת.

--- backend-opts=BACKEND_OPTS
אפשרויות עבור הפלאגין האחורי שצוין על ידי - גב אוֹפְּצִיָה. אפשרות זו עשויה להיות
צוין יותר מפעם אחת.

ניתן להגדיר אפשרויות גם בקובץ המקור AsciiDoc. אם קובץ מקור מכיל הערה
קו שמתחיל ב // a2x: אז שאר הקו יטופל כמו a2x
אפשרויות שורת הפקודה. לדוגמה:

// אפשרויות ברירת מחדל a2x.
// a2x: -dbook --epubcheck
// דיכוי היסטוריית גרסאות בפלטי dblatex.
// a2x: --dblatex-opts "-P latex.output.revhistory=0"

· אפשרויות המשתרעות על שורות הערה מרובות כאלה ישושרו.

· אפס או יותר תווי רווח לבן יכולים להופיע בין התווים המובילים // ו a2x:.

· אפשרויות שורת הפקודה עדיפות על אפשרויות שנקבעו בקובץ המקור.

תפוקה קבצים

קבצי פלט נכתבים לספרייה שצוינה על ידי --destination-dir אוֹפְּצִיָה. אם לא
--destination-dir האפשרות מוגדרת קבצי פלט נכתבים ל קובץ מקור במדריך.

לקבצי הפלט יש שם זהה לזה של קובץ מקור אבל עם שם קובץ מתאים
סיומת: .html עבור xhtml; .epub עבור ePub; .hhp עבור html עזרה; .pdf עבור PDF; .טקסט עבור
טֶקסט, .xml עבור ספר דוקטור. לפי המוסכמה לדפי manpage אין סיומת .man (קטע דף אדם
מספר בלבד). לשמות ספריות HTML חתוכים יש סיומת .chunked; עזרה ב-HTML חלקית
לשמות ספריות יש סיומת .htmlhelp.

קבצים קיימים בעלי שם זהה נמחקים.

בנוסף ליצירת קובצי HTML, ה xhtml, ePub, נתח ו html עזרה פורמטים להבטיח
קבצי משאבים מועתקים למיקומי ספריית היעד הנכונים שלהם.

מקורות

משאבים הם קבצים (בדרך כלל CSS ותמונות) שנדרשים על ידי פלטים מבוססי HTML
(xhtml, ePub, נתח, html עזרה פורמטים). a2x סורק את קבצי ה-HTML שנוצרו ובונה א
רשימה של קבצי CSS ותמונות נדרשים. ניתן לציין קבצי משאבים נוספים
שימוש מפורש ב- --מַשׁאָב אוֹפְּצִיָה.

a2x מחפש קבצי משאבים במיקומים הבאים בסדר הבא:

1. קובץ מקור במדריך.

2. ספריות משאבים שצוינו על ידי --מַשׁאָב אפשרות (חיפוש רקורסיבי).

3. ספריות משאבים שצוינו על ידי --משאב-מניפסט אפשרות (חיפוש רקורסיבי
לפי סדר הופעתם בקובץ המניפסט).

4. ספריות התמונות וגיליונות הסגנונות ב- asciidoc(1) קבצי תצורה
ספריות (חיפוש רקורסיבי).

5. ספריית היעד.

כאשר נמצא קובץ משאבים הוא מועתק לספריית היעד היחסית הנכונה.
תת ספריות יעד חסרות נוצרות באופן אוטומטי.

ישנם שני מנגנונים ברורים לציון משאבים נוספים:

1. ספריית משאבים אשר תבוצע חיפוש רקורסיבי עבור קבצי משאבים חסרים.

2. קובץ משאבים שיועתק לספריית יעד הפלט.

משאבים מצוינים עם --מַשׁאָב ערכי אופציות שיכולים להיות אחד מהבאים
An University you


[= ]
. =

איפה:


מציין ספרייה (אבסולוטית או יחסית ל- קובץ מקור) שמחפשים
באופן רקורסיבי עבור קבצי משאבים חסרים. כדי לבטל את העמימות שֵׁם
צריך להסתיים בתו מפריד ספריות.


מציין קובץ משאבים (מוחלט או יחסית ל- קובץ מקור) אשר יהיה
הועתק ל . אם לא מצוין אז זה ה
זהה ל .


מציין את היעד של קובץ המקור שהועתק. ה נתיב הוא
יחסית לספריית היעד (לא מותרים נתיבים מוחלטים). המיקום
של ספריית היעד תלוי בפלט פורמט (ראה תפוקה קבצים
סעיף לפרטים):

חתוך, htmlhelp
ספריית הפלט החתוכה.

ePub
ספריית OEBPS בארכיון.

xhtml
הפלט DESTINATION_DIR.

. =
בעת הוספת משאבים לקובצי EPUB ניתן להסיק את סוג ה-mime מה-
סיומת file>, אם לא ניתן לנחש את ה-mimetype מתרחשת שגיאה. ה
. = ניתן להשתמש בתחביר משאבים כדי להגדיר באופן מפורש סוגי mime. הוא
סיומת שם הקובץ, הוא סוג MIME המתאים.

דוגמאות לאפשרויות משאבים:

--משאב ../images/
--resource doc/README.txt=README.txt
--מַשׁאָב ~/images/tiger.png=images/tiger.png
--resource .ttf=application/x-font-ttf

דוגמאות

a2x -f pdf doc/source-highlight-filter.txt
יוצר קובץ doc/source-highlight-filter.pdf.

a2x -f xhtml -D ../doc --icons -r ../images/ team.txt
יוצר קובץ HTML ../doc/team.html, משתמש בסמלי התראה ומחפש באופן רקורסיבי ב
ספריית ../images/ עבור כל משאבים חסרים.

a2x -f manpage doc/asciidoc.1.txt
צור דף ניהול של doc/asciidoc.1.

דרישות

a2x משתמש בתוכנות הבאות:

· אססידוק: http://asciidoc.org/

· xsltproc: (כל הפורמטים למעט טקסט): http://xmlsoft.org/XSLT/

· דוקוב XSL גיליונות סגנונות (כל הפורמטים למעט טקסט):
http://docbook.sourceforge.net/projects/xsl/

· dblatex (פורמטים של pdf, dvi, ps, טקסט): http://dblatex.sourceforge.net/

· גַנדְרָן (פורמט PDF - מחולל קבצי PDF חלופי): http://xmlgraphics.apache.org/fop/

· w3m (פורמט טקסט): http://w3m.sourceforge.net/index.en.html

· לינקס (פורמט טקסט - מחולל קבצי טקסט חלופי): http://lynx.isc.org/

· epubcheck (פורמט epub - מאמת קובץ EPUB): http://code.google.com/p/epubcheck/

עיין גם בקובץ README האחרון.

CONF קבצים

קובץ תצורה מכיל קוד Python בר הפעלה שעוקף את הגלובלי
פרמטרי תצורה ב-a2x.py. קבצי תצורה אופציונליים נטענים ב-
הסדר הבא:

1. a2x.conf מהספרייה המכילה את a2x.py הפעלה.

2. a2x.conf מספריית התצורה הגלובלית של AsciiDoc. דלג על שלב זה אם כן
ביצוע עותק מותקן מקומי (שאיננו רחב במערכת).

3. a2x.conf מספריית התצורה של AsciiDoc $HOME/.asciidoc.

4. CONF_FILE שצוין ב --conf-קובץ אוֹפְּצִיָה.

להלן ערכי ברירת המחדל של אפשרויות קובץ התצורה:

# מילון משתנה סביבה אופציונלי הועבר
# תוכניות הפעלה. אם מוגדר ל-None, הקיים
נעשה שימוש בסביבה אחת.
ENV = אין

# קובצי הפעלה חיצוניים.
ASCIIDOC = 'asciidoc'
XSLTPROC = 'xsltproc'
DBLATEX = 'dblatex' # יצירת pdf.
FOP = 'fop' # יצירת pdf (אפשרות--fop).
W3M = 'w3m' # יצירת טקסט.
LYNX = 'lynx' # יצירת טקסט (אם אין w3m).
XMLLINT = 'xmllint' # הגדר ל'' כדי להשבית.
EPUBCHECK = 'epubcheck' # הגדר ל'' כדי להשבית.
# אפשרויות ברירת מחדל חיצוניות להפעלה.
ASCIIDOC_OPTS = ''
DBLATEX_OPTS = ''
FOP_OPTS = ''
XSLTPROC_OPTS = ''

השתמש ב-a2x באינטרנט באמצעות שירותי onworks.net