עורך קוד מקור 2017

עורך קוד מקור 2017 הוא מצב בתוך העורך החזותי שמאפשר למשתמשים להשתמש בסרגל הכלים של העורך החזותי גם כשהוא עורך בקוד מקור. ניתן לעבור למצב זה גם באמצעות לחיצה על כפתור בעורך החזותי.

The 2017 wikitext editor was released to Wikimedia Foundation-hosted wikis in 2023. זה לא מופעל כברירת מחדל. ניתן להשתמש בכלי במיזמי ויקימדיה כפיצ'ר במצב בטא על ידי בחירה בו בהעדפות.

מה זה?

כחלק מאחד מיעדי התוכנית השנתית 2016-17, ל"שימור ושיפור הדרך ליצירת תוכן וחיזוק הממשק," מחלקת העריכה עובדת על עורך קוד מקור חדש.

העורך החדש משולב בתוך העורך החזותי כדי לאפשר מעבר נוח יותר בין השניים. הוא בעל עיצוב דומה ורבים מהכלים של העורך החזותי נכללים בכלי. מצב העריכה החדש זמין למשתמשים שולחניים. המטרה העיקרית של הפבריקטור היא משימה T104479 (התוכנה לעיתים נקראת "עורך קוד מקור מודרני" או "עורך קוד מקור החדש"/"NWE").

זהו עורך חדש, לא שינוי בעורך הקיים. As the editor is based on VE surface, and not a standard textarea, then many of the editing gadgets do not work with that (it requires using very specific API to access wikicode). Gadgets that open an edit form and require a textarea can switch to plain wikicode editor using action=submit (rather than action=edit).

מהן הסיבות לפרויקט הזה?

ב-2010, קרן ויקימדיה סיימה את העבודה על פרויקט השמישות (שהביא לייסוד הסקין וקטור, כלי ההעלאה ועורך התוכן) והוחלף לבעיות שנבחרו על ידי הקהילה לשנים 2010-2015. הן כללו כמה שיפורים לכלי העריכה, בעיקר העורך החזותי, התראות ואחרים. עם זאת, המטרה איננה להחליף את עורך קוד מקור הישן; אנו רואים בשני הכלים לעריכה חשובים בטווח הארוך כדי לעזור לקהילה להמשיך ולגרום למיזמים להצליח.

נכון לדצמבר 2016, אנחנו מציעים כמעט בכל מיזמי ויקימדיה שלושה כלים שונים לעריכה. הם לא זהים בין המשתמשים במה שקשור למראה, הביצועים, הפעולה ובעזרה. אחד מהם הוא עורך קוד מקור 2010 שנקרא WikiEditor, השני הוא העורך החזותי למחשבים שולחניים ולמובייל, והאחרון הוא עורך קוד מקור בסיסי למובייל.

מאז 2010 למדנו הרבה על הדרך שבה משתמשים חדשים וותיקים כאחד משתמשים בתוכנה שלנו ומה הם ירצו לראות עובר שינוי. המחקר שלנו סייע לבנייה של העורך החזותי בעיצובים שעוזרים למשתמשים, מעניקים הסברים ברורים למשתמשים חדשים כיצד להיעזר בו ולא להפריע לעורכים שמעדיפים את העורך הישן והמוכר. למרות שהוא לא מושלם, ראינו העדפה מובהקת של משתמשים חדשים לעורך חזותי, מהלך העבודה שלהם והניסיון עם העורך החזותי. למדנו הרבה גם במובנים של הנדסה, ובנינו אותו כך שאתם יכולים להשתמש בו בעמוד, (כשאתם מקליקים על "עריכת קוד מקור") או בתוך כלי עזר (כמו בזרימה, Flow) וכן במחשב שולחני או בנייד, וכך שהוא ניתן להרחבה.

שמירה על שלושה כלים לא עקביים זה רע. זה רע עבור משתמשים חדשים יותר מפני שמה שלמדו לעשות בעורך מסוים לא תקף לאחר (כמו בעריכת דף שיחה). זה רע למשתמשים ותיקים, שצריכים לענות על כמה שאלות לפני שהם יכולים להתחיל לעבוד במה שנדרש מהם. זה רע עבור מפעילי מערכת, שצריכים להגדיר בנפרד את מה שהקהילה שלהם צריכה בכל עורך - או לגלות שהם לא יכולים לעשות את זה בעורך מסוים. זה רע עבור מפתחי גאדג'טים וסקריפטים, שיהיו צריכים להתמודד עם מספר אפשרויות (או להתעלם מחלקן). זה רע עבור המפתחים, שיהיו צריכים לקחת בחשבון עבודה מורכבת פי שלוש כשיצטרכו לתקן או להוסיף פיצ'ר. וזה רע לתורמים שלנו, שתרומותיהם תומכות בעבודה הכפולה הזו.

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

משתמשים שלא אוהבים את העורך יכולים לכבות אותו בהעדפות. עורך קוד מקור הנוכחי לא הולך לשום מקום, לפחות לשנים הקרובות. למרות שאנחנו עשויים לבטל אותו בעתיד, מי שאוהב אותו יוכל להמשיך להשתמש בו.

יעדים ומצב פיתוח

