מהו מחולל readme וורדפרס?
מחולל readme וורדפרס בונה את קובץ readme.txt שספריית התוספים של WordPress.org קוראת כדי ליצור רישום ציבורי של תוסף אתה ממלא את שדות הכותרת ואת הסעיפים, והוא פולט את הקובץ בפורמט המדויק שהספרייה מנתחת - שם התוסף `=== ===`, בלוק הכותרות המופרדות נקודתיים, והגוף `== סעיף ==` - עם תצוגה מקדימה חיה לצדו המראה איך ייראה דף הרישום.
הפורמט הוא בררני בדרכים שאינן נראות עד שמשהו לא בסדר. `תג יציב` שמות הגרסה שהספרייה משרתת בפועל, כך שתג שגוי או חסר לא שולח דבר לא משנה מה ביצעתם. `נבדק עד הסוף הוא מה שמייצר את אזהרת "לא נבדק עם הגרסה שלך של וורדפרס" ברשימה כשהיא מפגרת אחרי הליבה. `תגים` מוסיף לאינדקס את חמשת הראשונים ומתעלם בשקט מהשאר התיאור הקצר נחתך ל-150 תווים בתוצאות החיפוש אף אחד מאלה לא מייצר שגיאה שאתה רואה בזמן כתיבת הקובץ; הם מייצרים רישום שנראה לא בסדר או הורדה שלא מתרחשת, ימים לאחר מכן הכלי הזה מציין כל מגבלה לצד השדה שאליו הוא שייך, ומפרט מה הספרייה הייתה עושה עם הקובץ שלך לפני שאתה מוריד אותו.
הכל פועל צד לקוח שום דבר לא מועלה, לא נוצר חשבון, והטיוטה נשמרת בדפדפן משלך כך טעינה מחדש לא לאבד את זה אתה יכול גם לייבא readme.txt קיים - הדבק באחד התוסף שלך כבר ספינות והוא מנותח בחזרה לתוך הטופס, שהיא הדרך המהירה ביותר לתקן קובץ ישן או להביא readme עד לדרישות הנוכחיות מבלי להקליד אותו מחדש סעיפים בסדר יוצא דופן, שורות כותרת כלי זה אינו מודל, ומרווחים לא עקביים כולם נקראים ולא מסרבים, כי ככה נראים קבצי readme אמיתיים.
שני דברים שהקובץ עצמו לא יכול לשאת ראויים לאמירה ברורה תמונות באנר ואייקונים אינן חלק מ-readme.txt: הן חיות בתיקיית `/assets/` של התוסף כ'באנר-1544x500.png` ו`אייקון-256x256.png`, והשדות כאן קיימים כך שהתצוגה המקדימה מציגה את הרישום שתקבל בפועל צילומי מסך עובדים באותה צורה - readme.txt נושאת את הכתוביות הממוספרות, וקבצי `צילום מסך-1.png` התואמים נכנסים ל-`/assets/` בסדר הזה התצוגה המקדימה כנה לגבי זה במקום להעמיד פנים שכתובת URL של תמונה בטופס תופיע ב-WordPress.org ברגע שהקובץ נכון, הורד אותו, שחרר אותו בשורש התוסף, והעבר אותו לתא המטען של מאגר ה-SVN שלך.
כיצד להשתמש במחולל Readme וורדפרס?
מלא את הכותרות
שם התוסף, שמות המשתמש של התורמים WordPress.org, התג היציב, גרסאות ה-WordPress וה-PHP בהן אתה תומך, ועד חמישה תגיות אלה הופכים לחסימת הכותרות שהספרייה מנתחת תחילה.
כתוב את התיאור
משפט קצר אחד עבור רשימת החיפוש, ולאחר מכן התיאור הארוך ב-Markdown - ## כותרות, **מודגש** ו-* מפרט את כל העיבודים בדף התוסף. התצוגה המקדימה לצד עדכוני הטופס תוך כדי הקלדה.
הוסף שאלות נפוצות, צילומי מסך ויומן שינויים
כל שאלות נפוצות הופכות לשלה = שאלה = בלוק. כיתובי צילום מסך ממוספרים כך שיתאימו לקבצי צילום המסך-1.png בתיקיית הנכסים שלך. יומן השינויים לוקח אחד = גרסה = בלוק לכל מהדורה, החדש ביותר ראשון.
בדוק את האזהרות, ואז הורד
קרא את "מה הספרייה תעשה עם זה" - תג יציב חסר, תיאור קצר ארוך מדי, תגיות מעבר לחמישי - ואז הורד readme.txt והתחייב אותו לטראנק של התוסף שלך.
תכונות מפתח
תצוגה מקדימה של ספרייה חיה
הבאנר, הסמל, הכרטיסיות וסרגל הצד של רישום WordPress.org, המוצגים מהשדות שלך תוך כדי הקלדה, כך שתראה את הדף לפני שתפרסם אותו.
ייבוא readme.txt קיים
מנתח קריאה שאתה כבר שולח בחזרה לטופס, כולל קטעים בסדר יוצא דופן וקווי כותרת הכלי הזה לא מדגמן.
מגבלות המדריך עצמו, צוין
חמישה תגים באינדקס, תיאור קצר של 150 תווים, תג יציב שמחליט אילו ספינות - כל אחד מוצג בשדה עליו הוא חל, ומסוכם לפני ההורדה.
סימון היכן שהספרייה מקבלת אותו
כותרות, מודגשות, רשימות וקישורים מציגים בתיאור, בהתקנה וביומן השינויים בדיוק כפי שיעשו בדף התוסף.
Frequently Asked Questions
Related Tools
WordPress Plugin Detector
See which WordPress plugins load on any page, with the folder slug, the version, the install count and the evidence each one came from.
WordPress Theme Detector
Find out which WordPress theme a site runs, with the version, the author, the parent theme and the evidence each answer came from.
Markdown Table Generator
Build Markdown tables in a spreadsheet-style editor - import CSV, Excel, or an existing table, set alignment, copy clean GFM
Markdown TOC Generator
Generate a linked table of contents from Markdown headings
Comments
0 comments
No comments yet. Be the first to share your thoughts!