ما الذي تفعله العلامة المستقرة، ولماذا لا يقوم الشخص الخطأ بشحن أي شيء

أول مكون إضافي قمت بوضعه على WordPress.org لم يشحن شيئًا لمدة تسعة أيام. لقد التزمت بالرمز، ووضعت علامة على الإصدار، وشاهدت تحديث القائمة مع وصفي الجديد، وأخبرت الناس أنه قد انتهى. ظلت التنزيلات ثابتة لأن زر التنزيل كان يقدم مجلد علامات فارغًا: my readme.txt قال Stable tag: 1.0.1 والعلامة التي قمت بإنشائها بالفعل كانت 1.0. لم يحذرني شيء. الدليل فعل بالضبط ما قلته له.

هذا السطر هو الحقل الأكثر خطورة في البرنامج المساعد WordPress &#39؛s readme.txt، وهي واحدة من عدة حالات تفشل بهدوء وليس بصوت عالٍ. يغطي هذا الدليل ما يفعله الدليل بكل جزء من هذا الملف، بالترتيب الذي يحدث به الضرر. ال مولد ووردبريس التمهيدي يقوم بإنشاء الملف بهذه القواعد المرفقة بالحقول التي تنطبق عليها.

ليرة تركية؛DR: Stable tag أسماء الإصدار الذي يخدمه الدليل بالفعل. تتم قراءته من trunk/readme.txt، ويشير إلى مجلد أدناه /tags/ يجب أن يكون موجودًا ويجب أن يحتوي على الإصدار. إذا قام بتسمية إصدار غير موجود، فلن يحصل المستخدمون على أي شيء؛ إذا كان لا يزال يذكر اسمًا قديمًا، فسيحصلون على رمز قديم بغض النظر عما ارتكبته. Tested up to يتحكم في تحذير التوافق الموجود في قائمتك، Tags يقوم بفهرسة الخمسة الأولى فقط، ويتم قطع الوصف المختصر بـ 150 حرفًا.

ما الذي تتحكم فيه العلامة المستقرة فعليًا؟

يوجد مكون إضافي في الدليل في Subversion، مع trunk/ للتطوير الحالي و tags/<version>/ للإصدارات. عندما ينقر شخص ما على "تنزيل"، لا يرسله الدليل trunk. يقرأ trunk/readme.txtيجد Stable tagويخدم tags/<that value>/.

تتبع ذلك ثلاث عواقب، وجميع الإصدارات الثلاثة حقيقية:

• التمهيدي الذي يقرر هذا هو الذي في الجذع. تحرير الملف التمهيدي داخل مجلد العلامات لا يغير شيئًا بشأن السفن.
• العلامة يجب أن تكون موجودة. أ Stable tag تسمية مجلد لم يتم إنشاؤه مطلقًا تعني أن التنزيل فارغ أو فاشل.
• الجذع ليس ما يتلقاه المستخدمون. يمكنك الالتزام بصندوق الأمتعة طوال الأسبوع؛ حتى تتحرك العلامة المستقرة، يكون الرمز الذي تم إصداره هو ما تحمله العلامة القديمة.

ال دليل البرنامج المساعد ينص على القاعدة بوضوح، وهي تستحق القراءة مرة واحدة بشكل صحيح بدلاً من نسخ برنامج جاهز من مكون إضافي آخر وتحرير الحقول. الاستثناء الوحيد الذي يستحق المعرفة: Stable tag: trunk يعني &quot؛ خدمة الجذع والاقتباس؛ وهو أمر قانوني وهو كيفية إصدار عدد قليل من المكونات الإضافية. ويعني أيضًا أن كل التزام بالجذع يكون مباشرًا على الفور لكل مستخدم، ولهذا السبب لا ينبغي لأحد تقريبًا القيام بذلك.

هناك نصف ثانٍ للإصدار لا يتحكم فيه القارئ على الإطلاق. الإصدار في Stable tag يجب أن تتطابق Version: رأس في ملف PHP للمكون الإضافي الرئيسي، لأن هذا هو ما يقارن به الموقع المثبت لتحديد ما إذا كان التحديث موجودًا أم لا. قم بشحن علامة لا يزال رأس المكون الإضافي الخاص بها يقول الرقم السابق ويقدم الدليل تحديثًا يقوم بتثبيت شيء يدعي أنه الإصدار الموجود بالفعل.

ما يفعله كل سطر رأس بقائمتك

كتلة الرأس عبارة عن تسعة أسطر عادية Key: value وكل واحد منهم يغير شيئا مرئيا.

خط	ماذا يفعل	ما الخطأ
Stable tag	يختار الإصدار المقدم	القيمة الخاطئة لا تشحن شيئًا، أو تشحن الكود القديم
Requires at least	الحد الأدنى لإصدار ووردبريس	يتم تثبيت الكتل العالية جدًا التي قد تعمل
Tested up to	بيان التوافق	السقوط في الخلف يظهر &quot؛غير مختبرة وحاصل؛ تحذير
Requires PHP	الحد الأدنى من إصدار PHP	منخفض جدًا يسمح للمواقع غير المتوافقة بالتثبيت والفشل
Tags	الكلمات الرئيسية للدليل	تتم فهرسة الخمسة الأولى فقط
Contributors	روابط ملفات تعريف WordPress.org	خطأ مطبعي لا ينسب الفضل إلى أحد بصمت
Donate link	زر التبرع بالشريط الجانبي	الغائب بخير، والكسور ليس كذلك
License / License URI	الرخصة	يجب أن يكون متوافقًا مع GPL حتى يتم إدراجه

Tested up to هو الذي يكلف التنزيلات بصمت. عندما يتخلف عن الركب أكثر من عدد قليل من الإصدارات الأساسية، تعرض القائمة إشعارًا يخبر الزائرين بأن البرنامج الإضافي لم يتم اختباره مع إصدارهم من WordPress، ويتم تثبيت البرنامج الإضافي الذي يبدو مهجورًا بشكل أقل بغض النظر عما إذا كان يعمل أم لا. يعد تحديث هذا السطر بمثابة التزام جاهز بالجذع ويستغرق دقيقة واحدة، وهي أرخص صيانة في النظام البيئي.

Tags الفهارس خمسة. العلامة السادسة ليست خطأ ولا تنتج أي تحذير؛ إنه ببساطة نص ميت في ملفك. اختر الأشخاص الخمسة الذين يكتبون بالفعل.

كيف يتم تقسيم الوصف ولماذا يهم؟

هناك وصفان في التمهيدي ويقومون بوظائف مختلفة.

ال وصف قصير هي كتلة نصية واحدة بين أسطر الرأس والأولى == Section ==. يبلغ الحد الأقصى 150 حرفًا، وبعد ذلك يقوم الدليل باقتطاعه في نتائج البحث وعلى بطاقة البرنامج المساعد، عادةً في منتصف الجملة. هذا هو السطر الذي يقرأه معظم الأشخاص قبل اتخاذ قرار بالنقر عليه، مما يجعل 150 حرفًا أكثر العقارات قيمة في الملف.

ال وصف طويل هو == Description == القسم ويصبح نص صفحة القائمة الخاصة بك. يأخذ مجموعة فرعية من Markdown: العناوين، الغامقة، المائلة، القوائم، الروابط. تم تجريد HTML الخام. لا يتم عرض الجداول وكتل التعليمات البرمجية المسيجة مع تمييز بناء الجملة وMarkdown الأكثر غرابة، لذا فإن الملف التمهيدي الذي يبدو صحيحًا في معاينة 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. يؤدي هذا إلى تعثر الجميع تقريبًا في المرة الأولى، لأن الملف التمهيدي هو المكان الذي يأتي منه كل جزء آخر من محتوى القائمة.

الصور تعيش في /assets/ الدليل في SVN، بجانب trunk و tags، ويتم مطابقتها بواسطة اسم الملف:

ملف	غرض	مقاس
banner-772x250.png	رأس القائمة	772 س 250
banner-1544x500.png	رأس شبكية العين	1544 x 500
icon-128x128.png	أيقونة نتائج البحث	128 x 128
icon-256x256.png	أيقونة شبكية العين	256 x 256
screenshot-1.png	لقطة الشاشة الأولى	أي

تتصل لقطات الشاشة مرة أخرى بالمسودة حسب الرقم. screenshot-1.png يتم وصفه بالسطر الأول أدناه == Screenshots ==، screenshot-2.png بالثانية، وهكذا. التسمية التوضيحية التي لا تحتوي على ملف مطابق لا تظهر شيئًا؛ يُظهر الملف الذي لا يحتوي على تسمية توضيحية صورة غير مُعلَّمة.

كيف يبدو سجل التغيير الجيد؟

كتلة واحدة لكل إصدار، الأحدث في الأعلى، كل سطر يوضح ما تغير من وجهة نظر المستخدم &#39؛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

&quot؛ إصلاحات الأخطاء والتحسينات وحصص الإقتباس؛ لا يخبر المستخدم شيئًا ويخبر المراجع بشكل أقل. سجل التغيير هو أيضًا المكان الذي يبحث فيه أي شخص يقرر ما إذا كان سيثق في المكون الإضافي الخاص بك أولاً: قائمة ثابتة من الإدخالات المحددة تُقرأ على أنها صيانة، والفجوة لمدة عامين تُقرأ على أنها تخلي عما إذا كان الكود لا يزال يعمل أم لا.

من الجيد تقليم سجلات التغيير الطويلة. احتفظ بالإصدارات الأخيرة readme.txt ونقل الباقي إلى أ changelog.txt؛ يقرأ الدليل الدليل المقطوع ويبقى السجل في المستودع.

التحقق من الملف قبل شحنه

الفحوصات الميكانيكية سريعة: هل Stable tag قم بمطابقة مجلد العلامات الموجود، هل يطابق Version: في رأس البرنامج المساعد الخاص بك، هو Tested up to الحالي، هو الوصف المختصر الذي يقل عن 150 حرفًا، هل هناك خمس علامات أو أقل.

يحتوي WordPress.org على مدقق القراءة الرسمي يقوم ذلك بتوزيع ملف والإبلاغ عما لا يمكنه قراءته، وهو ما يستحق التشغيل مرة واحدة لكل إصدار. ال مولد التمهيدي يأخذ الاتجاه الآخر: فهو يبني الملف من الحقول، ويذكر كل حد من هذه الحدود بجوار الحقل الذي ينطبق عليه، ويعين القائمة التي سينتجها الملف، ويقرأ ملفًا موجودًا readme.txt ارجع إلى النموذج حتى يمكن تحديث ملف البرنامج المساعد &#39؛s القديم دون إعادة كتابته.

إذا كنت تنظر إلى أشخاص آخرين والمكونات الإضافية #39؛s بدلاً من نشر المكونات الإضافية الخاصة بك، فإن كاشف البرنامج المساعد ووردبريس يسرد ما يتم تحميله من الصفحة، و كاشف الموضوع يقرأ الموضوع وراءه.