Skip to content

About

No description or website provided.

Topics

Resources

Stars

4 stars

Watchers

0 watching

Forks

Repository files navigation

עיון ההלכה — תוסף אוצריא

תוסף לניהול הספקי "עיון ההלכה": צפייה בשאלות הגליון, כתיבת תשובות עם autosave, עיון במקורות מתוך אוצריא (שו"ע, משנה ברורה, ביאור הלכה, שער הציון), ייצוא ל-Word ושליחה במייל.

נבנה לפי תכנון מפורט - תוסף עיון ההלכה.md.

טכנולוגיה

  • React + TypeScript + Vite (build סטטי, chunk יחיד — נדרש ל-WebView מסוג file://).
  • כל הנתונים מוטמעים מקומית ב-bundle; אין גישת רשת ואין עדכון נתונים מרוחק.
  • API אוצריא: storage.*, library.*, reader.*, feedback.sendEmail, ui.* (דרך עטיפה אחת ב-src/otzaria/).

פיתוח

npm install
npm run dev          # דפדפן רגיל, עם mock SDK (localStorage במקום storage של אוצריא)

ב-console של הדפדפן ניתן להחליף theme: __toggleTheme().

טסטים

npm test                # כל הטסטים (Vitest + jsdom)
npm run test:watch      # מצב watch לפיתוח
npm run test:coverage   # דוח כיסוי

הטסטים ב-tests/, מקבילים למבנה src/, ומכסים כל שכבה: פענוח מסמכי ה-Word (examParse/examLoader — על קבצי ה-docx האמיתיים), ולידציית הנתונים, ניקוי HTML, ייצוא ל-DOCX ומילוי טופס הסימון, ה-stores (שמירה אוטומטית, הגדרות, תזכורות), עטיפות ה-API של אוצריא, כל הקומפוננטות והמסכים, זרימת ה-boot, ועקביות ה-manifest מול ההרשאות והנתונים.

  • ה-host של אוצריא מדומה ב-tests/helpers/host.ts (installFakeHost) — מתעד קריאות ומאפשר להגדיר תשובה/כשל לכל מתודה.
  • מודולים עם מצב פנימי (cache של ספרים, lastSignature בתזכורות) נטענים מחדש ב-vi.resetModules() בכל טסט.
  • המרת ה-docx (mammoth) דורשת טיימרים אמיתיים — לכן היא מתבצעת לפני vi.useFakeTimers() (ראה prepareExams ב-tests/helpers/app.ts).

בנייה ואריזה

npm run validate-data   # בדיקת עקביות schedule/questions/exams
npm run typecheck       # קוד האפליקציה + הטסטים
npm run release         # validate-data + טסטים + build + הרכבת dist/ מוכן לאריזה

npm run release יוצר את התיקייה dist/ הכוללת: manifest.json, index.html, assets/*, data/*, icon/* — זו תיקיית התוסף המלאה.

אריזה ל-.otzplugin:

# דרך כלי אוצריא:
dart tool/package_plugin.dart /path/to/dist --force
# או ידנית (זיפ של תוכן dist, הקבצים בשורש הזיפ):
cd dist && zip -r -X ../com.chadbedera.iyun-halacha-<version>.otzplugin . -x '.*'

הוספת גליון חדש

מסמכי ה-Word הם מקור האמת. אין שלב המרה ידני ואין קבצי JSON ביניים — הקבצים מ-exams-src/*.docx מוטמעים ב-build ומומרים בזמן ריצה (mammoth) ומפוצלים לפי שבוע.

  1. שמור את קובץ המבחן ב-exams-src/issue-XXXX.docx (Word, כפי שמתקבל מהמו"ל). שם הקובץ קובע את ה-issueId (למשל issue-0241.docx → issue-0241).
  2. הוסף תקופה/שבועות ב-public/data/schedule.json (פרשה, טווח סימנים, sourceRefs). חשוב: weekNumber בשבוע חייב להתאים למספר השבוע במסמך (מרקר "(שבוע N מתוך M)").
  3. הוסף ערך ב-public/data/exams-manifest.json (issueNumber, hebrewMonth, parshiot).
  4. הרץ npm run build (או npm run release). זהו — אין צורך לערוך קוד: import.meta.glob מגלה את כל קבצי ה-docx אוטומטית.

פורמט המבחן הנתמך: מרקר "(שבוע N מתוך M)" לכל שבוע, כותרת "שבוע פרשת ...", שורת טווח "מסימן ... עד ...", ושאלות באות פותחת — א] או [א]. הפענוח ב-src/data/examParse.ts.

נוסח השאלות מוצג ישירות מתוך מסמך ה-Word (קריאה בלבד). מודל התשובות הוא לכל שבוע (לא לכל שאלה); אין צורך בקובץ questions/issue-XXXX.json.

מעבר בין גליונות

כל גליון שמופיע ב-exams-manifest.json ושיש לו תקופה/שבועות ב-schedule.json מופיע אוטומטית בבורר הגליונות בסרגל העליון. מעבר גליון מציג את ההספק והשבועות שלו. כרגע מחווטים שני גליונות: ר"מ (סיון) ו-רל"ט (אייר-סיון).

הגדרות

חלון ההגדרות מחולק לכרטיסיות: מראה (גופן — ברירת מחדל/כמו אוצריא, גודל גופן, ופריסת מסך כתיבת התשובות: שלוש חלוניות או תשובה מתחת לשאלות), שליחת תשובות (שם, קוד אישי, מיילים), מקורות (שמות ספרים + זיהוי אוטומטי + השהיית שמירה), התראות (תזכורות), ואודות. גודל הגופן ומצב הגופן נשמרים ב-settings:v1 ומיושמים על משתני ה-CSS.

התראות ותזכורות

תזכורת שבועית קבועה (יום בשבוע + שעה) על שבועות שטרם הושלמו ("אי לימוד/כתיבת תשובות"). התזכורת מתוזמנת רק כל עוד יש שבוע פעיל שתשובתו לא סומנה כ"הושלם", ומתואמת מחדש בכל טעינה ובכל שינוי בתשובות/הגדרות (src/state/reminders.ts). שני ערוצים, ניתנים להפעלה בנפרד:

  • שולחן עבודה — התראת מערכת דרך notifications.scheduleSystem (דורש הרשאת notifications.system
    • אישור הרשאת מערכת חד-פעמי מתוך כרטיסיית ההתראות).
  • לוח שנה — אירוע מסוג calendar.event ב-publishedData.upsert (הרשאת published_data.write), שמופיע בלוח השנה של אוצריא.

כשמסמנים שבוע כ"הושלם", או מכבים את התזכורות — ההתראות והאירועים נמחקים אוטומטית.

מבנה נתונים

  • schedule.json — גליון → שבוע (פרשה, טווח סימנים, מזהי שאלות, מקורות).
  • questions/issue-XXXX.json — נוסח השאלות לפי שבוע.
  • exams-manifest.json — מטא-דאטה של גליונות + סטטוס רישוי.
  • תשובות המשתמש נשמרות ב-storage תחת answers:v1; הגדרות תחת settings:v1.

סכמות מלאות: src/data/types.ts.

נקודות פתוחות (סעיף 24 בתכנון)

  • רישוי הפצה: licenseStatus בגליון מסומן private. אין לפרסם לציבור עד הכרעה על זכויות הפצת נוסח השאלות.
  • עדכוני נתונים: הגליונות מוטמעים ב-build. עדכון גליון = גרסת תוסף חדשה והתקנה מחדש.
  • שמות ספרים: ניתנים ל-override בהגדרות + זיהוי אוטומטי (library.findBooks).

הגבלות ידועות

  • mailto/feedback.sendEmail אינם מצרפים את קובץ ה-DOCX אוטומטית — יש לצרפו ידנית.
  • שמירת קבצים (ייצוא ושליחה) משתמשת בדיאלוג "שמור בשם" של אוצריא (fs.beginBinaryWrite + fs.commitUserFileWrite, הרשאת fs.user_files.write). דורש אוצריא 0.9.97 ומעלה (minAppVersion). מחוץ לאוצריא (פיתוח בדפדפן) נשמר דרך הורדת דפדפן רגילה.
  • library.getBookContent מוגבל ל-5000 תווים לקריאה; טווחים ארוכים נטענים במספר קריאות.

היסטוריית גרסאות

1.7.0

  • תיקון: שמירת קבצי הייצוא והשליחה במייל (ה-WebView לא שמר קבצי blob: בהורדה רגילה) — כעת דיאלוג "שמור בשם" של אוצריא, והודעות ההצלחה מבוססות על התוצאה בפועל. דורש אוצריא 0.9.97 ומעלה + הרשאת fs.user_files.write.
  • תיקון: ייצוא ל-Word — שפת הטקסט והכיוון בעריכה (סימן-פסקה RTL עברי בכל פסקה, שפה לטינית en-US ושפת bidi עברית כמו ב-Word).
  • חדש: חלונית "שער הציון" במקורות (מוצגת רק אם הספר קיים בספרייה).
  • חדש: פריסה "תשובה מתחת לשאלות" (הגדרות > מראה).
  • שיפור: זיהוי שם ספר בניסוחים חלופיים (בלי פסיק/פיסוק, וגם שו"ע X) — כולל העדפת הספר עצמו על פני מפרשים עליו.
  • תיקון: כפתור "הגדר ספר" מוצג רק כשהספר חסר; הוסר קוד מת (findBestTocEntry).
  • התאמה להנחיות אוצריא: גלילה על html/body, צל ו-scrim ממשתני ה-theme, סגירה ב-Escape, תוויות נגישות.
  • תיקון: ייצוא ל-Word — שבירות שורה (Shift+Enter) נשמרות, רשימות מקוננות בלי טקסט כפול, יישור והזחה לפי כיוון הפסקה, ותווי בקרה מהדבקה (למשל מ-Word) כבר לא משחיתים את הקובץ.
  • תיקון: כיווץ חלונית "שער הציון", גדלי חלוניות נשמרים בנפרד לכל מספר חלוניות, ובלי קפיצת פריסה בכניסה חוזרת.
  • תיקון: בפריסה "תשובה מתחת לשאלות" — בלי כותרת כפולה; המפרידים בין החלוניות כבר לא גורמים לגלישה ולפס גלילה מיותר.

About

No description or website provided.

Topics

Resources

Stars

4 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages