Obsidian URI הוא פרוטוקול URI מותאם אישית הנתמך על ידי Obsidian המאפשר לכם להפעיל פעולות שונות, כגון פתיחת הערה או יצירת הערה. Obsidian URI מאפשר אוטומציה וזרימות עבודה בין אפליקציות. ## פורמט URI כתובות Obsidian URI משתמשות בפורמט הבא: ``` obsidian://action?param1=value&param2=value ``` הפרמטר `action` הוא הפעולה שתרצו לבצע. פעולות זמינות כוללות: - `open` לפתיחת הערה. - `new` ליצירה או הוספה להערה קיימת. - `daily` ליצירה או פתיחה של ההערה היומית שלכם. - `unique` ליצירת הערה ייחודית חדשה. - `search` לפתיחת חיפוש. - `choose-vault` לפתיחת מנהל הכספות. > [!warning] קידוד > ודאו שהערכים שלכם מקודדים כראוי בפורמט URI. לדוגמה, תווי לוכסן `/` חייבים להיות מקודדים כ-`%2F` ותווי רווח חייבים להיות מקודדים כ-`%20`. > > זה חשוב במיוחד מכיוון שתו "שמור" שאינו מקודד כראוי עלול לפגוע בפירוש ה-URI. [ראו כאן לפרטים](https://en.wikipedia.org/wiki/Percent-encoding). ## פתיחת הערה הפעולה `open` פותחת כספת Obsidian, או פותחת קובץ בתוך אותה כספת. ### דוגמאות - `obsidian://open?vault=my%20vault` פעולה זו פותחת את הכספת `my vault`. אם הכספת כבר פתוחה, מתמקדים בחלון. - `obsidian://open?vault=ef6ca3e3b524d22f` פעולה זו פותחת את הכספת המזוהה לפי המזהה `ef6ca3e3b524d22f`. - `obsidian://open?vault=my%20vault&file=my%20note` פעולה זו פותחת את ההערה `my note.md` בכספת `my vault`, בהנחה שהקובץ קיים. - `obsidian://open?path=%2Fhome%2Fuser%2Fmy%20vault%2Fpath%2Fto%2Fmy%20note` פעולה זו תחפש כל כספת שמכילה את הנתיב `/home/user/my vault/path/to/my note`. לאחר מכן, שאר הנתיב מועבר לפרמטר `file`. לדוגמה, אם כספת קיימת ב-`/home/user/my vault`, אז זה יהיה שווה ערך לפרמטר `file` שמוגדר ל-`path/to/my note`. > [!tip] פתיחת כותרת או בלוק > עם קידוד URI תקין, ניתן לנווט לכותרת או בלוק בתוך הערה. `Note%23Heading` ינווט לכותרת בשם "Heading", בעוד `Note%23%5EBlock` ינווט לבלוק בשם "Block". ### פרמטרים - `vault` יכול להיות שם הכספת או מזהה הכספת[^1]. - `file` יכול להיות שם קובץ, או נתיב מהשורש של הכספת לקובץ המצוין. אם סיומת הקובץ היא `md`, ניתן להשמיט את הסיומת. - `path` נתיב מוחלט של מערכת הקבצים לקובץ. - שימוש בפרמטר זה ידרוס הן את `vault` והן את `file`. - זה יגרום לאפליקציה לחפש את הכספת הספציפית ביותר שמכילה את נתיב הקובץ המצוין. - לאחר מכן שאר הנתיב מחליף את פרמטר `file`. - `prepend` יוסיף לתחילת הקובץ וינסה למזג מאפיינים. - `append` יוסיף לסוף הקובץ וגם ינסה למזג מאפיינים. - `paneType` (אופציונלי) קובע היכן ההערה תיפתח בממשק. - אם לא מצוין, הלשונית הפעילה האחרונה מוחלפת. - `paneType=tab` פתיחה בלשונית חדשה. - `paneType=split` פתיחה בקבוצת לשוניות חדשה. - `paneType=window` פתיחה בחלון צף (שולחן עבודה בלבד). ## יצירת הערה הפעולה `new` יוצרת הערה חדשה בכספת, אופציונלית עם תוכן כלשהו. ### דוגמאות - `obsidian://new?vault=my%20vault&name=my%20note` פעולה זו פותחת את הכספת `my vault`, ויוצרת הערה חדשה בשם `my note`. - `obsidian://new?vault=my%20vault&file=path%2Fto%2Fmy%20note` פעולה זו פותחת את הכספת `my vault`, ויוצרת הערה חדשה ב-`path/to/my note`. ### פרמטרים - `vault` יכול להיות שם הכספת, או מזהה הכספת[^1]. זהה לפעולה `open`. - `name` שם הקובץ שייווצר. אם מצוין, מיקום הקובץ ייבחר על סמך העדפות "מיקום ברירת מחדל של הערה חדשה" שלכם. - `file` נתיב מוחלט בכספת, כולל השם. ידרוס את `name` אם מצוין. - `path` נתיב מוחלט גלובלי. עובד באופן דומה לאפשרות `path` בפעולה `open`, שידרוס הן את `vault` והן את `file`. - `paneType` (אופציונלי) קובע היכן ההערה תיפתח בממשק. זהה לפעולה `open`. - `content` (אופציונלי) תוכן ההערה. - `clipboard` (אופציונלי) שימוש בתוכן הלוח במקום ציון `content`. - `silent` (אופציונלי) הוסיפו פרמטר זה אם אינכם רוצים לפתוח את ההערה החדשה. - `append` (אופציונלי) הוסיפו פרמטר זה כדי להוסיף לקובץ קיים אם קיים כזה. - `overwrite` (אופציונלי) דריסת קובץ קיים אם קיים כזה, אך רק אם `append` אינו מוגדר. - `x-success` (אופציונלי) ראו [[#שימוש בפרמטרי x-callback-url]]. ## יצירה או פתיחה של הערה יומית הפעולה `daily` יוצרת או פותחת את ההערה היומית שלכם. תוסף [[הערות יומיות]] חייב להיות מופעל. ### דוגמאות - `obsidian://daily?vault=my%20vault` פעולה זו פותחת את הכספת `my vault`, ויוצרת או פותחת את ההערה היומית. ### פרמטרים הפעולה `daily` מקבלת את אותם פרמטרים כמו הפעולה `new`. ## הערה ייחודית הפעולה `unique` יוצרת הערה ייחודית חדשה בכספת. תוסף [[יוצר פתק ייחודי|יוצר פתק ייחודי]] חייב להיות מופעל. ### דוגמאות - `obsidian://unique?vault=my%20vault` פעולה זו פותחת את הכספת `my vault`, ויוצרת הערה ייחודית חדשה. - - `obsidian://unique?vault=my%20vault&content=Hello%20World` פעולה זו פותחת את הכספת `my vault`, ויוצרת הערה ייחודית חדשה עם התוכן `Hello World`. ### פרמטרים - `vault` יכול להיות שם הכספת, או מזהה הכספת[^1]. זהה לפעולה `open`. - `paneType` (אופציונלי) קובע היכן ההערה תיפתח בממשק. זהה לפעולה `open`. - `content` (אופציונלי) תוכן ההערה. - `clipboard` (אופציונלי) שימוש בתוכן הלוח במקום ציון `content`. - `x-success` (אופציונלי) ראו [[#שימוש בפרמטרי x-callback-url]]. ## פתיחת חיפוש הפעולה `search` פותחת את [[חיפוש]] בכספת המצוינת, ואופציונלית מבצעת חיפוש של מונח. ### דוגמאות - `obsidian://search?vault=my%20vault` פעולה זו פותחת את הכספת `my vault`, ופותחת את [[חיפוש]]. - `obsidian://search?vault=my%20vault&query=Obsidian` פעולה זו פותחת את הכספת `my vault`, פותחת את [[חיפוש]], ומבצעת חיפוש עבור `Obsidian`. ### פרמטרים - `vault` יכול להיות שם הכספת, או מזהה הכספת[^1]. זהה לפעולה `open`. - `query` (אופציונלי) מונח החיפוש לביצוע. ## פתיחת מנהל הכספות הפעולה `choose-vault` פותחת את [[נהל כספות|מנהל הכספות]]. ### דוגמאות - `obsidian://choose-vault` ## אינטגרציה עם Hook פעולת Obsidian URI זו מיועדת לשימוש עם [Hook](https://hookproductivity.com/). ### דוגמה `obsidian://hook-get-address` ### פרמטרים - `vault` (אופציונלי) יכול להיות שם הכספת, או מזהה הכספת[^1]. אם לא מסופק, ייעשה שימוש בכספת הנוכחית או האחרונה שהייתה בפוקוס. - `x-success` (אופציונלי) ראו [[#שימוש בפרמטרי x-callback-url]]. - `x-error` (אופציונלי) ראו [[#שימוש בפרמטרי x-callback-url]]. אם `x-success` מוגדר, ה-API ישתמש בו כ-x-callback-url. אחרת, הוא יעתיק קישור Markdown של ההערה הנוכחית שבפוקוס ללוח, כ-URL מסוג `obsidian://open`. ## שימוש בפרמטרי x-callback-url חלק מנקודות הקצה מקבלות את פרמטרי ה-x-callback-url `x-success` ו-`x-error`. כאשר הם מסופקים, Obsidian יספק את הנתונים הבאים ל-callback של `x-success`: - `name` שם הקובץ, ללא סיומת הקובץ. - `url` ה-URI מסוג `obsidian://` עבור קובץ זה. - `file` (שולחן עבודה בלבד) ה-URL מסוג `file://` עבור קובץ זה. לדוגמה, אם Obsidian מקבל `obsidian://.....x-success=myapp://x-callback-url`, התגובה תהיה `myapp://x-callback-url?name=...&url=obsidian%3A%2F%2Fopen...&file=file%3A%2F%2F...` ## פורמטים מקוצרים בנוסף לפורמטים שלעיל, קיימים עוד שני פורמטים "מקוצרים" זמינים לפתיחת כספות וקבצים: 1. `obsidian://vault/my vault/my note` שווה ערך ל-`obsidian://open?vault=my%20vault&file=my%20note`. 2. `obsidian:///absolute/path/to/my note` שווה ערך ל-`obsidian://open?path=%2Fabsolute%2Fpath%2Fto%2Fmy%20note`. ## פתרון בעיות ### רישום Obsidian URI ב-Windows וב-macOS, הפעלת האפליקציה פעם אחת אמורה להספיק כדי לרשום את פרוטוקול Obsidian URI במחשב שלכם. ב-Linux, זהו תהליך מעורב יותר: 1. ודאו שאתם יוצרים קובץ `obsidian.desktop`. [ראו כאן לפרטים](https://developer.gnome.org/documentation/guidelines/maintainer/integrating.html#desktop-files). 2. ודאו שקובץ ה-desktop שלכם מציין את שדה `Exec` כ-`Exec=executable %u`. ה-`%u` משמש להעברת כתובות `obsidian://` לאפליקציה. 3. אם אתם משתמשים בתוכנית ההתקנה של AppImage, ייתכן שתצטרכו לחלץ אותה באמצעות `Obsidian-x.y.z.AppImage --appimage-extract`. לאחר מכן ודאו שהוראת `Exec` מצביעה לקובץ ההפעלה המחולץ. [^1]: מזהה הכספת הוא קוד אקראי בן 16 תווים שמוקצה לכספת, לדוגמה `ef6ca3e3b524d22f`. מזהה זה הוא ייחודי לכל תיקייה במחשב שלכם. ניתן למצוא את המזהה על ידי פתיחת מחליף הכספות ולחיצה על "העתק את מזהה הכספת" בתפריט ההקשר של הכספת הרצויה.