התוסף הראשון ששמתי ב - WordPress.org לא שלח דבר במשך תשעה ימים. הייתי מחויב הקוד, תייג את המהדורה, צפה עדכון הרישום עם התיאור החדש שלי, ואמר לאנשים שזה היה בחוץ הורדות נשאר שטוח כי כפתור ההורדה היה משרת תיקיית תג ריקה: שלי readme.txt אמר Stable tag: 1.0.1 והתג שיצרתי בפועל היה 1.0. שום דבר לא הזהיר אותי. המדריך עשה בדיוק מה שאמרתי לו.
קו זה הוא השדה בעל ההימור הגבוה ביותר בתוסף וורדפרס's readme.txt, וזה אחד מכמה שנכשלים בשקט ולא בקול רם מדריך זה מכסה את מה שהספרייה עושה עם כל חלק של אותו קובץ, לפי סדר הנזק נוטה לקרות וורדפרס Readme Generator בונה את הקובץ עם כללים אלה המצורפים לשדות עליהם הם חלים.
TL;DR:
Stable tagשמות הגרסה שהספרייה למעשה משרתת. זה נקרא מtrunk/readme.txt, והוא מצביע על תיקיה מתחת/tags/זה חייב להתקיים וחייב להכיל את המהדורה. אם הוא נותן שם לגרסה שאינה שם, המשתמשים לא מקבלים כלום; אם הוא עדיין נותן שם לגרסה ישנה, הם מקבלים קוד ישן לא משנה מה התחייבת.Tested up toשולט באזהרת התאימות ברישום שלך,Tagsמוסיף רק את חמשת הראשונים, והתיאור הקצר נחתך ב-150 תווים.
במה בעצם שולט תג Stable?
תוסף בספרייה חי בחתרנות, עם trunk/ לפיתוח נוכחי ו tags/<version>/ עבור מהדורות. when someone clicks Download, the directory does not send them trunk. זה קורא trunk/readme.txt, מוצא Stable tag, ומשרת tags/<that value>/.
שלוש השלכות עוקבות, ושלושתן נושכות שחרורים אמיתיים:
- ה-readme שמחליט שזה זה בתא המטען. עריכת ה-readme בתוך תיקיית תגים לא משנה דבר לגבי מה שנשלח.
- התג צריך להתקיים. א
Stable tagמתן שם לתיקיה שמעולם לא נוצרה פירושו שההורדה ריקה או נכשלת. - Trunk זה לא מה שמשתמשים מקבלים. אתה יכול להתחייב לטראנק כל השבוע; עד שהתג היציב זז, הקוד ששוחרר הוא כל מה שהתג הישן מחזיק.
ה מדריך תוספים מציין את הכלל בצורה ברורה, וכדאי לקרוא פעם אחת כמו שצריך במקום להעתיק readme מתוסף אחר ולערוך את השדות. החריג היחיד שכדאי לדעת: Stable tag: trunk האם מתכוון "serve trunk", שהוא חוקי וכך משחררים קומץ תוספים. זה גם אומר שכל התחייבות לטראנק חיה מיד עבור כל משתמש, וזו הסיבה שכמעט אף אחד לא צריך לעשות את זה.
יש חצי שני למהדורה שה-readme לא שולט בה בכלל הגרסה ב Stable tag צריך להתאים את Version: כותרת בקובץ PHP הראשי של התוסף שלך, כי זה מה שאתר מותקן משווה מולו כדי להחליט אם קיים עדכון. שלח תג שכותרת התוסף שלו עדיין אומרת את המספר הקודם והספרייה מציעה עדכון שמתקין משהו שמתיימר להיות הגרסה שכבר קיימת.
מה כל שורת כותרת עושה לרישום שלך
בלוק הכותרת הוא תשע שורות של רגיל Key: value וכל אחד מהם משנה משהו גלוי.
| קו | מה שזה עושה | מה משתבש |
|---|---|---|
Stable tag |
בוחר את הגרסה המוגשת | ערך שגוי לא שולח כלום, או שולח קוד ישן |
Requires at least |
מינימום גרסת וורדפרס | בלוקים גבוהים מדי מתקינים שיעבדו |
Tested up to |
הצהרת תאימות | נפילה מאחור מציגה "untested" אזהרה |
Requires PHP |
גרסת PHP מינימלית | נמוך מדי מאפשר לאתרים לא תואמים להתקין ולהיכשל |
Tags |
מילות מפתח של ספריות | רק חמשת הראשונים צמודים לאינדקס |
Contributors |
קישורים פרופילי WordPress.org | שגיאת הקלדה לא מזכה בשקט אף אחד |
Donate link |
כפתור תרומה בסרגל הצד | נעדר זה בסדר, שבור זה לא |
License / License URI |
הרישיון | חייב להיות תואם GPL כדי להיות רשום |
Tested up to הוא זה שעולה הורדות בשקט כאשר הוא נופל יותר מכמה מהדורות ליבה מאחור, הרישום מציג הודעה שאומרת למבקרים שהתוסף לא נבדק עם הגרסה שלהם לוורדפרס, ותוסף שנראה נטוש מותקן פחות ללא קשר אם הוא עובד עדכון השורה הזו היא readme commit ל-trunk ולוקח דקה, שהיא התחזוקה הזולה ביותר במערכת האקולוגית.
Tags אינדקסים חמש תג שישי אינו שגיאה ואינו מייצר אזהרה; זה פשוט טקסט מת בקובץ שלך. בחר את חמשת האנשים המקלידים בפועל.
איך התיאור מפוצל, ולמה זה משנה?
יש שני תיאורים ב-readme והם עושים עבודות שונות.
ה תיאור קצר האם גוש הטקסט היחיד בין שורות הכותרת והראשון == Section ==. הוא מוגבל ל-150 תווים, ובעבר הספרייה חותכת אותו בתוצאות החיפוש ובכרטיס הפלאגין, בדרך כלל באמצע המשפט. זו השורה שרוב האנשים קוראים לפני שמחליטים אם ללחוץ, מה שהופך 150 תווים לנדלן היקר ביותר בקובץ.
ה תיאור ארוך האם ה == Description == סעיף וזה הופך לגוף של דף הרישום שלך.It לוקח תת-קבוצה של Markdown: כותרות, מודגש, נטוי, רשימות, קישורים.HTML גולמי מופשט.Tables, בלוקים קוד מגודר עם תחביר מדגיש, ואת Markdown אקזוטי יותר לא render, כך readme שנראה נכון בתצוגה מקדימה Markdown עדיין יכול להיראות לא נכון ב - WordPress.org.
שאר הקטעים ממפים כל אחד ללשונית ברשימה:
== Description == the main body
== Installation == the Installation tab
== Frequently Asked Questions == the FAQ tab, one "= question =" per entry
== Screenshots == numbered captions, matched to files in /assets/
== Changelog == one "= version =" block per release, newest first
== Upgrade Notice == the short line shown inside wp-admin on update
Upgrade Notice ראוי לתשומת לב רבה יותר ממה שהוא מקבל בדרך כלל זהו הטקסט היחיד שרוב המשתמשים רואים לפני לחיצה על עדכון: שורה אחת או שתיים, בהנחיית העדכון, המסבירות מדוע מהדורה זו חשובה תיקון אבטחה, שינוי שבירה, דרישת PHP חדשה. נותר ריק, העדכון הוא רק מספר.
איפה הבאנר והסמל גרים?
לא פנימה readme.txt. זה מעלה כמעט את כולם בפעם הראשונה, כי ה-readme הוא המקום שממנו מגיע כל פיסת תוכן רישום אחרת.
תמונות חיות ב- /assets/ ספרייה ב-SVN, ליד trunk ו tags, והם מותאמים לפי שם הקובץ:
| קובץ | מטרה | גודל |
|---|---|---|
banner-772x250.png |
כותרת רישום | 772 x 250 |
banner-1544x500.png |
כותרת רשתית | 1544 x 500 |
icon-128x128.png |
סמל תוצאות חיפוש | 128 על 128 |
icon-256x256.png |
סמל רשתית | 256 x 256 |
screenshot-1.png |
צילום מסך ראשון | כל |
צילומי המסך מתחברים חזרה ל-readme לפי מספר. screenshot-1.png מתואר בשורה הראשונה מתחת == Screenshots ==, screenshot-2.png עד השני, וכן הלאה כיתוב ללא קובץ תואם לא מראה דבר; קובץ ללא כיתוב מציג תמונה ללא תווית.
איך נראה יומן שינויים טוב?
בלוק אחד לכל מהדורה, החדש ביותר בחלק העליון, כל שורה אומרת מה השתנה מנקודת המבט של המשתמש's:
= 3.2.5 =
* Fixed: admin menu order lost after a role change
* Improved: login customizer previews without saving
= 3.2.4 =
* Added: per-role dashboard widget visibility
" תיקוני באגים ושיפורים" לא אומר למשתמש כלום ולא אומר למבקר פחות. יומן השינויים הוא גם המקום שבו כל מי שמחליט אם לסמוך על התוסף שלך נראה ראשון: רשימה קבועה של ערכים ספציפיים נקראת כתחזוקה, ופער של שנתיים נקרא כנטישה בין אם הקוד עדיין עובד ובין אם לאו.
יומני שינוי ארוכים הם בסדר לקצץ שמור את המהדורות האחרונות ב readme.txt ואת השאר תעביר ל-א changelog.txt; הספרייה קוראת את הספרייה הגזומה וההיסטוריה נשארת במאגר.
בדיקת הקובץ לפני שאתה שולח אותו
הבדיקות המכניות מהירות: עושה Stable tag התאם תיקיית תג שקיימת, האם היא תואמת ל Version: בכותרת התוסף שלך, הוא Tested up to נוכחי, הוא התיאור הקצר מתחת ל-150 תווים, האם יש חמישה תגים או פחות.
ל-WordPress.org יש מאמת readme רשמי שמנתח קובץ ומדווח על מה שהוא לא הצליח לקרוא, מה ששווה להפעיל פעם אחת בכל מהדורה. ה מחולל Readme לוקח את הכיוון השני: הוא בונה את הקובץ משדות, מציין כל אחת מהמגבלות הללו ליד השדה שעליו הוא חל, מציג תצוגה מקדימה של הרישום שהקובץ יפיק וקורא קיים readme.txt חזרה לטופס כך שניתן לעדכן קובץ תוסף ישן 's מבלי להקליד אותו מחדש.
אם אתה מסתכל על אנשים אחרים & #39;s תוספים במקום לפרסם משלך, ה גלאי תוספים לוורדפרס מפרט מה דף טוען, ואת גלאי נושא קורא את הנושא שעומד מאחוריו.