גרסה ראשונה (פיצ'ר בטא)

המטרות המקוריות של הפרויקט היו להשוות אותו ברמה של עורך קוד מקור הישן ולהשתמש בסרגל כלים זהה לעורך החזותי כך שעורכים יוכלו להשתמש בשני הכלים באופן אחיד. זה אומר שהעורך מספק את כל היכולות של עורך קוד מקור, למעט שינויים חריגים לכפתורים מיוחדים ומעטים:

• כלים בסיסיים (הדגשה, כתב נטוי, קישורים ותמונות);
• כלים מתקדמים (כותרות, רשימות, הגדלה, הקטנה, superscript, subscript, גלריות וטבלות);
• תווים מיוחדים;
• חיפוש והחלפה.

כל אלה הושלמו עד אוגוסט 2016, לצד כלים נוספים שלא קיימים בעורך הנוכחי (כמו קו חוצה, קו תחתי, הכנסת תבניות ועוד), ופיצ'רים כמו העברת HTML לקוד מקור אוטומטית. בפרט, אנחנו מספקים גם את הכלי שמאפשר יצירה אוטומטית של הערות שוליים, שמאפשר למשתמשים להוסיף בקלות ובמהירות הערות המבוססות על קישורים או מספרי DOI. כלי זה דומה אבל יותר מתקדם מגאדג'טים שנכתבו בשפות שונות, ועכשיו הוא יהיה זמין בכל השפות.

ביצענו בדיקת הבטחת איכות שנועדו להדגים שהפיצ'רים עובדים כמתוכנן, ועיצוב ביקורת וסידרנו את בדיקות המשתמשים. לאחר שהבטחנו שהכל עובד במדויק, וכן שמדובר בכלי לא יותר גרוע (לכל הפחות) עבור משתמשים חדשים, חיפשנו משובים ממשתמשים ותיקים מכל הרמות.

גרסת בטא סופית (לפני שחרור רשמי)

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

לקטגוריה הראשונה (האתגרים הגדולים), אנחנו מאמינים שנידרש להוסיף עריכת פסקה, שבה לחיצה על "עריכה" תאפשר הצגה של חלק קטן מהדף, וכן עיצוב רספונסיבי מלא, כך שהממשק ייראה יותר נקי למכשירים קטנים, בהם המשתמשים עושים זום אין על המסך, או מסיבות נגישות אחרות; עדכונים אלו יאפשרו לנו לספק את הפיצ'ר במובייל כגרסת בטא גם כן, כדי להבטיח שהוא עובד בכל המכשירים.

הקטגוריה השנייה (טעוני פידבק), יידרשו לספק סיוע בתוך העורך כדי להדריך משתמשים בתהליך העריכה עצמו. כרגע לעורך קוד מקור יש לשונית "עזרה" עם כמה מדריכים קצרים; בעורך החזותי יש קישור למדריך למשתמש, שנוכל להעתיק למטרה הזו. על האופן בו זה צריך לעבוד, ומה נדרש להדגיש, יש לקהילה רעיונות מעניינים. אנחנו נצטרך גם לנקות את האופן בו גאדג'טים מרחיבים את העורך, כששילוב העורך החדש מורכב ומבלבל. זה יהפוך המרת גאדג'טים קשה יותר ממה שהיא אמורה להיות. קהילות ויקי רבות משתמשות בגאדג'טים מסוימים כדי להקל על תהליך העבודה שלהן, וחשוב שנשמר את היכולת של מיזמים להתנסות בגמישות עם עדכונים כמו זה.

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

פיצ'רים שנשמח להוסיף

לצד מה שנכתב, ישנם פיצ'רים חדשים שנאהב לפרסם אם יהיו אפשריים, אבל חלקם עשויים להתגלות יקרים מדי לפתח או להאט משתמשים, ולכן לא מתוכננים כרגע. פיצ'ר שנרצה לשלב הוא שמירה אוטומטית של טיוטה מקומית כשמשתמשים עורכים, כך שאם הדפדפן או המחשב שלהם קורס בזמן העריכה, הם יוכלו לשחזר. דבר כזה ימנע ממשתמשים סיטואציות מתישות ולא נעימות, במיוחד אנשים עם חיבור אינטרנט חלש או מחשבים ישנים.

פיצ'ר אחר שנדון לעיתים קרובות הוא הבלטת תחביר של קוד מקור כדי להקל על משתמשים למצוא את התוכן שהם מחפשים בקלות רבה יותר. הפיצ'ר נבנה במקור עבור עורך קוד מקור ב-2011, אבל נאלצנו להתעלם ממנו בגלל המורכבות הרבה של קוד מקור, כך שזה היה מאט את רוב המשתמשים. חמש שנים מאוחר יותר, רוב המכשירים מהירים יותר משמעותית מכפי שהיו בעבר, דבר שמסייע בפיתוח. בנוסף, כדאי לבדוק האם נוכל להעלות תכונה כזאת אם היינו יכולים לפשט כמה מסוגי קוד מקור שאנחנו רוצים להדגיש.

(בינתיים, הבלטת טקסט קיימת ב-Remember the dot's syntax highlighter שזמינים בכמה מיזמים כגאדג'טים). הבלטת טקסט הוצגה גם gerrit:343878 בעורך קוד מקור 2017 בשימוש ב-Extension:CodeMirror .

מורכבת ונוטה יותר לטעויות, אולם יותר שימושית, תהיה תכונה לקיפול מבני קוד מקור לקוביות כך שמשתמשים יוכלו בקלות להתעלם מדברים שהם לא רוצים לערוך מבלי לקרוא אותם. למשל, תיבת מידע ארוכה או הערת שוליים תוכל להתקפל לקובייה עד שהמשתמש יפתח אותה. The technologies we built for the visual editor are particularly well-suited for providing this use case in a reliable fashion, so this may be something we could look at doing. Again, as with syntax highlighting we might need to compromise on the complexity of wikitext that we recognize in return for providing something performant enough to be useful to most of our users.

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

קישורים חיצוניים

• An early rough design mockup from April 2016 is available. To see the wikitext editor, click the brackets icon in the top-right corner.
• An old rough demo video is also available as of mid-May 2016 at https://www.youtube.com/watch?v=jgd2ZHOZGBE.
• Video demo of the 2017 wikitext editor from the December 2016 CREDIT showcase.
• The current version can be turned on in Special:Preferences#mw-prefsection-editing-editor; enable the "שימוש בעורך קוד המקור ישירות בתוך העורך החזותי, במקום בעורך נפרד" item, go to https://www.mediawiki.org/wiki/Project:Sandbox?veaction=editsource (for example) and see what it looks like when you switch back and forth.
• Enabling the "2017 wikitext editor" for extension "VisualEditor"

ר' גם

• Status update about editing software, June 2016
• עמוד משוב
• Extension:CodeMirror - the Beta Feature for wikitext syntax highlighting
• New visual way to display page changes
• 2017 wikitext editor performance improvements