פורסם: 29/07/2003 - 20:02
נושא ההודעה:
|
|
מתווה ראשוני ליצירת פורמט לקבצי עזרה/מדריכים לסביבת לינוקס ותוכנה להצגתם.
)1)בעיה:
כיום, אין פורמט (1.1)*סטנדרטי* ו(1.2)*יעיל* לקבצי עזרה/מדריכים ללינוקס לצפיה אופליין. בהחלט קיים פורמט סטנדרטי (man pages), אם כי כיום רבות הם התוכנות שאינן כוללות דפים כאלו (בעיקר תוכנות ללא ממשק CLI). ישנן תוכנות עם גישה יעילה לעזרה (ראויה לציון DevHelp לגנום) אך היא אינה מהווה סטנדרט ומאפשרת גישה לקבצי העזרה שלה בלבד.
)1.3) נסיון לסטנדרטיזציה נעשה על ידי KDE בפיתוח khelpcenter. התוכנה משתמשת בDocBook ליצירת קבצי עזרה והצגת תוכן עניינים, והיא מזהה קבצי עזרה של תוכנות שונות ומציגה אותן בנוחות אך היא אינה מאפשרת חיפוש טקסט מלא או חיפוש באינדקס.
)2) לצורך הדיון, פורמט יעיל לעזרה ותיעוד הוא פורמט ש:
(2.1) מאפשר הצגת תוכן עשיר (תמונות, צביעה, עיצוב וכו').
(2.2) מאפשר ניווט באמצעים הבאים -
(2.2.1)תוכן עניינים
(2.2.2)חיפוש באינדקס
(2.2.3)חיפוש טקסט מלא
(2.2.4)קישוים פנימיים
(2.3) במקרה הצורך, מאפשר גישה בCLI.
)3) מבנה הפורמט-
(3.1) הקבצים כולם יהיו ארוזים בקובץ ארכיב אחד (ככל הנראה tar).
(3.2) הארכיב יכיל את תוכן העזרה עצמו בפורמט סטנדרטי (HTML תקני) וכן את הקבצים הנוספים הדרושים להצגת העזרה (כגון תמונות).
(3.3) בנוסף, יכיל הארכיב קובץ תוכן/אינדקס (ככל הנראה בפורמט XML) וכן, במידה ודרושים קבצי עזר ע"מ לבצע חיפוש טקסט מלא - הוא יכיל גם אותם.
)4) תוכנת הגישה
(4.1) התוכנה תיכתב בשפת פיית'ון תוך שימוש ברכיבי פיית'ון תקניים במידת הצורך.
(4.2) התוכנה תאפשר הצגה של קבצי העזרה במתווה הנ"ל:
(4.2.1) בגרסא 0.1 יבנה API בפיית'ון לקריאה וחיפוש בקבצים.
(4.2.2) בגרסא 0.2 יכתב ממשק שורת פקודה לקריאה וחיפוש בקבצים.
(4.2.3) בגרסא 0.3 יכתב ממשק מבוסס HTTP ע"מ שניתן יהיה לגשת באופן מלא ללא צורך בתוכנות עזר מסובכות (קרי - באמצעות דפדפן בלבד)
(4.2.4) יצירת כלים ליצירת קבצי העזרה ולהמרה לפורמט זה מפורמטים אחרים של עזרה (DocBook, HTML, CHM)
(4.3) התוכנה תופץ תחת רשיון LGPL
)5) הטמעה
(5.1) התוכנה אומנם תאפשר הצגה עצמאית של קבצי העזרה אך היא מיועדת בראש ובראשונה לשמש בסיס לתוכנות אחרות לגישה לקבצים הנ"ל.
(5.2) עידוד של פרוייקטים אחרים העוסקים בנושאים דומים (khelpcenter, kdevelop וכו') להוסיף תמיכה בהצגת עזרה בפורמט זה, אם תוך שימוש בתוכנת העזר שתוארה בסעיף 4 או עם עם על ידי יישום עצמאי של המתווה שיפורסם.
(5.2) עידוד של פרוייקטים אחרים להפיץ את קבצי העזרה לתוכנותיהם בפורמט הנדון.
)6) תקוות
(6.1) התמאה מלאה של המערכת בעולם הלינוקס ליצירת סטנדרטיזציה של מערכת עזרה מתקדמת - שילוב בהפצות המובילות ובניה של תוכנות גישה מותאמות פלטפורמה.
)7) הערות
(7.1) המתווה של קובץ העזרה מבוסס בעיקר על פורמט CHM שהוא הפורמט הטוב ביותר לדעתי כרגע לקבצי עזרה.
(7.2) במקרה וזה לא משתמש מהמסמך הנ"ל, אני מתעתד ליישם את המתווה הזה על כל פרטיו בחודשים הקרובים.
אשמח לתגובות,
רונן.
|
|
|
| חזרה לתוכן הדיון |
פורסם: 29/07/2003 - 20:05
נושא ההודעה:
|
|
קיים פורמט סטנדרטי: docbook
|
|
|
| חזרה לתוכן הדיון |
פורסם: 29/07/2003 - 20:08
נושא ההודעה:
|
| ציטוט: |
ב 2003-07-29 17:05, Anonymous כתב:
קיים פורמט סטנדרטי: docbook
|
שאינו עונה על ההגדרה של סעיף 2.
|
|
|
| חזרה לתוכן הדיון |
פורסם: 29/07/2003 - 20:38
נושא ההודעה:
|
|
רונן - דוקבוק עונה על סעיף 2, הבעיה היא תוכנה ידידותית שתדע להציג לפתוח לשמור ולערוך את ה XMLים של דוקבוק, ובעברית.
בגדול, DOCBOOK זה בהחלט תקן מצוין.
ברק.
|
|
|
| חזרה לתוכן הדיון |
פורסם: 29/07/2003 - 20:40
נושא ההודעה:
|
ברק - מי צריך בעברית? מי צריך לערוך? אכפת לי רק מהמשתמש הפשוט שרוצה להציג קבצים 
יש תוכנה שיודעת להציג קבצי docbook בצורה העונה על הדרישות של סעיף 2?
|
|
|
| חזרה לתוכן הדיון |
פורסם: 29/07/2003 - 20:44
נושא ההודעה:
|
|
DOCBOOK זו לא תוכנה להצגת קבצים, זה המקור, בתצורת XML של המדריכים או מה שזה לא יהיה.
עכשיו כדי לצפות בהם משתמשים בהמרה של הנתונים לפורמט הרצוי החל מ HTML ועד ל CHM של חלונות... (או איך שזה נקרא).
אם אין המרה נורמלית מ DOCBOOK לגרסאות טובות של HTML (שכוללות מנוע חיפוש ב Javascript וכו') זה עניין אחר, ואפשר לפתור את זה על ידי יצירת מחולל טוב.
לא צריך להמציא את הגלגל מחדש לדעתי.
ברק.
|
|
|
| חזרה לתוכן הדיון |
פורסם: 29/07/2003 - 20:51
נושא ההודעה:
|
שניה לפני שכולם מתנפלים עלי אולי אספיק להשחיל כמה מילים 
הרעיון מצויין, ולדעתי כדאי אכן לאמץ את docbook כבסיס לכתיבת מסמכי העזרה. אבל צריך להתייחס ל docbook ככלי לכתיבת הקוד, לא התוצר שהמשתמשים יראו.
בכל מה שקשור לתוצר, לדעתי כדאי להתלבש על הפורמט שהוגדר ע"י מייקרוסופט (מה? לא יכול להיות!!! דוקא כן ) . התוצר במקרה זה יהיה זמין גם תחת חלונות, למי שרוצה למשל לקרוא מסמכי עזרה של התקנת לינוקס לפני שבכלל יש לו לינוס, או בסביבות משולבות.
הקישור הזה מסביר איך לייצר HTML Help מתוך קבצי docbook.
היות ודיון זה ממשיך את הדיון הזה כל מה שצריך לעשות זה לחבר בין הכלים לייצור קבצי העזרה והכלים לצפייה בהם...
טוב, עכשיו אני הולך להתחפר באיגלו לפני שכולם מתחילים לזרוק כדורי שלג lol
|
|
|
| חזרה לתוכן הדיון |
פורסם: 29/07/2003 - 20:59
נושא ההודעה:
|
|
בלי להתייחס לעברית שאני מבין שיש מספר בעיות בהצגה שלה (אפשר לבדוק עם מני לוי) זה בדיוק מה שמערכת ההעזרה המקוונת של KDE (מה שנקרא מרכז העזרה) וכמובן GNOME עושות לא? הן שתיהן מבוססות על Docbook, יש תמיכה בכלים ייעודים כמו Conge עבור GNOME (בפיתוח לא מאוד יציבה) או במחוללים כולל AbiWord.
[ נערך על-ידי dittigas בתאריך 29/07/03 18:00:32 ]
_________________
Windows: A thirty-two bit extension and graphical shell to a sixteen-bit patch to an eight-bit operating system originally coded for a four-bit microprocessor which was written by a two-bit company that cant stand one bit of competition.
|
|
|
| חזרה לתוכן הדיון |
פורסם: 29/07/2003 - 21:05
נושא ההודעה:
|
ואני חשבתי שמשתמע מתגובתי שאם אני רוצה תוכנה שמציגה קבציDocBook אז DoBook אינה תוכנה...
בכל אופן, אם אתה אומר שתיאורתית הפתרון הזה אפשרי אז זה מוזר שהוא עוד לא קיים... (אני קופץ ל wishlist של khelpcenter... זה כבר קיים! הצביעו בהמוניכם:
http://bugs.kde.org/show_bug.cgi?id=57897
)
בכל אופן...
גם DocBook עדיין לא מצוי בכל. ע"ע העזרה של PHP אודותיה תהיתי אתמול.
|
|
|
| חזרה לתוכן הדיון |
פורסם: 29/07/2003 - 21:06
נושא ההודעה:
|
|
docbook הוא פורמט, לא כלי.
ישנם כמה וכמה כלים המשמשים לעריכה והמרה שלו
הבעיה העיקרית שלו היא עברית
|
|
|
| חזרה לתוכן הדיון |
פורסם: 29/07/2003 - 21:07
נושא ההודעה:
|
|
אגב, תנסה לעבוד עם lyx כעורך docbook, לפחות באנגלית. יש לו "אופי" דומה מספיק.
|
|
|
| חזרה לתוכן הדיון |
פורסם: 29/07/2003 - 21:20
נושא ההודעה:
|
|
דוביקס:
הדיון אליו הפנית והמסקנות שלי ממנו (ראה הודעתי האחרונה) הוא בדיוק מה שהוביל אותי לפתוח את דיון זה. arCHMage הוא אומנם חביב אבל הוא לא מושלם.
באשר להמרה של DocBook לCHM- זה דורש כלי קנייני.
ובכלל, CHM הוא פורמט קנייני שהספציפקציות שלו נבנו על ידי הנדסה לאחור והוא לא נחקר במלואו... כך שלסמוך עליו שיעשה את העבודה זה לא הדבר הראשון שהייתי עושה...
מה גם, שהיות והוא נועד לרוץ על אקספלורר, אפילו במעוזי תוכנה חופשית לא מקפידים על כתיבת JS סטנדרטי ל CHM... ראה ההנחיות להמרת מסמכי PHP ל CHM...
דיגיטיטס - בלי להתייחס לעברית -
הכלים של KDE ושל גנום כאילו משלימים זה את זה. זה של גנום מאפשר חיפוש באינדקס וזה של KDE משתלט על מסמכים שהוא מוצא במערכת.
עדיין, אף אחד מהכלים הללו לא עונה על הדרישות שהתוותי.
לאנונימים-
אני יודע שdocbook הוא פורמט ולא כלי. אני מדבר על כלים להצגת docbook ולא אכפת לי כהוא זה מיצירת docbook (לצורך הדיון).
אגב, מעבר לHTML יפתור כל בעיה אפשרית בכל שפה שהיא שנתמכת ב HTML.
|
|
|
| חזרה לתוכן הדיון |
פורסם: 29/07/2003 - 21:59
נושא ההודעה:
|
|
אני חושב שכדאי שתבחן שוב את ה-DocBook HOTWO. חזרה ל-HTML נשמעת לי לא סבירה כאשר יש נטייה כללית להעדיף DocBook XML שמילון הנתונים שלה הרבה יותר עשיר, יש לה לא מעט כלים להמרה לפורמאטים שונים וכלי תצוגה סטנדרטיים בשני שולחנות העבודה.
למשל מאוד קל יחסית להמיר קובץ DocBook ל-Tex כדי לייצר מדריך מודפס עם תוכנן עניינים ואינדקס וכדומה. אלו יתרונות חשובים שמבוססים על כלים וידע קיימים.
בנוסף, יש הרבה יותר כלים מוכנים ונייטרלים לגישה ל-XML מכל סביבות הפיתוח הקיימות והגמישות היא אינסופית ככה שאני מניח שכל פתרון חדש יצטרך להתחיל מאפס פחות או יותר לא? אני לא מכיר CHM מספיק טוב כדי להשוות. מה בדיוק היתרונות שלה לדעתכם ומה הבסיס הטכנולגי שלה? היא גם DTD?
ד"א האם הבעיות שהצגת עם DocBook קשורות לכלי הצפייה או באופן מהותי לפורמאט?
_________________
Windows: A thirty-two bit extension and graphical shell to a sixteen-bit patch to an eight-bit operating system originally coded for a four-bit microprocessor which was written by a two-bit company that cant stand one bit of competition.
|
|
|
| חזרה לתוכן הדיון |
פורסם: 29/07/2003 - 22:08
נושא ההודעה:
|
|
נתחיל מהסוף:
להבנתי, הבעיות שהזכרתי קשורות למציג ולא לפורמט עצמו. אני לא רואה שום מגבלה על יצירת חיפוש אינדקס (כי כותרות לכל הדפים כבר יש) וחיפוש טקסט מלא (כי טקסט מלא יש).
CHM עובד לפי הפורמט שהצעתי. קובץ דחוס עם HTML ואינדקסים.
הפתרון החדש לא בדיוק יתחיל מאפס. הוא מורכב משלושה רכיבים.
tar
html
xml
לכל אחד מהרכיבים הללו בנפרד יש אינספור צורות גישה מאינספור כלים נייטרליים.
רק צריך לחבר הכל ביחד.
אם הוא יתגלה כבאמת בעייתי, אפשר לוותר על הtar (אבל משהו שקוד-מאה-שורות בפייתון יכול לפתוח לא יכול להיות בעייתי מדי...)
בהחלט, אפשרויות ההמרה של HTML עשירות בהרבה. אבל אני לא מדבר כאן על פורמט לשימוש כללי (מה שHTML עושה) אלה על פורמט להצגת עזרה מקוונת...
שיטת עבודה יעילה תהיה לכתוב את המסמך כ DocBook ואז להפעיל עליו סקריפט שממיר אותו לפי הדרישות של הפורמט הנדון.
כלי התצוגה הראשוני יהיה הדפדפן. כמובן שאני אשמח עם הפורמט ישולב באופן מוטמע יותר לשולחנות העבודה הקיימים אבל הדפדפן תמיד יהיה אופציה.
את טוען שביצירת קובץ DocBook אני חופשי יותר מאשר ביצירת קובץ HTML?
אני יכול ליצור תפריטים קופצים? רכיבים שנעלמים בלחיצת כפתור או כל JS תקני אחר על ידי שימוש במפענך סטנדרטי בלבד?
|
|
|
| חזרה לתוכן הדיון |
פורסם: 29/07/2003 - 22:41
נושא ההודעה:
|
|
הבנתי. אתה מדבר בעצם על שכבת התצוגה ומדבר על פיתוח מציג שימושי יותר ממה שאתה מקבל כיום בקוד הפתוח. אני חושב שכלי מבוסס XUL על-בסיס גקו יהיה שימושי ביותר (עברית, קרוס פלטפורם וכו') למשל, אם אתה חושב שאתה מסוגל להמיר פורמאטים סטנדרטיים מבוססי DocBook למשל ל-CHM בצורה טריויאלית.
ד"א, כמובן ש-XML לא קשור לתצוגה ואנחנו מדברים על HTML בכל מקרה כתוצר סופי בין אם בדפדפן או בכלי ייעודי אחר.
למרות הכל אני ספקן לגבי האפשרות להפוך פתרון כזה לאטרקטיבי עבור יישומים קיימים ואני מאמין שהוא חייב להשתלב בהם במקום לנסות להחליף אותם אם זה אפשרי. יש לך הרי את הקוד של kdehelpcenter כמה קשה יהיה להרחיב אותה למשל לתמיכה בפורמאט קבצים (תוכן) חדש מבלי לאבד תכונות כמו פנייה ישירה למיקום מסויים בתוכן וכדומה שאפשרית כרגע ביישומים?
[ נערך על-ידי dittigas בתאריך 29/07/03 21:00:49 ]
_________________
Windows: A thirty-two bit extension and graphical shell to a sixteen-bit patch to an eight-bit operating system originally coded for a four-bit microprocessor which was written by a two-bit company that cant stand one bit of competition.
|
|
|
| חזרה לתוכן הדיון |
פורסם: 29/07/2003 - 22:56
נושא ההודעה:
|
|
האמת היא שמציג מבוסס UML היה הרעיון הראשוני שלי אבל חשוב לי שמילת המפתח תהיה פורטוביליות...
כן. אני מדבר על שכבת התצוגה בלבד, כיעד אפשרי להמרה מ DocBook או כל פורמט אחר לצורך העניין.
במתווה המדובר, לאחר התאמה קלה של קונקורר (ברמת הגדרות התוכנה, לא ברמת הקוד) ניתן יהיה להריץ את השרת העזרה ברקע ולהקליד השורת הכתובת של קונקי משהו כמו
uld:filename.uld
או
localhost:123/filename.uld
בכל דפדפן אחר ללא שום התאמה נוספת.
בנוסף, במידה ומתכנת אחר יחפוץ בכך הוא יוכל גם הוא להתמשק לתוכנה, אם דרך ממשק ה HTTP או אחד הממשקים האחרים שהצגתי, או בפענוח ישיר של הקובץ.
עד כמה יהיה קשה להרחיב את התמיכה של khelpcenter ב:
-פורמט הנדון (בוא נקרא לו לצורך הדיון ULD)? אין לי מושג.
-חיפוש באינדקס של קבצי DocBook/XML? אין לי מושג ספציפי אבל זה לא יכול להיות קשה מדי. בקשה נמצאת בwishlist... (ראה הודעה קודמת שלי).
למה שאני לא יעשה את זה? כי השליטה שלי בC++ מגיעה עד cout....
|
|
|
| חזרה לתוכן הדיון |
פורסם: 29/07/2003 - 23:20
נושא ההודעה:
|
|
פורמט העזרה של מיקרוסופט כולל (למיטב זכרוני החלוד בנקודה זו) אפשרות להוסיף קטעי קוד כדי לעזור להדגים כל מיני נקודות.
אם זה נכון (מישהו מתנדב לבדוק?) הפורמט הזה פסול לשימוש: אני לא ארשה למשהו שיכול להכיל כל קוד שהוא לרוץ על המערכת שלי!
|
|
|
| חזרה לתוכן הדיון |
פורסם: 29/07/2003 - 23:23
נושא ההודעה:
|
|
אף אחד לא אומר להשתמש בפורמט של חלונות!!!
אלא רק דומה במבנהו הכללי הפנימי...
|
|
|
| חזרה לתוכן הדיון |
פורסם: 29/07/2003 - 23:34
נושא ההודעה:
|
|
מה רע בסתם קובצי html (שנוצרים מ-docbook כבר היום)?
תסביר לי מה בדיוק חסר לך?
ממה שאני רואה , הדבר ביחיד שחסר במפרט המקורי שלך הוא חיפוש טקסט מלא.
בכל מקרה, תעיף מבט על מערכת התיעוד של דביין, כי היא כוללת הרבה דברים יפים בכיוון, כולל רישום אוטומטי של התיעוד בחבילות ויצירת אינדקס ראשי של התיעוד שבפורמט html, כולל אפשרות להצגדות בעזרת שרת ווב, אם מותקן כזה.
|
|
|
| חזרה לתוכן הדיון |
פורסם: 29/07/2003 - 23:37
נושא ההודעה:
|
|
לא חסר לי שום דבר בפורמט המקורי, חסר לי בכלים הנפוצים להצגתו.
חסר לי חיפוש טקסט מלא וחיפוש באינדקס של הדפים.
|
|
|
| חזרה לתוכן הדיון |
פורסם: 29/07/2003 - 23:52
נושא ההודעה:
|
|
אני חושב ש-docbook תומך ביצירת אינדקס off-line (כלומר: בזמן ההמרה).
התוכנה info תומכת בחיפוש טקסט מלא . לא ידוע לי מה לגבי מציגים אחרים של texinfo
כנ"ל לגביתמונות. אגב: תמונות הן מרכיב בעייתי שכן לא כל המדיומים יוכלו להציגם (סטנדרט HTML , לדוגמה, מחייב שלכל תמונה יהיה טקסט חלופי)
|
|
|
| חזרה לתוכן הדיון |
|
|
ת.הצטרפות: 26/01/2003
·
הודעות: 463
·
מיקום: גבעת אלה
![שלח דוא\](./modules/PNphpBB2/templates/PNTheme/images/lang_hebrew/icon_email.gif "שלח דוא\"){kind=icon}
