diff options
Diffstat (limited to 'files/ar/mdn')
25 files changed, 2492 insertions, 0 deletions
diff --git a/files/ar/mdn/about/index.html b/files/ar/mdn/about/index.html new file mode 100644 index 0000000000..8c6962b5c4 --- /dev/null +++ b/files/ar/mdn/about/index.html @@ -0,0 +1,110 @@ +--- +title: حول شبكة مطوري موزيلا +slug: MDN/About +tags: + - التوثيق + - الرخص + - المساهمة + - حقوق الملكية + - حول الشبكة + - دليل +translation_of: MDN/About +--- +<div>{{MDNSidebar}}</div> + +<div>{{IncludeSubNav("/ar/docs/MDN")}}</div> + +<p dir="rtl">توثيقات شبكة مطوري موزيلا هي منصة تعليمية متطورة لتقنيات الويب والبرمجيات التي يقوم عليها الويب، متضمنةً:</p> + +<ul dir="rtl"> + <li>لغات الويب القياسية مثل <a href="/ar/docs/Web/CSS">صفحات الأنماط الانسيابية</a>، و<a href="/ar/docs/Web/HTML">لغة ترميز النص الفائق</a>، و<a href="/ar/docs/Web/JavaScript">الجافاسكربت</a>.</li> + <li><a href="/ar/docs/Web/تطبيقات">تطوير تطبيقات الويب المفتوح</a>.</li> + <li><a href="/ar/Add-ons">تطوير إضافات الفايرفوكس</a>.</li> +</ul> + +<h2 dir="rtl" id="هدفنا">هدفنا</h2> + +<p dir="rtl">هدف شبكة مطوري موزيلا بسيط، فهي تهدف لتزويد المطورين بالمعلومات التي يحتاجونها ليتمكنوا من بناء مشاريع بسهولة على <a href="/ar/docs/Web">الويب المفتوح</a>. فإذا كانت تقنية مفتوحة متعلقة بالويب، فنحن نريد توثيقها.</p> + +<p dir="rtl">بالإضافة لذلك، نقوم بتوفير توثيقات حول <a href="/ar/docs/Mozilla">منتجات موزيلا</a> وكيف يمكنك <a href="/ar/docs/Mozilla/">بناء والمساهمة في مشاريع موزيلا</a>.</p> + +<p dir="rtl">إذا كنت لست متأكداَ إن كان موضوع معين يجب أن يوجد في شبكة مطوري موزيلا، أقرأ مقالة: <a href="/en-US/docs/Project:MDN/Contributing/Does_this_belong">هل ينتمي هذا إلى شبكة مطوري موزيلا؟</a></p> + +<h2 dir="rtl" id="كيف_يمكنك_المساعدة">كيف يمكنك المساعدة</h2> + +<p dir="rtl">أنت لست بحاجة لأن تكون قادراً على البرمجة - أو الكتابة جيداً - لتكون قادراً على مساعدة شبكة مطوري موزيلا! فنملك العديد من الطرق التي يمكنك المساعدة فيها، من إعادة كتابة المقالات لتجعلها منطقية، إلى إضافة العينات البرمجية. في الحقيقة، يوجد العديد من الطرق التي يمكنك المساعدة فيها ولذلك قمنا بكتابة مقالة <a href="/ar/docs/MDN/Getting_started">خطواتك الأولى</a> التي ستساعدك على انتقاء المهمات التي يمكنك القيام بها، اعتماداً على اهتماماتك وعلى وقتك. </p> + +<p dir="rtl">يمكنك المساعدة أيضاً عن طريق <a href="/en-US/docs/MDN/About/Promote">نشر شبكة مطوري موزيلا </a>على مدونتك أو موقعك.</p> + +<h2 dir="rtl" id="مجتمع_شبكة_مطوري_موزيلا">مجتمع شبكة مطوري موزيلا</h2> + +<p dir="rtl">مجتمعنا مجتمع عالمي! فنملك مساهمين رائعين من جميع أنحاء العالم، بأعداد مختلفة من اللغات. إذا أحببت معرفة المزيد حولنا، أو إذا أردت مساعدة شبكة مطوري موزيلا بأي طريقة، تحقق من <a href="https://discourse.mozilla-community.org/c/mdn">منتدى المناقشة</a> خاصتنا أو من <a href="irc://irc.mozilla.org#mdn">قناة IRC</a>. يمكنك أيضاً مواكبة أخبارنا عن طريق متابعة حسابنا على التويتر <a href="http://twitter.com/MozDevNet">@MozDevNet</a>. تستطيع أيضاً إرسال تغريدة لنا إن كنت ترى شيئاً خاطئاً أو إذا أردت تقديم تعليق لكتابِنا ومساهمينا.</p> + + + +<h2 dir="rtl" id="استخدام_محتوى_توثيقات_شبكة_مطوري_موزيلا">استخدام محتوى توثيقات شبكة مطوري موزيلا</h2> + +<h3 dir="rtl" id="حقوق_الطباعة_والنشر_والرخص">حقوق الطباعة والنشر والرخص</h3> + +<p dir="rtl">تم إنشاء <strong>توثيقات شبكة مطوري موزيلا </strong> من مساهمات للعديد من الأشخاص، البعض منهم من مؤسسة موزيلا والبعض الآخر من خارجها. <span class="short_text" id="result_box" lang="ar"><span>ما لم يذكر خلاف ذلك</span></span>، يتوفر المحتوى تحت بنود <a href="https://creativecommons.org/licenses/by-sa/2.5/deed.ar">رخصة المشاع الإبداعي نَسب المُصنَّف - الترخيص بالمثل</a>، الإصدار 2.5 فما فوق. يرجى إدراج "Mozilla Contributors" ("المساهمين في موزيلا") وإضافة رابط تشعيبي (على الأنترنت) أو عنوان URL (في المحتوى المطبوع) لتحديد الصفحة التي ينتمي إليها المحتوى المستشهد به. فعلى سبيل المثال، لتوفير إسناد لهذه المقالة، يمكنك كتابة:</p> + +<blockquote>مقالة <a href="https://developer.mozilla.org/ar/docs/MDN/About">حول شبكة مطوري موزيلا</a> من قبل <a href="https://developer.mozilla.org/en-US/docs/MDN/About$history">المساهمين في موزيلا</a> مرخصة تحت <a href="https://creativecommons.org/licenses/by-sa/2.5/deed.ar">رخصة المشاع الإبداعي نَسب المُصنَّف - الترخيص بالمثل</a>.</blockquote> + +<p dir="rtl">لاحظ في المثال أنَّ "المساهمين في موزيلا" تشير برابط إلى الصفحة المذكورة. اقرأ مقالة <a href="http://wiki.creativecommons.org/Marking/Users">أفضل الطرق للإسناد</a> للمزيد من التوضيح.</p> + +<div class="note"> +<p dir="rtl">اقرأ مقالة <a href="/en-US/docs/MDN_content_on_WebPlatform.org">محتوى شبكة مطوري موزيلا على موقع WebPlatform.org</a> للمزيد من المعلومات حول كيفيّة إعادة استخدام وإسناد محتوى شبكة مطوري موزيلا على ذاك الموقع.</p> +</div> + +<p dir="rtl">العينات البرمجية المضافة إلى الموسوعة قبل آب في 2010/20 متوفرة تحت <a href="https://opensource.org/licenses/mit-license.php">رخصة MIT</a>؛ يجب عليك إضافة معلومات الإسناد التالية إلى الرخصة: "© <تاريخ آخر مراجعة للصفحة> <اسم الشخص الذي أنشأ الصفحة>".</p> + +<p dir="rtl">العينات البرمجية المضافة إلى الموسوعة في أو بعد آب في 2010/20 متوفرة تحت رخصة <a href="https://creativecommons.org/publicdomain/zero/1.0/deed.ar">المشاع الإبداعي التخصيص للملك العام</a>. لا يلزم إشعار الترخيص، ولكن إذا أردت واحداً، يمكنك استخدام: "<span id="result_box" lang="ar"><span>أي حق للمؤلف مخصص للملك العام.</span> <span>http://creativecommons.org/publicdomain/zero/1.0/</span></span>".</p> + +<p dir="rtl">إذا أردت المساهمة في هذه الموسوعة، يجب عليك وضع مساهمتك تحت رخصة المشاع الإبداعي نَسب المُصنَّف - الترخيص بالمثل (أو أحياناً تحت رخصة بديلة مذكورة في الصفحة التي تحررها)، وعيناتك البرمجية يجب أن تكون متوفرة تحت رخصة <a href="https://creativecommons.org/publicdomain/zero/1.0/deed.ar">المشاع الإبداعي التخصيص للملك العام</a>. فبإضافة صفحة لهذه الموسوعة أنت توافق على وضع مساهماتك تحت تلك الرخص المذكورة.</p> + +<p dir="rtl">بعض المحتوى الأقدم مُرخص تحت رخصة أخرى غير مذكورة أعلاه؛ تلك رخصة مذكورة أسفل كل صفحة كما في الطريقة المذكورة في مقالة <a href="/Archive/Meta_docs/Examples/Alternate_License_Block">الترخيص البديل</a>.</p> + +<div class="warning"> +<div id="gt-res-content"> +<div class="trans-verified-button-small" dir="rtl" id="gt-res-dir-ctr"> +<div id="tts_button"><span id="result_box" lang="ar"><span>لا يمكن إنشاء صفحات جديدة باستخدام تراخيص بديلة</span></span></div> +</div> +</div> +</div> + +<p dir="rtl"><strong>تُعزا حقول الطبع والنشر للمواد الملحقة بالمساهمة للمؤلف ما لم يَعزُها لشخصٍ آخر.</strong></p> + +<p dir="rtl">إذا كان لديك أي سؤال أو أهتمام حول أي شيء تم مناقشته هنا، رجاءً تواصل مع <a href="mailto:eshepherd@mozilla.com">اريك شيبيرد</a>.</p> + +<hr> +<p dir="rtl"><span id="result_box" lang="ar"><span>الحقوق في العلامات التجارية والشعارات وعلامات الخدمة لمؤسسة موزيلا، فضلاً عن الشكل والمظهر في هذا الموقع، ليست مرخصة بموجب رخصة المشاع الإبداعي، وإلى الحد الذي هي أعمال التأليف (مثل الشعارات والتصميمات</span><span>)، فهي ليست مدرجة في العمل المرخص بموجب هذه الشروط.</span> <span>إذا كنت تستخدم نص المستندات، وترغب أيضا في استخدام أي من هذه الحقوق، أو إذا كان لديك أي أسئلة أخرى حول الامتثال لشروط الترخيص لهذه المجموعة، يجب عليك الاتصال بمؤسسة موزيلا: <a href="mailto:licensing@mozilla.org">license@mozilla.org</a>.</span></span></p> + +<h3 dir="rtl" id="الإشارة_إلى_شبكة_مطوري_موزيلا">الإشارة إلى شبكة مطوري موزيلا</h3> + +<p dir="rtl">اقرأ هذه المقالة للحصول على دليل إرشادي حول <a href="/en-US/docs/MDN/About/Linking_to_MDN">الإشارة إلى شبكة مطوري موزيلا</a> لمعرفة الطرق الأفضل عندما تقوم بالإشارة إلى شبكتنا.</p> + +<h2 dir="rtl" id="تحميل_المحتوى">تحميل المحتوى</h2> + +<p dir="rtl">يمكنك تحميل <a href="https://mdn-downloads.s3-us-west-2.amazonaws.com/developer.mozilla.org.tar.gz">النسخة الكاملة من شبكة مطوري موزيلا</a> (بحجم 2.1GB الذي رصد<span class="short_text" id="result_box" lang="ar"><span> في شباط 2017</span></span>).</p> + +<h4 dir="rtl" id="الصفحات_الفردية">الصفحات الفردية</h4> + +<p dir="rtl">يمكنك الحصول على محتوى صفحة فردية في شبكة مطوري موزيلا بإضافة <a href="/en-US/docs/MDN/Kuma/API#Document_parameters">معاملات الوثيقة</a> للرابط لتحديد الصيغة التي تريدها.</p> + +<h4 dir="rtl" id="أدوات_طرف_ثالث">أدوات طرف ثالث</h4> + +<p dir="rtl">يمكنك رؤية محتوى شبكة مطوري موزيلا باستخدام أدوات طرف ثالث مثل <a href="http://kapeli.com/dash">Dash</a> (لنظام ماك) و <a href="http://zealdocs.org/">Zeal</a> (لنظام لينُكس وويندوز).</p> + +<h2 dir="rtl" id="الإبلاغ_عن_مشاكل_في_توثيقات_شبكة_مطوري_موزيلا">الإبلاغ عن مشاكل في توثيقات شبكة مطوري موزيلا</h2> + +<p dir="rtl">اقرأ <a href="/en-US/docs/MDN/Contribute/Howto/Report_a_problem">كيف تُبلِّغ عن مشكلة في شبكة مطورين موزيلا</a>.</p> + +<h2 dir="rtl" id="تاريخ_توثيقات_شبكة_مطوري_موزيلا">تاريخ توثيقات شبكة مطوري موزيلا</h2> + +<p dir="rtl">بدأ مشروع وثائق شبكة مطوري موزيلا (مركز مطوري موزيلا سابقاً) في نهاية 2005، عندما حصلت مؤسسة موزيلا على ترخيص من AOL لاستخدام محتوى نيتسكيب <a href="https://web.archive.org/web/*/devedge.netscape.com" title="Project:en/DevEdge">DevEdge</a>. حيث تم استخراج المحتوى المفيد من DevEdge، وبعدها قام المتطوعون بالانتقال لهذه الموسوعة.</p> + +<p dir="rtl">يمكنك إيجاد المزيد عن تاريخ شبكة مطوري موزيلا على صفحة <a href="/en-US/docs/MDN_at_ten">احتفال الذكرة العاشرة</a>، حيث تحتوي على تاريخ الشفهي من قبل بعض الأشخاص الذين ساهموا في المشروع.</p> + +<h2 dir="rtl" id="حول_موزيلا">حول موزيلا</h2> + +<p dir="rtl">سواءً كنت تريد معرفة المزيد حول من نحن، أو كيف يمكنك أن تكون جزءً من <em>موزيلا</em> أو فقط تريد أن تعرف أين يمكنك إيجادنا، فأنت في المكان المناسب. <span id="result_box" lang="ar"><span>لمعرفة ما يدفعنا ويجعلنا مختلفين، يرجى زيارة صفحة <a href="http://www.mozilla.org/en-US/mission/">هدفنا</a>.</span></span></p> diff --git a/files/ar/mdn/community/index.html b/files/ar/mdn/community/index.html new file mode 100644 index 0000000000..5870ddd218 --- /dev/null +++ b/files/ar/mdn/community/index.html @@ -0,0 +1,46 @@ +--- +title: انضم إلى مجتمع شبكة مطوري موزيلا +slug: MDN/Community +tags: + - حول الشبكة +translation_of: MDN/Community +--- +<div>{{MDNSidebar}}</div><div>{{IncludeSubNav("/ar/docs/MDN")}}</div> + +<div class="summary"> +<p dir="rtl">تعد شبكة مطوري موزيلا أكثر من موسوعة: فهي مجتمع للمطورين الذين يعملون معاً لجعل هذه الشبكة مصدر بارز للمطورين الذين يرغبون باستخدام تقنيات الويب المفتوح.</p> +</div> + +<p dir="rtl">سنود أن تساهم في المشروع، ولكننا نود أكثر أن تشارك في مجمتع شبكة مطوري موزيلا. في الأسفل سنشرح كيف يمكنك المشاركة بثلاثة خطوات سهلة:</p> + +<ol dir="rtl"> + <li> <a href="/ar/docs/MDN/Contribute/Howto/Create_an_MDN_account">أنشئ حساب في شبكة مطوري موزيلا</a>.</li> + <li><a href="/ar/docs/MDN/Community/Conversations">انضم إلى المحادثات</a>.</li> + <li><a href="/ar/docs/MDN/Community/Whats_happening">تابع ما يحدث</a>.</li> +</ol> + +<h2 dir="rtl" id="كيف_يعمل_المجتمع">كيف يعمل المجتمع</h2> + +<p dir="rtl">يوجد أدناه مقالات أكثر تصف مجتمع شبكة مطوري موزيلا.</p> + +<div class="row topicpage-table"> +<div class="section"> +<dl> + <dt class="landingPageList" dir="rtl"><a href="/ar/docs/MDN/Community/Roles">رُتب المجتمع</a></dt> + <dd class="landingPageList" dir="rtl">يوجد عدد من الرُتب في مجتمع شبكة مطوري موزيلا والتي تملك صلاحيات ومسؤوليات معينة.</dd> + <dt class="landingPageList" dir="rtl"><a href="https://developer.mozilla.org/en-US/docs/MDN/Community/Doc_sprints">سباقات التوثيق</a></dt> + <dd class="landingPageList" dir="rtl">تعد هذه المقالة دليل لتنظيم سباق توثيق. فهي تحتوي على نصائح من أناس قاموا بتنظيم سباقات توثيق، ليساعدوك على تنظيم واحد أيضاً.</dd> + <dt class="landingPageList" dir="rtl"><a href="/ar/docs/MDN/Community/Whats_happening">تابع ما يحدث</a></dt> + <dd class="landingPageList" dir="rtl">يعمل <a href="https://wiki.mozilla.org/MDN">مجتمع شبكة مطوري موزيلا </a> على تقديم هذه الموسوعة لك. يوجد في هذه المقالة بعض الطرق لتبادل المعلومات حول ما نقوم به. </dd> +</dl> +</div> + +<div class="section"> +<dl> + <dt class="landingPageList" dir="rtl"><a href="/ar/docs/MDN/Community/Conversations">محادثات مجتمع شبكة مطورين موزيلا</a></dt> + <dd class="landingPageList" dir="rtl">تُقام علمية التوثيق على موقع شبكة مطوري موزيلا أما المجتمع فيعمل من خلال مناقشات ومحادثات ولقاءات على الإنترنت.</dd> + <dt class="landingPageList" dir="rtl"><a href="/ar/docs/MDN/Community/Working_in_community">العمل في المجتمع</a></dt> + <dd class="landingPageList" dir="rtl">الجزء الرئيسي من المساهمة في وثائق شبكة مطوري موزيلا هو معرفة كيفية العمل كجزء من المجتمع. تقدم هذه المقالة نصائح لتساعدك على<span id="result_box" lang="ar"><span> تحقيق أقصى استفادة من تفاعلك مع كل من الكتاب الآخرين وفرق التطوير.</span></span></dd> +</dl> +</div> +</div> diff --git a/files/ar/mdn/community/whats_happening/index.html b/files/ar/mdn/community/whats_happening/index.html new file mode 100644 index 0000000000..818472e420 --- /dev/null +++ b/files/ar/mdn/community/whats_happening/index.html @@ -0,0 +1,41 @@ +--- +title: اتبع ما يحدث +slug: MDN/Community/Whats_happening +translation_of: MDN/Community/Whats_happening +--- +<div>{{MDNSidebar}}</div> + +<p>MDN is brought to you by the <a href="https://wiki.mozilla.org/MDN">MDN community</a>. Here are some ways to that we share information about what we're doing.</p> + +<h2 id="المدونات">المدونات</h2> + +<dl> + <dt><a href="https://hacks.mozilla.org/" title="https://hacks.mozilla.org/">Mozilla Hacks</a></dt> + <dd> + <p>أخبار حول وتغطية متعمقة لتقنيات وميزات الويب و Mozilla.</p> + </dd> + <dt><a href="https://blog.mozilla.org/community/category/developer-engagement/">إشراك المطورين</a></dt> + <dd>تعزيز النشاط والمناقشة بين المجتمع المشترك في MDN في موزيلا.</dd> +</dl> + +<h2 id="Streams_of_ephemera">Streams of ephemera</h2> + +<ul> + <li><a href="http://twitter.com/MozDevNet">@MozDevNet</a>: صفحات مثيرة للاهتمام ، ودروس تعليمية ، وأدلة ، وطلبات التقديم ، وتحديثات هامة ، وغيرها من الأخبار حول شبكة مطور Mozilla.</li> + <li><a href="https://twitter.com/mozhacks" title="https://twitter.com/mozhacks">@MozHacks</a>: تغريدات حول تقنيات الويب الجديدة وتطبيقات HTML5 الرائعة وميزات Firefox.</li> + <li><a href="http://www.youtube.com/user/mozhacks" title="http://www.youtube.com/user/mozhacks">Mozilla Hacks (YouTube)</a></li> +</ul> + +<h2 id="لوحات_الحالة_ولوحات_المعلومات">لوحات الحالة ولوحات المعلومات</h2> + +<p>ألقِ نظرة على صفحات <a href="/ar/docs/MDN/Doc_status">حالة "الوثائق"</a> لمعرفة ما يجري عبر النطاق الكامل لمحتوى MDN. ستكون قادرًا على رؤية المقالات التي تحتاج إلى كتابتها أو تحديثها ، وما الموضوعات التي تحتاج إلى مزيد من المساعدة ، وأكثر من ذلك بكثير</p> + +<h2 id="اجتماعات_MDN">اجتماعات MDN</h2> + +<p>There are a number of regular meetings for tracking and sharing progress on various MDN-related projects and processes. These are described on the <a href="https://wiki.mozilla.org/MDN/Meetings">MDN meetings wiki page</a>.</p> + +<p>To get a general sense of what's happening, the best meeting to attend is the MDN Community meeting, which occurs every two weeks on Wednesdays, 10:00 US Pacific time (UTC-0800 October-March, UTC-0700 in March-October), in the <a href="irc://irc.mozilla.org/mdn" title="irc://irc.mozilla.org/devmo">#mdn</a> <a href="http://wiki.mozilla.org/IRC" title="http://wiki.mozilla.org/IRC">IRC</a> channel. See the <a href="https://wiki.mozilla.org/MDN/Meetings/Community" title="https://wiki.mozilla.org/MDN/Community_meetings">MDN community meetings</a> wiki page for agendas and notes from past meetings.</p> + +<p>The <a class="external text" href="https://www.google.com/calendar/embed?src=mozilla.com_2d35383434313235392d323530%40resource.calendar.google.com" rel="nofollow">Public MDN Events</a> calendar contains MDN community meetings, doc sprints, and other MDN-related events. If you see a meeting which takes place in the "mdn" channel on our Vidyo videoconferencing system, you can <a href="https://v.mozilla.com/flex.html?roomdirect.html&key=gMM1xZxpQgqiQFNkUR3eBuHgxg">join the conversation on the web</a>.</p> + +<div id="eJOY__extension_root"> </div> diff --git a/files/ar/mdn/contribute/feedback/index.html b/files/ar/mdn/contribute/feedback/index.html new file mode 100644 index 0000000000..9bd5d9e5d5 --- /dev/null +++ b/files/ar/mdn/contribute/feedback/index.html @@ -0,0 +1,74 @@ +--- +title: ارسل تعليقاتك حول الشبكة +slug: MDN/Contribute/Feedback +tags: + - التوثيق + - حول + - حول الشبكة + - دليل +translation_of: MDN/Contribute/Feedback +--- +<div>{{MDNSidebar}}</div> + +<div>{{IncludeSubnav("/ar/docs/MDN")}}</div> + +<p dir="rtl">مرحباً بك في شبكة مطوري موزيلا! <span class="seoSummary">إن كنت تملك أية إقتراحات، أو تواجه مشكلة في استخدام الشبكة، فهذه الصفحة مناسبة لك. في الحقيقة، مجرد اهتمامك بالتفاعل معنا يجعلك جزءً من مجتمع موزيلا، فشكراً مقدماً على هذا الاهتمام.</span></p> + +<p dir="rtl"><span class="seoSummary">يوجد عدة طرق لتقدم اقتراحك؛ وهذه المقالة ستساعدك على ذلك.</span></p> + +<h2 dir="rtl" id="حدِّث_التوثيقات">حدِّث التوثيقات</h2> + +<p dir="rtl">قبل كل شيء، إذا رأيت أي مشكلة بالتوثيقات، فعليك ألا تتردد أبدا بتصحيحها بنفسك.</p> + +<ol dir="rtl"> + <li>قم <a href="/ar/docs/MDN/Contribute/Howto/إنشاء_حساب_على_شبكة_مطوري_موزيلا">بتسجيل الدخول</a> باستخدام <a href="https://github.com/">GitHub</a>.</li> + <li>انقر على الزر الأزرق المسمى <strong>عدِّل</strong> (Edit)، الموجود بأي صفحة، لتفتح <a href="/ar/docs/MDN/Contribute/Editor">المُحرِر</a>.</li> + <li>انقر على الزر <strong>انشر</strong> (Publish) لتحتفظ بالتغييرات بعد انتهائك.</li> +</ol> + +<p dir="rtl">تعمل التوثيقات هنا بنظام الموسوعة، والتي يتم إدارتها من قبل مجموعة من المتطوعين والموظفين، لذلك لا تشعر بالخجل، فلا يجب أن تكون كتابتك القواعديّة مثالية. سنصحح لك إن أخطأت؛ لا ضرر في ذلك!</p> + +<p dir="rtl">للمزيد من المعلومات حول المساهمة في وثائق شبكة مطوري موزيلا، اقرأ:</p> + +<ul dir="rtl"> + <li>مقالة <a href="/ar/docs/MDN/Getting_started">خطواتك الأولى في شبكة مطوري موزيلا</a>، لتحصل على أفكار حول أشياء يمكنك القيام بها</li> + <li>مقالة <a href="/ar/docs/MDN/Contribute">ساهم في الشبكة</a></li> + <li>دليل <a href="/ar/docs/MDN/Contribute/Editor">مُحرر شبكة مطوري موزيلا</a>.</li> +</ul> + +<h2 dir="rtl" id="انضم_إلى_المحادثات">انضم إلى المحادثات</h2> + +<p dir="rtl">تحدث معنا! يوجد بضعة طرق للتواصل مع الآخرين الذين يعملون على محتوى الشبكة.</p> + +<h3 dir="rtl" id="الدردشة_المتزامنة">الدردشة (المتزامنة)</h3> + +<p dir="rtl">نستخدم <a href="https://wiki.mozilla.org/IRC">IRC</a> للتحدث عن الشبكة ومحتواها. يمكنك أنت أيضاً الانضمام إلى المحادثة! لدينا عدة قنوات لتختار منها بناءً على اهتمامك:</p> + +<dl> + <dt dir="rtl"><a href="irc://irc.mozilla.org/mdn" title="irc://irc.mozilla.org/mdn">محتوى موقع الشبكة (mdn#)</a></dt> + <dd dir="rtl">هذه القناة مخصصة للنقاش العام حول الشبكة، متضمنةً: استخدام الموقع، وقراءة المحتوى على الموقع، والمساهمة في محتوى الموقع. إذا كنت تملك سؤالاً أو تعليقاً حول محتوى مقالة، أو كنت ترغب في رؤية أو إنشاء مقالة جديدة، أو لمجرد أنك تريد التحدث مع فريق الكتابة، فهذه القناة مناسبة لك بالتأكيد.</dd> + <dt dir="rtl"><a href="irc://irc.mozilla.org/mdndev" title="irc://irc.mozilla.org/mdndev">تطوير موقع التوثيق (mdndev#)</a></dt> + <dd dir="rtl">تعد هذه القناة المكان الذي نتكلم فيه عن أعمال تطوير المنصة التي تعمل عليها الشبكة. فإذا كنت تواجه مشكلة مع إحدى وظائف الموقع، أو تملك فكرة لميزة جديدة، يمكنك الإنضمام إلينا.</dd> +</dl> + +<h3 dir="rtl" id="المناقشات_الغير_متزامنة">المناقشات (الغير متزامنة)</h3> + +<p dir="rtl">تَحدُث المناقشات الطويلة في <a href="https://discourse.mozilla-community.org/c/mdn">منتدى النقاش الخاص بالشبكة</a>. يمكنك النشر في المنتدى باستخدام البريد <a href="mailto://mdn@mozilla-community.org">mdn@mozilla-community.org</a>. إذا انضممت للمنتدى، يمكنك الحصول على إشعارات حول المناقشات عبر البريد الإلكتروني أيضاً.</p> + +<h2 dir="rtl" id="بلِّغ_عن_الأخطاء">بلِّغ عن الأخطاء</h2> + +<h3 dir="rtl" id="أخطاء_في_التوثيق">أخطاء في التوثيق</h3> + +<p dir="rtl">إذا وجدت مشكلة في التوثيق ولم تستطع إصلاحها لسببٍ ما، فيمكنك <a href="https://github.com/mdn/sprints/issues/new?template=issue-template.md&projects=mdn/sprints/2&labels=user-report">الإبلاغ عنها</a>! يمكنك استخدام هذه الاستمارة للتبليغ عن أي مشكلة متعلقة بالتوثيق، على سبيل المثال:</p> + +<ul dir="rtl"> + <li>تصحيح بسيط</li> + <li>طلب فقرة جديدة ليتم إضافتها للمحتوى</li> + <li>الإبلاغ عن محتوى غير لائق (مثل محتوى غير مرغوب أو ترجمة ليست في مكانها الصحيح)</li> +</ul> + +<p dir="rtl">كما ذكرنا سابقاً، ندعوك للمساهمة في تلك التغييرات بنفسك، ولكن هذا الخيار متوفر أيضاً.</p> + +<h3 dir="rtl" id="أخطاء_في_الموقع">أخطاء في الموقع</h3> + +<p dir="rtl">إذا واجهت مشكلة في موقع الشبكة، أو كنت تملك فكرة لميزة جديدة، فيمكنك <a href="https://bugzilla.mozilla.org/form.mdn">فتح تذكرة لفريق التطوير</a>.</p> diff --git a/files/ar/mdn/contribute/getting_started/index.html b/files/ar/mdn/contribute/getting_started/index.html new file mode 100644 index 0000000000..6721236823 --- /dev/null +++ b/files/ar/mdn/contribute/getting_started/index.html @@ -0,0 +1,107 @@ +--- +title: خطواتك الأولى في الشبكة +slug: MDN/Contribute/Getting_started +tags: + - الإرشادات + - البداية + - الدليل + - المبتدئين + - المقدمة + - حول الشبكة + - دليل +translation_of: MDN/Contribute/Getting_started +--- +<div>{{MDNSidebar}}</div><div>{{IncludeSubnav("/ar/docs/MDN")}}</div> + +<p dir="rtl"><span id="result_box" lang="ar"><span>نحن مجتمع مفتوح من المطورين والكتاب نبني موارد لتحسين شبكة الإنترنت</span></span>، <span id="result_box" lang="ar"><span>بغض النظر عن العلامة التجارية، أو المتصفح، أو النظام الأساسي.</span> <span>يمكن لأي شخص المساهمة وكل شخص يجعلنا أقوى.</span> <span>معاً يمكننا الاستمرار في دفع الابتكار على شبكة الإنترنت لخدمة الخير.</span> كل شيء <span>يبدأ هنا، وبمساعدتك.</span></span></p> + +<p dir="rtl"><span id="result_box" lang="ar"><span>يتم بناء كل جزء من الشبكة </span></span><span id="result_box" lang="ar"><span>(من التعليمات البرمجية التي تجعل الموقع يعمل إلى العينات البرمجية والعروض التوضيحية) </span></span><span lang="ar"><span>من قبل مجتمع من المطورين والكُتّاب.</span> <span>كلٌ منا يمكنه ان يقدم شيء، ونأمل أن تفعل ذلك أيضاً!</span></span></p> + +<h2 dir="rtl" id="ثلاث_خطوات_سهلة_للبدء">ثلاث خطوات سهلة للبدء</h2> + +<p dir="rtl"><span class="seoSummary">شبكة مطوري موزيلا هي عبارة عن موسوعة، حيث يمكن <strong>للجميع </strong>أن يضيف أو يعدل المحتوى. لست ملزمًا أن تكون مبرمجاً أو أن تكون مُلِمَّاً بقدر كبير من التقنية، هناك الكثير من الأشياء التي يجب فعلها، بدءاً من المهام السهلة مثل التدقيق اللغوي أو تصحيح الأخطاء المطبعيّة، إلى تلك المهام الصعبة مثل كتابة وثائق للواجهات البرمجيّة. هذا الدليل سيساعدك على إيجاد أفضل طريقة للمساعدة في تحسين محتوى الشبكة.</span></p> + +<p dir="rtl">المساهمة هنا سهلة وآمنة. حتى لو قمت بخطأٍ ما، فيمكن إصلاحه بسهولة؛ إذا كنت لا تعلم كيف يفترض أن تبدو الصفحات، أو أن مهاراتك اللغويّة ليست ممتازة، فلا تقلق حيال ذلك! لدينا فريق من الأشخاص الذين أوكلنا إليهم الحرص على جودة محتوى الشبكة وظهوره بأفضل شكل ممكن. سيتأكد شخص ما من أنّ ما قمت بكتابته يظهر بشكل أنيق ومكتوب بشكل صحيح. شارك معرفتك وابذل كل جهدك، وكن على ثقة بأنَّ بقيّة أفراد المجتمع سيجعلون عملك يظهر بشكل أفضل مما تتصور.</p> + +<h3 dir="rtl" id="الخطوة_الأولى_أنشئ_حساباً_على_الشبكة">الخطوة الأولى: أنشئ حساباً على الشبكة</h3> + +<p dir="rtl">لتبدأ المساهمة يجب عليك امتلاك حساب في الشبكة. للمزيد من التفاصيل، رجاءً اقرأ <a href="/ar/docs/MDN/Contribute/Howto/Create_an_MDN_account">كيف تقوم بإنشاء حساب</a>. لاحظ أنّك<a href="https://github.com/join"> ستحتاج إلى حساب جيتهاب</a> قبل أن تنشئ واحداً على الشبكة، حيث أننا نقوم باستخدام الجيتهاب كوسيلة للمصادقة في الوقت الراهن.</p> + +<h3 dir="rtl" id="الخطوة_الثانية_اختر_مهمة">الخطوة الثانية: اختر مهمة</h3> + +<p dir="rtl">الآن وقد سجلت الدخول، اقرأ معلومات حول أنواع المهمات المختلفة في {{anch("أنواع المهام المتاحة", "القائمة أدناه")}}، واختر أيهم أنسب لك. يمكنك اختيار أي مهمة تريدها والبدء بالمساهمة.</p> + +<p dir="rtl">تفضل وطالع مقالة <a href="/ar/docs/MDN/Contribute/Howto/Create_and_edit_pages">كيفَ تحصل على صلاحيّة إنشاء الصفحات</a> في حال احتجت لإنشاء صفحة جديدة أثناء أداء مهماتك. لاحظ أنَّ الحسابات الجديدة لا تمتلك القدرة على إنشاء صفحات جديدة، افتراضياً، لأسباب أمنيّة.</p> + +<h3 dir="rtl" id="الخطوة_الثالثة_أنجز_المهمة">الخطوة الثالثة: أنجز المهمة</h3> + +<p dir="rtl">عندما تختار نوع المهمة التي تريدها، ابحث عن صفحة أو شيفرة أو أمثلة ...إلخ لكي تبدأ به، وقم بها فقط!</p> + +<p dir="rtl">لا تقلق حول جودة عملك؛ المساهمون الآخرون في الشبكة موجودون هنا لإصلاح الأخطاء التي تسقط منك سهوًا. إذا كانت لديك أسئلة لتطرحها، اذهب لصفحة <a href="/ar/docs/MDN/Community">المجتمع</a> لمعلومات حول القوائم البريدية وقنوات الدردشة حيث يمكنك إيجاد إجابات لأسئلتك.</p> + +<div class="note" dir="rtl"> +<p>إذا كنت تريد تعديل بعض الصفحات على الشبكة بغرض التجربة فقط قبل القيام بذلك على الصفحات الرئيسية، فنحن قد وفرنا لك <strong><a href="/ar/docs/Sandbox">صفحة تجريبيّة</a></strong> حيث يمكنك تجربة ما تشاء فيها. ومن فضلك قم بكل تجاربك في تلك الصفحة فقط. ولا تقم بتعديلات غير ضروريّة للصفحات الأخرى لكي ترى ما الذي قد يحدث؛ فهذا قد يتسبب بمشاكل للآخرين فلا يمكنهم إصلاحها أو أسوأ من ذلك، فقد تتسبب بتضليل القراء الذين يبحثون عن معلومة.</p> +</div> + +<p dir="rtl">عندما تنتهي من القيام بمهمتك، يمكنك البدء بواحدة أخرى، أو اقرأ حول {{anch("أشياء أُخرى يمكنك فعلها على الشبكة", "أشياء أُخرى يمكنك فعلها على الشبكة")}}.</p> + +<h2 dir="rtl" id="أنواع_المهام_المتاحة">أنواع المهام المتاحة</h2> + +<p dir="rtl">هناك العديد من السبل التي يمكنك اتباعها للمساهمة في الشبكة، اعتماداً على مهاراتك واهتماماتك. على الرغم من وجود العديد من المهام الشاقة، إلاّ أنه توجد الكثير من المهام السهلة المتوفر أيضاً. الكثير منها لا يتطلب سوى خمسة دقائق من وقتك (أو أقل!). أدناه، إلى جانب المهمة ووصف قصير لها، ستجد الوقت التقريبي الذي تأخذه كل مهمة للقيام بها.</p> + +<h3 dir="rtl" id="الخيار_الأول_أحب_الكتابة!">الخيار الأول: أحب الكتابة!</h3> + +<p dir="rtl">يمكنك مساعدتنا بمراجعة أو تحرير الوثائق، وإضافة الوسوم المناسبة لها.</p> + +<ul dir="rtl"> + <li><a href="/ar/docs/MDN/Contribute/Howto/Set_the_summary_for_a_page">إضافة ملخص للصفحة</a> (من خمس دقائق إلى خمس عشرة دقيقة)</li> + <li><a href="/ar/docs/MDN/Contribute/Howto/Do_an_editorial_review">القيام بمراجعات تعديلية</a> (من خمسة دقائق إلى ثلاثين دقيقة)</li> + <li><a href="/ar/docs/MDN/Contribute/Howto/Write_a_new_entry_in_the_Glossary">كتابة مصطلح جديد في الفهرس</a> (من خمس عشرة دقيقة إلى ساعة)</li> + <li><a href="/ar/docs/MDN/Contribute/Howto/Write_an_article_to_help_learn_about_the_Web">كتابة مقالة لمساعدة الناس على تعلم الويب</a> (من ساعة إلى ساعتين)</li> +</ul> + +<div class="note" dir="rtl">إن كنت تكتب أو تراجع المقالات، فيرجى أن تقرأ <a href="/ar/docs/MDN/Contribute/Guidelines/Style_guide">دليل التنسيق</a>. هذا سيساعدك على التأكد أن المقالة متسقة ومُنسَّقة.</div> + +<h3 dir="rtl" id="الخيار_الثاني_أحب_البرمجة!">الخيار الثاني: أحب البرمجة!</h3> + +<p dir="rtl">نحتاج المزيد من العينات البرمجية! يمكنك أيضاً المساعدة ببناء المنصة التي يعمل عليها الموقع (منصة <a href="/ar/docs/MDN/Kuma">Kuma</a>).</p> + +<ul dir="rtl"> + <li><a href="/ar/docs/MDN/Contribute/Howto/Convert_code_samples_to_be_live">قم بتشغيل العينات البرمجية بشكل "حي"</a> (ثلاثين دقيقة)</li> + <li><a href="https://wiki.mozilla.org/Webdev/GetInvolved/developer.mozilla.org">اقرأ دليل البدء في التطوَّع</a> (ثلاثين دقيقة)</li> + <li><a href="http://kuma.readthedocs.org/en/latest/installation.html">قم بتثبيت بيئة بناء برمجية Kuma</a> (ساعة واحدة)</li> + <li><a href="https://github.com/mozilla/kuma#readme">ارسل الترقيعات البرمجية إلى قاعدة شيفرات برمجية Kuma</a> (ساعة واحدة)</li> +</ul> + +<h3 dir="rtl" id="الخيار_الثالث_أحب_الكتابة_والبرمجة!">الخيار الثالث: أحب الكتابة والبرمجة!</h3> + +<p dir="rtl">لدينا مهام تتطلب المهارتين التقنية واللغوية معاً، ككتابة مقالات جديدة، أو المراجعة للدقة التقنية، أو تكييف الوثائق.</p> + +<ul dir="rtl"> + <li><a href="/ar/docs/MDN/About/Promote">انشر الشبكة على موقعك</a> (خمسة دقائق)</li> + <li><a href="/ar/docs/MDN/Contribute/Howto/Do_a_technical_review">قم بمراجعات تقنية</a> (ثلاثين دقيقة)</li> + <li><a href="/ar/docs/Contribute_to_docs_that_are_currently_needed">اكتب مقالة جديدة حول موضوع مطلوب حالياً</a> (ساعة أو أكثر)</li> + <li><a href="/ar/docs/MDN/Contribute/Howto/Create_an_interactive_exercise_to_help_learning_the_web">أنشئ تمرين تفاعلي لتساعد الناس على تعلم الويب</a> (ساعة أو أكثر)</li> + <li><a href="/ar/docs/MDN/Contribute/Howto/Resolve_a_mentored_developer_doc_request">أصلح علّة في الوثائق</a> في <a href="http://www.joshmatthews.net/bugsahoy/?mdn=1">تصنيفات الشبكة في جامع العلل</a> (ساعة أو أكثر)</li> +</ul> + +<h3 dir="rtl" id="الخيار_الرابع_أريد_الشبكة_بلغتي!">الخيار الرابع: أريد الشبكة بلغتي!</h3> + +<p dir="rtl">جميع الترجمات التي تتم في الشبكة تكون بفضل مجتمعنا الرائع من المتطوعين.</p> + +<ul dir="rtl"> + <li><a href="/ar/docs/MDN/Contribute/Localize/Translating_pages">ترجمة الصفحات</a> (ساعتين)</li> + <li>التواصل مع مترجمين آخرين المسرودين في صفحة <a href="/ar/docs/MDN/Contribute/Localize/Localization_projects">مشاريع الترجمة</a> (ثلاثين دقيقة)</li> +</ul> + +<h3 dir="rtl" id="الخيار_الخامس_وجدت_بعض_المعلومات_الخاطئة_ولكن_لا_أعلم_كيفية_إصلاحها!">الخيار الخامس: وجدت بعض المعلومات الخاطئة ولكن لا أعلم كيفية إصلاحها!</h3> + +<p dir="rtl">يمكنك الإبلاغ عنها عبر <a href="https://bugzilla.mozilla.org/form.doc">ملء استمارة الإبلاغ</a> (خمسة دقائق)</p> + +<h2 dir="rtl" id="أشياء_أُخرى_يمكنك_فعلها_على_الشبكة">أشياء أُخرى يمكنك فعلها على الشبكة</h2> + +<ul dir="rtl"> + <li><a href="/ar/docs/MDN/Community">انضم لمجتمع شبكة مطوري موزيلا</a>.</li> + <li><a href="/ar/profile">املأ ملفك الشخصي</a> ليعلم الآخرون المزيد عنك.</li> + <li>تعلم المزيد حول <a href="/ar/docs/MDN/Contribute">المساهمة في الشبكة</a>.</li> +</ul> diff --git a/files/ar/mdn/contribute/howto/do_a_technical_review/index.html b/files/ar/mdn/contribute/howto/do_a_technical_review/index.html new file mode 100644 index 0000000000..72774721a9 --- /dev/null +++ b/files/ar/mdn/contribute/howto/do_a_technical_review/index.html @@ -0,0 +1,67 @@ +--- +title: كيفية القيام بمراجعة فنية +slug: MDN/Contribute/Howto/Do_a_technical_review +translation_of: MDN/Contribute/Howto/Do_a_technical_review +--- +<div>{{MDNSidebar}}</div> + +<div>{{IncludeSubnav("/en-US/docs/MDN")}}</div> + +<p class="summary">تتكون <strong>المراجعة الفنية</strong> من مراجعة الدقة الفنية واكتمال مقال ما وتصحيحه إذا لزم الأمر. إذا أراد كاتب مقال أن يقوم شخص آخر بالتحقق من المحتوى الفني لمقال ما ، فإن الكاتب يضع علامة اختيار في خانة "المراجعة الفنية" أثناء التحرير. غالبًا ما يتصل الكاتب بمهندس معين لإجراء المراجعة الفنية ، ولكن يمكن لأي شخص لديه خبرة فنية في الموضوع أن يفعل ذلك.</p> + +<p>توضح هذه المقالة كيفية إجراء مراجعة فنية ، مما يساعد على ضمان دقة محتوى MDN</p> + +<p dir="rtl"><strong>ما هي المهمة؟</strong></p> + +<dl> + <dd dir="rtl">مراجعة وتصحيح المقالات للتأكد من دقتها واكتمالها.</dd> + <dt dir="rtl">أين يجب القيام به؟</dt> + <dd dir="rtl">في مقالات محددة تم وضع علامة على أنها تتطلب <a href="https://developer.mozilla.org/en-US/docs/needs-review/technical">مراجعة فنية</a>.</dd> + <dt dir="rtl">ما الذي تحتاج إلى معرفته لأداء المهمة؟</dt> + <dd> + <ul> + <li dir="rtl">معرفة الخبراء بموضوع المقالة التي تراجعها. إذا كانت قراءة المقال لا تعلمك أي شيء جديد ، فاعتبر نفسك خبيرًا.</li> + <li> + <p dir="rtl">كيفية تحرير مقالة ويكي على MDN.</p> + </li> + </ul> + </dd> + <dt> + <p>ما هي خطوات القيام بذلك؟</p> + </dt> + <dd> + <ol> + <li>اختيار مقال للمراجعة: + <ol> + <li>انتقل إلى قائمة الصفحات التي تحتاج إلى <a href="https://developer.mozilla.org/en-US/docs/needs-review/technical">مراجعات فنية</a>. هذا يسرد جميع الصفحات التي طلبت مراجعة فنية لها.</li> + <li>اختر صفحة موضوعك مألوفة لديك.</li> + <li>انقر على رابط المقال لتحميل الصفحة.</li> + </ol> + </li> + <li>اقرأ المقال ، مع إيلاء اهتمام وثيق للتفاصيل الفنية: هل المقال صحيح؟ هل هناك شيء مفقود؟ لا تتردد في التبديل إلى صفحة مختلفة إذا كانت أول صفحة تختارها لا تناسبك. + <ol> + </ol> + </li> + <li>إذا لم تكن هناك أخطاء ، فلن تحتاج إلى تعديل المقالة لوضع علامة عليها كمراجعة. ابحث عن مربع "المراجعة السريعة" في الشريط الجانبي الأيسر من الصفحة. يسرد هذا المربع الأصفر أي مراجعات معلقة ويسمح لك بمسح علامة طلب المراجعة. يبدو مثل هذا إذا تم طلب مراجعة فنية:<br> + <img alt="Screenshot of the sidebar's box listing reviews that have been requested and allowing the flags to be changed." src="https://mdn.mozillademos.org/files/13016/SidebarTechReviewRequested.png"></li> + <li> + <p>ألغ تحديد مربع الاختيار <strong>الفني</strong> ، وانقر فوق "<strong>حفظ</strong>".</p> + </li> + <li> + <p>إذا وجدت أخطاء تحتاج إلى تصحيح ، فسيسعدك معرفة أنه يمكنك أيضًا تغيير حالة طلب المراجعة من داخل المحرر. إليك سير العمل:</p> + + <ol> + <li>لتحرير الصفحة ، انقر فوق الزر "<strong>تحرير</strong>" بالقرب من أعلى الصفحة ؛ هذا يضعك في محرر MDN.</li> + <li>إصلاح أي معلومات فنية غير صحيح ، و / أو إضافة أي معلومات مهمة مفقودة.</li> + <li>أدخل <strong>تعليق المراجعة</strong> في أسفل المقال. هذه رسالة مختصرة تصف ما قمت به ، مثل "إكمال المراجعة الفنية". إذا قمت بتصحيح المعلومات ، فقم بتضمينها في تعليقك ، على سبيل المثال "المراجعة الفنية وأوصاف المعلمات الثابتة". يساعد ذلك المساهمين الآخرين ومحرري الموقع في معرفة ما الذي قمت بتغييره ولماذا. يمكنك أيضًا ذكر ما إذا كانت هناك وحدات بت محددة لم تشعر أنها مؤهلة للمراجعة</li> + <li>ألغ تحديد المربع<strong> الفني</strong> تحت <strong>المراجعة المطلوبة</strong>؟ أسفل منطقة تعليق المراجعة بالصفحة.</li> + <li>انقر على زر <strong>نشر</strong>.</li> + </ol> + </li> + </ol> + + <p dir="rtl">تهانينا! لقد أنهيت أول مراجعة فنية لك! شكرا لك على مساعدتك!</p> + </dd> +</dl> + +<div id="eJOY__extension_root"> </div> diff --git a/files/ar/mdn/contribute/howto/do_an_editorial_review/index.html b/files/ar/mdn/contribute/howto/do_an_editorial_review/index.html new file mode 100644 index 0000000000..1ba5c000fd --- /dev/null +++ b/files/ar/mdn/contribute/howto/do_an_editorial_review/index.html @@ -0,0 +1,58 @@ +--- +title: كيفية القيام بمراجعة تحريرية +slug: MDN/Contribute/Howto/Do_an_editorial_review +translation_of: MDN/Contribute/Howto/Do_an_editorial_review +--- +<div>{{MDNSidebar}}</div> + +<div>{{IncludeSubnav("/en-US/docs/MDN")}}</div> + +<p class="summary"><strong>Editorial reviews</strong> consist of fixing typos, spelling, grammar, usage, or textual errors in an article. One does not have to be a writing expert to make valuable contributions to MDN's technical documentation, but articles still need copy-editing and proof-reading. This is done in an editorial review.</p> + +<p class="simple-translate-result" dir="rtl" style="color: rgb(0, 0, 0);"><span class="seoSummary">توضح هذه المقالة كيفية إجراء مراجعة تحريرية ، مما يساعد على ضمان دقة محتوى MDN وكتابته بشكل جيد.</span></p> + +<dl> + <dt>ما هي المهمة؟</dt> + <dd> + <p class="simple-translate-result" style="color: rgb(0, 0, 0);">تحرير النسخ وقراءة التجارب للمقالات التي تم تحديدها على أنها تتطلب مراجعة تحريرية.</p> + </dd> + <dt> + <p class="simple-translate-result" style="color: rgb(0, 0, 0);">أين يجب القيام به؟</p> + </dt> + <dd> + <p class="simple-translate-result" style="color: rgb(0, 0, 0);">ضمن مقالات محددة تم تعليمها على أنها تتطلب مراجعة افتتاحية.</p> + </dd> + <dt>ما الذي تحتاج إلى معرفته لأداء المهمة؟</dt> + <dd>You need to have good English grammar and spelling skills. An editorial review is about ensuring that the grammar, spelling, and wording are correct and make sense, and that the <a href="/en-US/docs/MDN/Contribute/Guidelines/Writing_style_guide">MDN writing style guide</a> is followed.</dd> + <dt> + <p class="simple-translate-result" style="color: rgb(0, 0, 0);">ما هي خطوات القيام بذلك؟</p> + </dt> + <dd> + <ol> + <li>Pick an article to review: + <ol> + <li>Go to the list of <a href="/en-US/docs/needs-review/editorial">articles needing editorial review</a>. This lists all the pages for which an editorial review has been requested.</li> + <li>Click on the article link to load the page.<br> + <strong>Note: </strong>This listing is generated automatically but infrequently, so some articles appear on the list that no longer need editorial review. If the article you picked does <em>not</em> display a banner that says "This article needs an editorial review", skip that article and pick a different one.</li> + </ol> + </li> + <li id="core-steps">Read the article carefully, looking out for typos, spelling, grammar, or usage errors. Don't hesitate to switch to a different page if the first one you choose doesn't suit you.</li> + <li>If there are no errors, you don't need to edit the article to mark it as reviewed. Look for the "quick review" box in the left sidebar of the page:<br> + <img alt="Screenshot of the editorial review request sidebar box" src="https://mdn.mozillademos.org/files/13018/SidebarReviewBoxEditorial.png"></li> + <li>Deselect the <strong>Editorial</strong> box and click <strong>Save</strong>.</li> + <li>If you find errors that need to be corrected: + <ol> + <li>Click the <strong>Edit</strong> button near the top of the page; this brings you into the <a href="/en-US/docs/Project:MDN/Contributing/Editor_guide">MDN editor</a>.</li> + <li>Correct any typos and spelling, grammar, or usage errors you find. You don't have to fix everything to be useful, but be sure to leave the editorial review request in place if you don't feel reasonably sure that you've done a complete review of the entire article.</li> + <li>Enter a <strong>Revision Comment</strong> at the bottom of the article; something like '<em>Editorial review: fixed typos, grammar & spelling.</em>' This lets other contributors and site editors know what you changed and why.</li> + <li>Deselect the <strong>Editorial</strong> box under <strong>Review Needed?</strong>. This is located just below the Revision Comment section of the page.</li> + <li>Click the <strong>Publish</strong> button.</li> + </ol> + </li> + </ol> + + <div class="note"> + <p class="simple-translate-result" dir="rtl" style="color: rgb(0, 0, 0);">التغييرات الخاصة بك قد لا تكون مرئية مباشرة بعد الحفظ ؛ قد يكون هناك تأخير أثناء معالجة الصفحة وحفظها.</p> + </div> + </dd> +</dl> diff --git a/files/ar/mdn/contribute/howto/index.html b/files/ar/mdn/contribute/howto/index.html new file mode 100644 index 0000000000..6623e08af6 --- /dev/null +++ b/files/ar/mdn/contribute/howto/index.html @@ -0,0 +1,16 @@ +--- +title: How-to guides +slug: MDN/Contribute/Howto +tags: + - Documentation + - Landing + - MDN + - NeedsTranslation + - TopicStub +translation_of: MDN/Contribute/Howto +--- +<div>{{MDNSidebar}}</div><div>{{IncludeSubnav("/ar/docs/MDN")}}</div> + +<p>These articles provide step-by-step guides to accomplishing specific goals when contributing to MDN.</p> + +<p>{{LandingPageListSubpages}}</p> diff --git a/files/ar/mdn/contribute/howto/report_a_problem/index.html b/files/ar/mdn/contribute/howto/report_a_problem/index.html new file mode 100644 index 0000000000..32a5b16087 --- /dev/null +++ b/files/ar/mdn/contribute/howto/report_a_problem/index.html @@ -0,0 +1,22 @@ +--- +title: كيفية الإبلاغ عن مشكلة في MDN +slug: MDN/Contribute/Howto/Report_a_problem +translation_of: MDN/Contribute/Howto/Report_a_problem +--- +<div>{{MDNSidebar}}</div> + +<p>Now and then, you may run into problems while using MDN. Whether it's a problem with site infrastructure or an error in documentation content, you can either try to fix it yourself or report the problem. While the former is preferred, the latter is sometimes the best you can manage, and that's okay too.</p> + +<h2 id="Documentation_errors_or_requests">Documentation errors or requests</h2> + +<p>Obviously, since MDN is a wiki, the best thing you can possibly do is fix problems you spot yourself. But maybe you don't know the answer or are in the middle of a deadline on your own project or something, and need to jot down the problem so someone can look at it later.</p> + +<p>The way to report a documentation problem by filing an <a href="https://github.com/mdn/sprints/issues/new?template=issue-template.md&projects=mdn/sprints/2&labels=user-report">documentation issue</a>. The issue template contains sections for the information needed to get us started on fixing the issue. Feel free to delete any part of the template that isn't helpful or relevant to your issue.</p> + +<p>Of course, our writing community is busy, so sometimes the quickest way to see a documentation problem resolved is to fix it yourself. See <a href="/en-US/docs/MDN/Contribute/Howto/Create_and_edit_pages" title="/en-US/docs/Project:MDN/Contributing/Creating_and_editing_pages">How to create and edit pages</a> for details. </p> + +<h2 id="Site_bugs_or_feature_requests">Site bugs or feature requests</h2> + +<p><a href="/en-US/docs/MDN/Kuma" title="/en-US/docs/Project:MDN/Kuma">Kuma</a>, the Mozilla-developed platform used for the MDN web site, is in a state of continuous development. Our developers—as well as a number of volunteer contributors—are constantly making improvements. If you see a bug, or have a problem with the site, or even have a suggestion for something that could make the software more awesome, you can use the <a href="https://github.com/mdn/kuma/issues/new">Kuma bug form</a> to file a report. You can also use this form to report performance problems with the site, though odds are that performance-monitoring tools have already notified the appropriate people.</p> + +<div id="eJOY__extension_root"></div> diff --git a/files/ar/mdn/contribute/howto/set_the_summary_for_a_page/index.html b/files/ar/mdn/contribute/howto/set_the_summary_for_a_page/index.html new file mode 100644 index 0000000000..7f1598cb01 --- /dev/null +++ b/files/ar/mdn/contribute/howto/set_the_summary_for_a_page/index.html @@ -0,0 +1,116 @@ +--- +title: How to set the summary for a page +slug: MDN/Contribute/Howto/Set_the_summary_for_a_page +translation_of: MDN/Contribute/Howto/Set_the_summary_for_a_page +--- +<div>{{MDNSidebar}}</div> + +<div>{{IncludeSubnav("/en-US/docs/MDN")}}</div> + +<p><span class="seoSummary">في هذه المقالة ، سنعرض كيفية تعيين ملخص تحسين محركات البحث (المعروف أيضًا بالوصف أو ملخصًا فقط) لمقالة على موقع مستندات ويب MDN. يستخدم الملخص بعدة طرق:</span></p> + +<ul> + <li> يتم استخدام جوجل ومحركات البحث الاخرى للمساعدة على فهرسة الصفحات.</li> + <li>تعرض محركات البحث الملخص في صفحات نتائج البحث لمساعدة القراء على اختيار الصفحة الأكثر تطابقاً لاحتياجاتهم.</li> + <li>غالبًا ما تعرض قوائم MDN والصفحات المقصودة للموضوع الملخص أسفل عنوان المقالة ، ومرة أخرى لمساعدة المستخدمين في العثور على المعلومات التي يبحثون عنها.</li> + <li>تحتوي الروابط على MDN بشكل متكرر على تلميحات تحتوي على نص الملخص ، لتوفير نظرة سريعة للمستخدمين دون الحاجة إلى النقر على المقالة نفسها.</li> +</ul> + +<p>لذلك ، يجب أن يكون الملخص نصًا منطقيًا في سياق المقالة نفسها وكذلك عند تقديمه بمفرده في سياقات أخرى. يجب عليك أيضًا الاحتفاظ بدليل نمط كتابة <a href="https://developer.mozilla.org/en-US/docs/MDN/Contribute/Guidelines/Writing_style_guide">MDN </a>في الاعتبار أثناء كتابة نص الملخص.</p> + + + +<h2 dir="rtl" id="الملخص_الافتراضي">الملخص الافتراضي</h2> + +<p dir="rtl">تعتمد الصفحات التي لا تحتوي أي ملخص على الملخص الافتراضي.<br> + بشكل افتراضي يعتبر ملخص الصفحة هو أول قسم من الصفحة مكتوب ب <br> + {{Glossary("HTML")}}<br> + لذلك من الممكن أي يكون الملخص عبارة عن نص وليس عنوان. </p> + +<p dir="rtl">هذا النص ليس الأفضل للاستخدام دائما ولكن ولبعض الأسباب المذكورة أدناه يعتبر أفضل استخدام.</p> + +<ul dir="rtl"> + <li>النص الأول يعتبر شيء جانبي أو ملاحظة ما, ولا يقدم أي مراجعة كاملة للصفحة</li> + <li><span style="font-size: 1rem; letter-spacing: -0.00278rem;">أول نص مكتوب يعتبر نص محتوى ولكن لا يقدم مراجعة كاملة لمحتوى المقالة</span></li> + <li><span style="font-size: 1rem; letter-spacing: -0.00278rem;">النص طويل أو قصير للغاية</span></li> +</ul> + +<p dir="rtl">من الأفضل كتابة وتحديد ملخص الصفحة لضمان سهولة قراءة الملخصات واعتبارها مفيدة بقدر الإمكان.</p> + +<h2 id="Setting_the_summary">Setting the summary</h2> + +<p>Let's look at how to go about setting a page's summary.</p> + +<dl> + <dt><strong>What is the task?</strong></dt> + <dd>Marking the text within a page that should be used as its summary in other contexts; if appropriate text isn't already available, this task might include writing a small amount of appropriate text.</dd> + <dt><strong>Where does it need to be done?</strong></dt> + <dd>On pages that lack a summary, have a summary that isn't helpful, or have a summary that unnecessarily fails to meet recommended guidelines.</dd> + <dt><strong>What do you need to know to do the task?</strong></dt> + <dd>Ability to use the MDN editor; good English writing skills; enough familiarity with the topic of the page to write a good summary.</dd> + <dt><strong>What are the steps to do it?</strong></dt> +</dl> + +<ul> + <li>Pick a page on which to set the summary. If you already have one in mind, great! You can skip to step 2; otherwise, to find a page to fix: + <ol> + <li>In the <a href="/en-US/docs/MDN/Doc_status">MDN documentation status</a> page, click the link under <strong>Sections</strong> for a topic that you know something about (for example, HTML):<br> + <img alt="" src="https://mdn.mozillademos.org/files/8681/sections.png" style="height: 130px; width: 504px;"></li> + <li>On the topic's documentation status page, click the <strong>Pages</strong> header in the <strong>Summary</strong> table. This takes you to an index of all the pages in that topic section; it shows the page links in the left column, and the tags and summaries in the right column:<br> + <img alt="" src="https://mdn.mozillademos.org/files/8675/pages.png" style="height: 82px; width: 361px;"></li> + <li>Pick a page that is missing a summary, or that has a poor summary:<br> + <img alt="" src="https://mdn.mozillademos.org/files/8677/summary.png" style="height: 38px; width: 296px;"></li> + <li>Click the link to go to that page.</li> + </ol> + </li> +</ul> + +<dl> + <dd> + <ol> + <li>Once on the page to which you wish to add a summary, click <strong>Edit</strong> to open the page in the MDN editor. See the <a href="/en-US/docs/MDN/Contribute/Editor">Guide to the MDN editor</a> if you need information about using the editor.</li> + <li>Look for a sentence or two that works as a summary, even if taken out of context. If needed, edit the existing content to create or modify the text until you can select a sentence or two that make a good summary. See {{anch("Crafting a good summary")}} for help selecting or creating an appropriate summary.</li> + <li>Select the text to be used as a summary.</li> + <li>In the <em>Styles</em> widget of the editor toolbar, select <strong>SEO Summary</strong>. In the page source, this creates a {{HTMLElement("span")}} element with <code>class="seoSummary"</code> around the selected text.<br> + <img alt="" src="https://mdn.mozillademos.org/files/8679/styles.png" style="height: 231px; width: 403px;"></li> + <li>Save your changes with a revision comment. The comment is optional, but we encourage you to provide one. It makes it easier for other people to track the changes. Something like "Set SEO summary" is enough.</li> + </ol> + </dd> +</dl> + +<h2 id="Crafting_a_good_summary">Crafting a good summary</h2> + +<p>The summary is used in many different scenarios, including these:</p> + +<ul> + <li>As the description of the article on search results pages on MDN as well as on Google and other search engines.</li> + <li>As the description of the article in menus and topic landing pages on MDN itself.</li> + <li>In contextual tooltips when the user hovers the cursor over links to articles on MDN.</li> +</ul> + +<p>It's important to keep these scenarios in mind while composing a summary. In order to help ensure that the summary works well in all of these situations, please try to follow the guidelines below.</p> + +<div class="note"> +<p><strong>Note:</strong> Unless otherwise specifically stated, these are <em>guidelines</em>, not hard and fast rules. While you should do what you can to meet these guidelines, sometimes there are exceptions that can't be avoided.</p> +</div> + +<ul> + <li>The summary should indicate both the topic and the type of page. "In this guide, we'll learn to use the Intersection Observer API to create responsive web apps that only update animations that are currently visible on screen." is 160 characters, for example, and explains what technology is being covered, how the technology is being used, and that the article is a tutorial.</li> + <li>You can choose text from anywhere within any paragraph in the article, but it should ideally be within the first paragraph (or the second, in some cases). If the point of the article isn't made in those paragraphs, the introduction of the page probably needs rewriting.</li> + <li>The summary must still fit well within the context of the article's body, since it is in fact part of the article.</li> + <li>It's okay to have links to other pages within the summary. These are automatically removed before being given to search engines, and do not count against you. They're also removed before the summary is used as a tooltip. Links are <em>not</em> removed from the summary when used as a page description within menus and landing pages on MDN, which is really convenient as well.</li> + <li>The summary should include an appropriate selection of key terms likely to be searched for by someone looking for information contained on the page. In the example case about the Intersection Observer API, those keywords include the API name, "animations", "visible", "responsive", and "web apps", possibly among others.</li> + <li>To optimize the <strong>Search Engine Optimization</strong> (SEO) value gained from a summary, it should be no shorter than 150 characters long.</li> + <li>Since a <strong>search engine result page</strong> (<strong>SERP</strong>) typically doesn't show more than 160 characters of the summary, you should avoid summaries longer than that. Having your text unceremoniously chopped off can dissuade people from clicking the link.</li> + <li>It might be tempting to write a great summary that doesn't work on page, then hide the summary inside a block with the <code>"hidden"</code> class on it. But <em>this doesn't work</em>, because search engines ignore text that's not visible to the user.</li> +</ul> + +<p>Think of the summary as being akin to the {{interwiki("wikipedia", "blurb")}} on the back or inside the front cover of a book. This short text has to catch the reader's attention quickly and encourage them to read on.</p> + +<p>It can be a little tricky to write an summary that works well both for search engine result pages and within the article text itself, but currently MDN doesn't offer a way to create an SEO summary separate from the page content, so do the best you can.</p> + +<h2 id="See_also">See also</h2> + +<ul> + <li><a href="/en-US/docs/MDN/Contribute/Howto/Write_for_SEO">How to write with SEO in mind on MDN Web Docs</a></li> +</ul> diff --git a/files/ar/mdn/contribute/howto/tag/index.html b/files/ar/mdn/contribute/howto/tag/index.html new file mode 100644 index 0000000000..ec40ef97c6 --- /dev/null +++ b/files/ar/mdn/contribute/howto/tag/index.html @@ -0,0 +1,376 @@ +--- +title: How to properly tag pages +slug: MDN/Contribute/Howto/Tag +translation_of: MDN/Contribute/Howto/Tag +--- +<pre dir="rtl">{{MDNSidebar}}</pre> + +<p class="summary"><strong>Article tags</strong> are an important way to put visitors in touch with helpful content. Each page should normally have several tags to help keep content organized. <span class="seoSummary">This page explains the best way to tag pages so that our readers can find information and we can keep ourselves organized.</span></p> + +<p>For a help with the user interface for editing tags, see the <a href="/en-US/docs/MDN/Contribute/Editor/Basics#The_tags_box">tagging section</a> in our editor guide.</p> + +<p>Please use tags properly as explained below. If you don't, our automated tools will not correctly generate lists of content, landing pages, and cross-linking of articles.</p> + +<h2 id="How_MDN_uses_tags">How MDN uses tags</h2> + +<p>Tags get used on MDN several ways:</p> + +<dl> + <dt>{{anch("Document category", "Document categorization")}}</dt> + <dd>What type of document is it? Is it a reference? A tutorial? A landing page? Our visitors can use these tags to filter searches, so they're really important!</dd> + <dt>{{anch("Topic", "Topic identification")}}</dt> + <dd>What is the article about? Is it about an API? The DOM? Graphics? Again, these tags are important because they can filter searches.</dd> + <dt>{{anch("API identification")}}</dt> + <dd>Reference pages about an API need to identify the specific component of the API being documented (that is, what interface it's a part of, and what property or method the page covers, if applicable).</dd> + <dt>{{anch("Technology status")}}</dt> + <dd>What's the status of the technology? Is it non-standard? Obsolete or deprecated? Experimental?</dd> + <dt>{{anch("Skill level")}}</dt> + <dd>For tutorials and guides, how advanced is the material covered by the article?</dd> + <dt>{{anch("Document metadata")}}</dt> + <dd>The writing community uses tags to keep track of which pages need what kind of work.</dd> +</dl> + +<h2 id="Tag_type_guide">Tag type guide</h2> + +<p>Here's a quick guide to the types of tags and possible values for them.</p> + +<h3 id="Document_category">Document category</h3> + +<p>When you tag an article with one of these categories, you help the automated tools more accurately generate landing pages, tables of contents, and so on. Our new search system will also use these terms so that our visitors can locate reference or guide information at will.</p> + +<p>We use the following category names as standard tagging terms:</p> + +<dl> + <dt><code>{{Tag("Intro")}}</code></dt> + <dd>The article provides introductory material about a topic. Ideally each technology area should have only one "Intro"</dd> + <dt><code>{{Tag("Reference")}}</code></dt> + <dd>The article contains reference material about an API, element, attribute, property, or the like.</dd> + <dt><code>{{Tag("Landing")}}</code></dt> + <dd>The page is a landing page.</dd> + <dt><code>{{Tag("Guide")}}</code></dt> + <dd>The article is a how-to or guide page.</dd> + <dt><code>{{Tag("Example")}}</code></dt> + <dd>The article is a code sample page, or has code samples (that is, actual snippets of useful code, not one-line "syntax examples").</dd> +</dl> + +<h3 id="Topic">Topic</h3> + +<p>By identifying the article's topic area, you are helping generate better search results (and landing pages and navigation as well).</p> + +<p>While there's some room for flexibility here as we identify new topic areas, we try to limit ourselves to the names of APIs or technologies. Some useful examples:</p> + +<ul> + <li><code>{{Tag("HTML")}}</code></li> + <li><code>{{Tag("CSS")}}</code></li> + <li><code>{{Tag("JavaScript")}}</code> (notice the capital "S"!)</li> + <li><code>{{Tag("Document")}}</code></li> + <li><code>{{Tag("DOM")}}</code></li> + <li><code>{{Tag("API")}}</code> for each API's overview, interface, method, and property.</li> + <li><code>{{Tag("Method")}}</code> for each method of an API</li> + <li><code>{{Tag("Property")}}</code> for each property of an API</li> + <li><code>{{Tag("Graphics")}}</code></li> + <li><code>{{Tag("SVG")}}</code></li> + <li><code>{{Tag("WebGL")}}</code></li> + <li><code>{{Tag("Tools")}}</code></li> + <li><code>{{Tag("Web")}}</code></li> + <li><code>{{Tag("Element")}}</code></li> + <li><code>{{Tag("Extensions")}}</code> and <code>{{Tag("WebExtensions")}}</code> for WebExtension documentation.</li> +</ul> + +<p>In general, your topic identification tag should be the name of an interface with a number of related pages (like <a href="/en-US/docs/Web/API/Node">Node</a>, which has many pages for its various properties and methods), or the name of an overall technology type. You might tag a page about WebGL with <code>Graphics</code> and <code>WebGL</code>, for example, but a page about {{HTMLElement("canvas")}} with <code>HTML</code>, <code>Element</code>, <code>Canvas</code>, and <code>Graphics</code>.</p> + +<h4 id="Mozilla-specific_content">Mozilla-specific content</h4> + +<p>These tags are used in Mozilla-specific content only:</p> + +<ul> + <li><code>{{Tag("Mozilla")}}</code></li> + <li><code>{{Tag("Firefox")}}</code></li> + <li><code>{{Tag("Firefox OS")}}</code></li> + <li><code>{{Tag("Gecko")}}</code></li> + <li><code>{{Tag("XUL")}}</code></li> + <li><code>{{Tag("XPCOM")}}</code></li> +</ul> + +<h3 id="API_identification">API identification</h3> + +<p>Within the API reference, each article should identify which part of the API it covers:</p> + +<dl> + <dt><code>{{tag("Interface")}}</code></dt> + <dd>The main article for an interface should have this tag. For example, {{DOMxRef("RTCPeerConnection")}}.</dd> + <dt><code>{{tag("Constructor")}}</code></dt> + <dd>Each interface may have up to one page tagged "Constructor"; this is the interface's constructor. The page should have the same name as the interface, like {{DOMxRef("RTCPeerConnection.RTCPeerConnection()", "RTCPeerConnection()")}}.</dd> + <dt><code>{{tag("Property")}}</code></dt> + <dd>Every article describing a particular property within an interface needs this tag. See {{DOMxRef("RTCPeerConnection.connectionState")}}, for example.</dd> + <dt><code>{{tag("Method")}}</code></dt> + <dd>Each article documenting an interface method needs this tag. See {{DOMxRef("RTCPeerConnection.createOffer()")}} for example.</dd> +</dl> + +<p>In addition, the reference pages need to include interface, property, and method names among their tags. Some examples:</p> + +<dl> + <dt>The interface {{DOMxRef("RTCPeerConnection")}}</dt> + <dd>Include the tag <code>{{Tag("RTCPeerConnection")}}</code> along with the other relevant tags (<code>{{Tag("Interface")}}</code>, <code>{{Tag("WebRTC")}}</code>, <code>{{Tag("WebRTC API")}}</code>, <code>{{Tag("API")}}</code>, <code>{{Tag("Reference")}}</code>, and so forth).</dd> + <dt>The method {{DOMxRef("RTCPeerConnection.createOffer()")}}</dt> + <dd>Include the tags <code>{{Tag("RTCPeerConnection")}}</code> and <code>{{Tag("createOffer")}}</code> (note <em>no</em> parentheses in tag names!) along with the other relevant tags, including <code>{{Tag("Method")}}</code>, <code>{{Tag("WebRTC")}}</code>, <code>{{Tag("WebRTC API")}}</code>, <code>{{Tag("API")}}</code>, <code>{{Tag("Reference")}}</code>, and so forth. Consider including things like <code>{{Tag("Offer")}}</code> and <code>{{Tag("SDP")}}</code>, which are also relevant here.</dd> + <dt>The property {{DOMxRef("RTCPeerConnection.iceConnectionState")}}</dt> + <dd>Include the tags <code>{{Tag("RTCPeerConnection")}}</code> and <code>{{Tag("iceConnectionState")}}</code> along with the other relevant tags, including <code>{{Tag("Property")}}</code>, <code>{{Tag("WebRTC")}}</code>, <code>{{Tag("WebRTC API")}}</code>, <code>{{Tag("API")}}</code> and <code>{{Tag("Reference")}}</code>. Also consider including <code>{{Tag("ICE")}}</code>.</dd> +</dl> + +<h3 id="Technology_status">Technology status</h3> + +<p>To help the reader understand how viable a technology is, we use tags to label pages as to the status of the technology's specification. This isn't as detailed as actually explaining what the spec is and how far the technology has come in the specification process (that's what the Specifications table is for), but it helps the reader judge, at a glance, whether it's a good idea to use the technology described in the article.</p> + +<p>Here are possible values for these tags:</p> + +<dl> + <dt><code>{{Tag("Read-only")}}</code></dt> + <dd>Apply this tag to reference pages which describe a property or attribute which is read-only.</dd> + <dt><code>{{Tag("Non-standard")}}</code></dt> + <dd>Indicates that the technology or API described on the page is not part of a standard, whether it's stable or not in any browsers which implement it (if it's not stable, it should also be {{Tag("Experimental")}}). If you don't use this tag, your readers will assume the technology is standard. The compatibility table on the page should clarify which browser(s) support this technology or API.</dd> + <dt><code>{{Tag("Deprecated")}}</code></dt> + <dd>The technology or API covered on the page is marked as deprecated in the specification, and is likely to eventually be removed, but is generally still available in current versions of browsers.</dd> + <dt><code>{{Tag("Obsolete")}}</code></dt> + <dd>The technology or API has been deemed obsolete and has been removed (or is actively being removed) from all or most current browsers.</dd> + <dt><code>{{Tag("Experimental")}}</code></dt> + <dd>The technology is not standardized, and is an experimental technology or API that may or may not ever become part of a standard. It is also subject to change in the browser engine (typically only one) that implements it. If the technology isn't part of any specification (even in draft form), it should also have the {{tag("Non-standard")}} tag.</dd> + <dt><code>{{Tag("Needs Privileges")}}</code></dt> + <dd>The API requires privileged access to the device on which the code is running.</dd> + <dt><code>{{Tag("Certified Only")}}</code></dt> + <dd>The API only works in certified code.</dd> +</dl> + +<p>These tags are no excuse to leave out the <a href="/en-US/docs/Project:Compatibility_tables">compatibility table</a> in your article! That should always be present.</p> + +<h3 id="Skill_level">Skill level</h3> + +<p>Use the skill-level tag type only for guides and tutorials (that is, pages tagged <code>Guide</code>) to help users choose tutorials based on how familiar they are with a technology. There are three values for this:</p> + +<dl> + <dt><code>{{Tag("Beginner")}}</code></dt> + <dd>Articles designed to introduce the reader to a technology they've never used or have only a passing familiarity with.</dd> + <dt><code>{{Tag("Intermediate")}}</code></dt> + <dd>Articles for users who have gotten started with the technology but aren't experts.</dd> + <dt><code>{{Tag("Advanced")}}</code></dt> + <dd>Articles about stretching the capabilities of a technology and of the reader.</dd> +</dl> + +<h3 id="Document_metadata">Document metadata</h3> + +<p>The writing community uses tags to label articles as requiring specific types of work. Here's a list of the ones we use most:</p> + +<dl> + <dt><code>{{Tag("Draft")}}</code></dt> + <dd>The article is not complete, and is at least in theory still actively being updated (although it's also possible it's been forgotten about). Try to check with the most recent contributors before making changes, in order to avoid potential content collisions.</dd> + <dt><code>{{Tag("NeedsCompatTable")}}</code></dt> + <dd>The article needs a table to specify compatibility of a feature across browsers. <a href="/en-US/docs/MDN/Contribute/Structures/Compatibility_tables">See here</a> for a guide on contributing to browser compatibility.</dd> + <dt><code>{{Tag("NeedsContent")}}</code></dt> + <dd>The article is a stub, or is otherwise lacking information. This tag means that someone should review the content and add more details and/or finish writing the article.</dd> + <dt><code>{{Tag("NeedsExample")}}</code></dt> + <dd>The article needs one or more examples created to help illustrate the article's point. These examples should use the <a href="/en-US/docs/Project:MDN/Contributing/How_to_help/Code_samples">live sample system</a>.</dd> + <dt><code>{{Tag("NeedsLiveSamples")}}</code></dt> + <dd>The article has one or more examples that need to be updated to use the <a href="/en-US/docs/Project:MDN/Contributing/How_to_help/Code_samples">live sample system</a>.</dd> + <dt><code>{{Tag("NeedsMarkupWork")}}</code></dt> + <dd>The article needs improvement to the page markup (usually because the page content consists mostly or entirely of {{HTMLElement("p")}} tags).</dd> + <dt><code>{{Tag("NeedsSpecTable")}}</code></dt> + <dd>The article needs a table to indicate on which specification document(s) the feature was defined.</dd> + <dt><code>{{Tag("NeedsUpdate")}}</code></dt> + <dd>The content is out of date and needs to be updated.</dd> + <dt><code>{{Tag("l10n:exclude")}}</code></dt> + <dd>The content is not really worth localizing and will not appear on localization status pages.</dd> + <dt><code>{{Tag("l10n:priority")}}</code></dt> + <dd>The content is important and should be marked as a priority for MDN translators. Shows up in an extra priority table on localization status pages.</dd> +</dl> + +<h2 id="Putting_it_all_together">Putting it all together</h2> + +<p>So to each page you assign tags from several tag types, for example</p> + +<dl> + <dt>A tutorial about WebGL for beginners</dt> + <dd>{{Tag("WebGL")}}, {{Tag("Graphics")}}, {{Tag("Guide")}}, {{Tag("Beginner")}}</dd> + <dt>Reference page for {{HTMLElement("canvas")}}</dt> + <dd>{{Tag("Canvas")}}, {{Tag("HTML")}}, {{Tag("Element")}}, {{Tag("Graphics")}}, {{Tag("Reference")}}</dd> + <dt>A landing page for Firefox OS developer tools</dt> + <dd>{{Tag("Tools")}}, {{Tag("Firefox OS")}}, {{Tag("Landing")}}</dd> +</dl> + +<h2 id="Tagging_and_search_filters">Tagging and search filters</h2> + +<p>Search filters won't work properly unless we tag MDN pages properly. Here's a table of search filters and which tags they look for.</p> + +<div class="blockIndicator note"> +<p><strong>Note:</strong> If multiple tags are listed under "Tag name," that means any one or more of these tags must be present for the article to match.</p> +</div> + +<div class="blockIndicator todo"> +<p><strong>FIXME:</strong> Filter topics have been changed since this was last updated.</p> +</div> + +<table class="standard-table"> + <thead> + <tr> + <th scope="col">Filter group</th> + <th scope="col">Search filter name</th> + <th scope="col">Tag name</th> + </tr> + </thead> + <tbody> + <tr> + <th rowspan="23" scope="row" style="vertical-align: baseline;">Topic</th> + <td>APIs and DOM</td> + <td>{{Tag("API")}} || {{Tag("DOM")}} {{Deprecated_Inline}}</td> + </tr> + <tr> + <td>Add-ons & Extensions {{Deprecated_Inline}}</td> + <td>{{Tag("Add-ons")}} || {{Tag("Extensions")}} || {{Tag("Plugins")}} || {{Tag("Themes")}} || {{Tag("WebExtensions")}}</td> + </tr> + <tr> + <td>CSS</td> + <td>{{Tag("CSS")}}</td> + </tr> + <tr> + <td>Canvas</td> + <td>{{Tag("Canvas")}}</td> + </tr> + <tr> + <td>Firefox</td> + <td>{{Tag("Firefox")}}</td> + </tr> + <tr> + <td>Firefox for Android {{Obsolete_Inline}}</td> + <td>{{Tag("Firefox Mobile")}}</td> + </tr> + <tr> + <td>Firefox for Desktop {{Obsolete_Inline}}</td> + <td>{{Tag("Firefox Desktop")}}</td> + </tr> + <tr> + <td>Firefox OS</td> + <td>{{Tag("Firefox OS")}}</td> + </tr> + <tr> + <td>Games</td> + <td>{{Tag("Games")}}</td> + </tr> + <tr> + <td>HTML</td> + <td>{{Tag("HTML")}}</td> + </tr> + <tr> + <td>HTTP</td> + <td>{{Tag("HTTP")}}</td> + </tr> + <tr> + <td>JavaScript</td> + <td>{{Tag("JavaScript")}}</td> + </tr> + <tr> + <td>Marketplace {{Non-standard_Inline}}</td> + <td>{{Tag("Marketplace")}}</td> + </tr> + <tr> + <td>MathML</td> + <td>{{Tag("MathML")}}</td> + </tr> + <tr> + <td>Mobile</td> + <td>{{Tag("Mobile")}}</td> + </tr> + <tr> + <td>Open Web Apps {{Non-standard_Inline}}</td> + <td>{{Tag("Apps")}}</td> + </tr> + <tr> + <td>SVG</td> + <td>{{Tag("SVG")}}</td> + </tr> + <tr> + <td>Web Development</td> + <td>{{Tag("Web Development")}}</td> + </tr> + <tr> + <td>Web Standards</td> + <td>{{Tag("Web")}}</td> + </tr> + <tr> + <td>WebExtensions</td> + <td>{{Tag("WebExtensions")}}</td> + </tr> + <tr> + <td>WebGL</td> + <td>{{Tag("WebGL")}}</td> + </tr> + <tr> + <td>XPCOM {{Non-standard_Inline}}</td> + <td>{{Tag("XPCOM")}}</td> + </tr> + <tr> + <td>XUL {{Non-standard_Inline}}</td> + <td>{{Tag("XUL")}}</td> + </tr> + <tr> + <th rowspan="3" scope="row" style="vertical-align: baseline; white-space: nowrap;">{{anch("Skill level")}}</th> + <td>I'm an Expert</td> + <td>{{Tag("Advanced")}}</td> + </tr> + <tr> + <td>Intermediate</td> + <td>{{Tag("Intermediate")}}</td> + </tr> + <tr> + <td>I'm Learning</td> + <td>{{Tag("Beginner")}}</td> + </tr> + <tr> + <th rowspan="7" scope="row" style="vertical-align: baseline; white-space: nowrap;">Document type</th> + <td>Docs</td> + <td><em>This restricts the search to docs content, leaving out Hacks and other MDN content.</em></td> + </tr> + <tr> + <td>Demos</td> + <td><em>This includes Demo Studio content in the search results.</em></td> + </tr> + <tr> + <td>Tools</td> + <td>{{Tag("Tools")}}</td> + </tr> + <tr> + <td>Code Samples</td> + <td>{{Tag("Example")}}</td> + </tr> + <tr> + <td>How-To & Tutorial</td> + <td>{{Tag("Guide")}}</td> + </tr> + <tr> + <td>Developer Profiles</td> + <td><em>This includes developer profiles from the MDN site in the search results.</em></td> + </tr> + <tr> + <td>External Resources</td> + <td><em>The dev team is still figuring this out...</em></td> + </tr> + </tbody> +</table> + +<h2 id="Tagging_problems_you_can_fix">Tagging problems you can fix</h2> + +<p>There are several kinds of tag problems you can help fix:</p> + +<dl> + <dt>No tags</dt> + <dd>Generally articles should have at <em>least</em> a "{{anch("Document category", "category")}}" tag and a "{{anch("Topic", "topic")}}" tag. Usually other tags are appropriate as well, but if you can help us ensure that the minimum tags are present, you'll be a documentation hero!</dd> + <dt>Tags that don't follow our tagging standards</dt> + <dd>Please fix any documents whose tags don't follow the standards on this page.<br> + Note that you may occasionally see some localized tags (such as <code>Référence</code>) showing up on some English pages. This was due to a <a href="https://bugzilla.mozilla.org/show_bug.cgi?id=776048">bug in Kuma</a>, which caused the tags to reappear even if they were deleted. That bug has <a href="https://bugzilla.mozilla.org/show_bug.cgi?id=776048#c37">since been fixed</a>, so any remaining localized tags can be cleaned up if they're spotted.</dd> + <dt>Incorrect tags</dt> + <dd>If you're looking at an article about HTML and it's tagged "JavaScript", that's probably wrong! Likewise, if an article discusses Mozilla internals but has a "Web" tag, that's probably wrong too. Remove these tags and add the right tags if they aren't already there. Please also correct misspelled tags (e.g., "Javascript" will still match, since tags are case-insensitive, but let's not be sloppy!).</dd> + <dt>Missing tags</dt> + <dd>If an article has some but not all of the tags it needs, feel free to add more. For example, if a page in JavaScript reference is (correctly) tagged "JavaScript" but nothing else, you're invited to tag the page "Reference" or {{anch("Document category", "another category tag")}} as well!</dd> + <dt>Tag spam</dt> + <dd>This insidious beast is the most revolting tag problem of all: some Web vermin has deposited its droppings in the page tags (like "Free warez!" or "Hey I was browsing your site and wanted to ask you if you could help me solve this problem I'm having with Flash crashing all the time"). We've got to delete these right away! They're ugly, they're hard to manage if they're allowed to linger too long, and they're terrible for {{Glossary("SEO")}}.</dd> +</dl> + +<p>If you see one (or more) of these problems, please <a href="/en-US/docs/Project:MDN/Contributing/Getting_started#Logging_into_MDN">log into MDN</a> and click EDIT at the top right of the MDN window. Once the editor loads up, scroll down to the bottom of the page, where you'll see the tag box. For more details on the tagging interface, see "<a href="/en-US/docs/Project:MDN/Contributing/Editor_guide#The_tags_box">The tags box</a>" in the <a href="/en-US/docs/Project:MDN/Contributing/Editor_guide">MDN editor guide</a>.</p> diff --git a/files/ar/mdn/contribute/howto/write_a_new_entry_in_the_glossary/index.html b/files/ar/mdn/contribute/howto/write_a_new_entry_in_the_glossary/index.html new file mode 100644 index 0000000000..c97cbc3136 --- /dev/null +++ b/files/ar/mdn/contribute/howto/write_a_new_entry_in_the_glossary/index.html @@ -0,0 +1,138 @@ +--- +title: كيفية الكتابة والرجوع إلى التدوين في قاموس المصطلحات +slug: MDN/Contribute/Howto/Write_a_new_entry_in_the_Glossary +translation_of: MDN/Contribute/Howto/Write_a_new_entry_in_the_Glossary +--- +<div>{{MDNSidebar}}</div> + +<div>{{IncludeSubnav("/en-US/docs/MDN")}}</div> + +<p><span class="seoSummary">In this article, we cover how to add and link to entries in the <a href="/en-US/docs/Glossary">MDN Web Docs glossary</a>. We also provide guidelines about glossary entry layout and content.</span> The glossary provides definitions for all of the terms, jargon, abbreviations, and acronyms you'll come across when reading about the web and about web development.</p> + +<p class="simple-translate-result" style="color: rgb(0, 0, 0);">المسرد ليس كاملاً ، وربما لن يكتمل. الويب يتغير دائمًا وينمو دائمًا. يمكنك مساعدتنا في الحفاظ على تحديث المسرد ، وملء أي فجوات ، من خلال المساهمة في إدخالات جديدة في المسرد (أو حتى عن طريق إصلاح المشكلات التي تحددها في الإدخالات الحالية).</p> + +<p class="simple-translate-result" style="color: rgb(0, 0, 0);">المساهمة في المسرد هي طريقة سهلة للمساعدة في جعل شبكة الإنترنت أسهل للجميع لفهمها. لا تحتاج إلى مستوى عالٍ من المهارة الفنية للقيام بذلك ، أيضًا ، لأن مقالات المسرد تهدف إلى أن تكون واضحة وموجزة.</p> + +<h2 id="كيف_تكتب_في_قاموس">كيف تكتب في قاموس</h2> + +<p>If you're looking for topics that need a glossary entry, check the <a href="/en-US/docs/Glossary#Contribute_to_the_glossary">list of undocumented terms</a> at the end of the <a href="/en-US/docs/Glossary">Glossary landing page</a>; click any of those links to start a new Glossary page for the item you clicked; then follow the steps below.</p> + +<p class="simple-translate-result" style="color: rgb(0, 0, 0);">إذا كانت لديك فكرة عن إدخال مسرد مصطلحات جديد ، فما عليك سوى فتح الزر التالي في علامة تبويب جديدة ، ثم اتبع الخطوات الموجودة أسفل الزر:</p> + + + +<div class="align-center"><a class="button ignore-external mega positive" href="/en-US/docs/new?parent=4391">Write a new entry in the glossary</a> + +<div></div> +</div> + + + +<h3 id="Step_1_Select_a_term_to_explain">Step 1: Select a term to explain</h3> + +<p>The first thing to do is to choose a term to write about. If you don't know which terms are in need of definitions, you can <a href="https://developer.mozilla.org/en-US/docs/Glossary#Contribute_to_the_glossary">check out our list of suggestions</a>. Just click one and get started writing! If you're logged in already, you'll wind up in the MDN editor.</p> + +<h3 id="Step_2_Write_a_summary">Step 2: Write a summary</h3> + +<p>The first paragraph of any glossary page is a simple and short description of the term (preferably no more than two sentences). Make sure anyone reading the description can understand the defined term immediately.</p> + +<div class="note"> +<p class="simple-translate-result" dir="rtl" style="color: rgb(0, 0, 0);"> <strong>ملاحظة:</strong> يرجى عدم نسخ تعريفات ولصقها من أي مكان آخر (لا سيما ويكيبيديا ، لأن مجموعة إصدارات الترخيص الخاصة بها أصغر ، وبالتالي فهي غير متوافقة مع نسخة MDN). من المهم حقًا التأكد من أن هذا المحتوى بسيط وسهل الفهم. الأمر يستحق قضاء بعض الوقت على ذلك بدلاً من سرقة المحتوى بشكل أعمى. يجب أن يكون هذا المسرد محتوى جديدًا مفيدًا ، وليس تكرار الأشياء من مكان آخر.</p> +</div> + +<h4 id="Writing_a_good_glossary_entry">Writing a good glossary entry</h4> + +<p>If you must, you can add a few extra paragraphs, but it's very easy to find yourself writing a whole article. Writing a whole article is fine, but please don't put it in the glossary. If you aren't sure where to put your article, feel free to <a href="/en-US/docs/MDN/Community#Join_our_mailing_lists">reach out to discuss it</a>.</p> + +<p>A few simple guidelines to consider while writing a glossary entry that may help you create a better one:</p> + +<ul> + <li>When you use terms in the glossary's description of the term or abbreviation, you should create appropriate links for them. Often, this will just involve creating links to other pages in the glossary (see <a href="/en-US/docs/MDN/Contribute/Howto/Write_a_new_entry_in_the_Glossary#How_to_use_the_Glossary_macro">How to use the Glossary macro</a> below). For terms directly related to the term being described by the glossary, it may be more useful to link to MDN Web Docs' main body article on the topic.</li> + <li>Try to use appropriate related terms (with links) within your article if it can be done without making the article hard to follow. Having a good web of related, useful inks can make a page or set of pages much easier to use.</li> + <li>Think about what you would type into a search engine if you wanted to find this page. Try to use all the words you'd search on in the article, without making the article nonsensical, overly long, or difficult to read.</li> +</ul> + +<h4 id="Specifying_the_tooltip">Specifying the tooltip</h4> + +<p>As is the case with most MDN links, hovering the mouse cursor over a gossary link will show a brief description of the page (in this case, a short summary of the term's definition). By default, the tooltip is the entire first paragraph of the article, but this is often too long.</p> + +<p>You can specify a subsection of text that will be used as the page summary (and therefore the tooltip text) by selecting a sentence or two that best summarize the definition of the term, then adding the "SEO Summary" style to them. This not only establishes the tooltip text, but also specifies the text that will be sent to Google and other search engines when they ask for a brief summary describing the page contents. For that reason, specifically selecting a page summary is also valuable for helping your new page get found more easily.</p> + +<div class="note"> +<p class="simple-translate-result" dir="rtl" style="color: rgb(0, 0, 0);"><strong>ملاحظة:</strong> من الناحية المثالية ، يجب أن يتراوح الملخص بين 150 و 160 حرفًا ؛ أقل ما يرام ، وأكثر ليست جيدة ولكن لن كسر أي شيء ، احد الامرين.</p> +</div> + +<h3 id="Step_3_Expand_with_links">Step 3: Expand with links</h3> + +<p>Finally, a glossary entry should always end with a "Learn more" section. This section should contain links to help the reader move forward: discovering more details, learning to use the relevant technology, and so on.</p> + +<p>We recommend that you sort the links into at least these three groups:</p> + +<dl> + <dt>General knowledge</dt> + <dd>Links that provide more general information; for example, such as a link to a relevant page on <a href="http://wikipedia.org/">Wikipedia</a>.</dd> + <dt>Technical reference</dt> + <dd>Links to more in-depth technical information, on MDN Web Docs or elsewhere.</dd> + <dt>Learn about it</dt> + <dd>Links to tutorials, exercises, examples, or any other materials that help the reader learn to use the technology behind the defined term.</dd> +</dl> + +<h2 id="التعامل_مع_الغموض">التعامل مع الغموض</h2> + +<p>Sometimes, a term has several meanings depending on the context. To resolve the ambiguities, you must follow those guidelines:</p> + +<ul> + <li>The term's main page must be a disambiguation page containing the {{TemplateLink("GlossaryDisambiguation")}} macro.</li> + <li>The term has subpages that define the term for a given context.</li> +</ul> + +<p>Let's illustrate that with an example. The term <em>signature</em> can have different meanings in at least three different contexts: <em>security</em>, <em>function</em> and <em>email</em>.</p> + +<ol> + <li>The page <a href="/en-US/docs/Glossary/Signature">Glossary/Signature</a> is the disambiguation page with the {{TemplateLink("GlossaryDisambiguation")}} macro.</li> + <li>The page <a href="/en-US/docs/Glossary/Signature/Security">Glossary/Signature/Security</a> is the page defining a signature in a security context.</li> + <li>The page <a href="/en-US/docs/Glossary/Signature/Function">Glossary/Signature/Function</a> is the page defining a function signature.</li> + <li>The page <a href="/en-US/docs/Glossary/Signature/Email">Glossary/Signature/Email</a> is the page defining email signature.</li> +</ol> + +<h2 id="How_to_use_the_Glossary_macro">How to use the \{{Glossary}} macro</h2> + +<p>The glossary is much more useful when people can access the definitions from another document without navigating away from what they're reading. Therefore we urge you to link to the glossary whenever you can, using the {{TemplateLink("Glossary")}} macro:</p> + +<table class="standard-table"> + <thead> + <tr> + <th scope="col">Macro</th> + <th scope="col">Result</th> + <th scope="col">Note</th> + </tr> + </thead> + <tbody> + <tr> + <td>\{{Glossary("browser")}}</td> + <td>{{Glossary("browser")}}</td> + <td>When a text matches the term to be defined, just use the macro as is (it's case insensitive)</td> + </tr> + <tr> + <td>\{{Glossary("browser", "Web browser")}}</td> + <td>{{Glossary("browser","Web browser")}}</td> + <td>To display an alternative text, use the second argument to specify that text</td> + </tr> + <tr> + <td>\{{Glossary("browser", "Web browser", 1)}}</td> + <td>{{Glossary("browser","Web browser",1)}}</td> + <td>Specify <code>1</code> as an optional third argument to display the link as a regular link rather than a subtle hint</td> + </tr> + </tbody> +</table> + +<p>Links created with the \{{Glossary}} macro always display a tooltip containing the glossary entry's summary paragraph or the "SEO summary" if one has been selected as described in <a href="https://developer.mozilla.org/en-US/docs/MDN/Contribute/Howto/Write_a_new_entry_in_the_Glossary#Specifying_the_tooltip">Specifying the tooltip above</a>.</p> + +<h3 id="Using_the_macro_wisely">Using the macro wisely</h3> + +<p>In many cases, it's perfectly safe to use the Glossary macro anywhere on MDN. There are a couple of guidelines to consider, though:</p> + +<ul> + <li>If a term already has a link to an appropriate page somewhere else on MDN, don't replace the link with a glossary link.</li> + <li>Within an article section, use the \{{Glossary}} macro only once for the same term (<em>hint: a section always starts with a title</em>).</li> +</ul> diff --git a/files/ar/mdn/contribute/howto/write_an_article_to_help_learn_about_the_web/index.html b/files/ar/mdn/contribute/howto/write_an_article_to_help_learn_about_the_web/index.html new file mode 100644 index 0000000000..1c993c9677 --- /dev/null +++ b/files/ar/mdn/contribute/howto/write_an_article_to_help_learn_about_the_web/index.html @@ -0,0 +1,111 @@ +--- +title: كيفية كتابة مقال لمساعدة الناس على التعرف على شبكة الإنترنت +slug: MDN/Contribute/Howto/Write_an_article_to_help_learn_about_the_Web +translation_of: MDN/Contribute/Howto/Write_an_article_to_help_learn_about_the_Web +--- +<div>{{MDNSidebar}}</div> + +<p class="simple-translate-result" dir="rtl" style="color: rgb(0, 0, 0);"><a href="/ar/docs/Learn">منطقة التعلم MDN</a> هي موطننا للمقالات التي تقدم مفاهيم الويب للمطورين الجدد. نظرًا لأن محتواها يستهدف المبتدئين في الغالب ، فهو مكان رائع لمشاركة معرفتك ومساعدة القادمين الجدد على التعرف على الويب. من المهم التأكد من أن المطورين الجدد يمكنهم متابعة هذا المحتوى ، لذلك نولي اهتمامًا خاصًا به.</p> + +<p class="simple-translate-result" dir="rtl" style="color: rgb(0, 0, 0);"><span class="seoSummary">يشرح هذا المقال كيفية كتابة صفحات لل<a href="/ar/docs/Learn">منطقة التعليمية</a>.</span></p> + +<h2 id="How_to_write_a_Learning_Area_article">How to write a Learning Area article</h2> + +<p>To start contributing your knowledge, simply click the big green button, then follow the five steps below. If you're looking for ideas, please take a look at the <a href="https://trello.com/b/LDggrYSV">our team Trello board</a>!</p> + + + +<div class="align-center"><a class="button ignore-external mega positive" href="/en-US/docs/new?parent=111819">Write a new learning article</a> + +<div></div> +</div> + + + +<p>This article might not end up in exactly the right place, but at least it's on MDN. If you need to talk to someone about getting it moved to the right place, please <a href="/en-US/docs/Learn#Contact_us">Contact us</a>.</p> + +<h3 id="Step_1_Write_a_two-liner">Step 1: Write a two-liner</h3> + +<p>Your article's first sentence needs to summarize what subject you're going to cover, and the second one should go into a few more specifics of the items that you'll put in the article. For example:</p> + +<div class="summary"> +<p>Whereas {{glossary("HTML")}} files contain structured content, {{Glossary("CSS")}}, another major Web technology, makes the content look the way you want. In this article we are going to cover how this technology works, and how to write your own basic example.</p> +</div> + +<p>Note how the example briefly explains that CSS is a core Web technology used to style pages. That's enough for the reader to get a pretty good idea what the article covers.</p> + +<p>Because Learning Area articles primarily target beginners, each article should cover one straightforward topic so as not to overwhelm the reader with too much new information. If you can't summarize the article in one sentence, you might be trying to do too much in one article!</p> + +<h3 id="Step_2_Add_a_top_box">Step 2: Add a top box</h3> + +<p>Add a<strong> top box</strong> to help readers understand where they are in the learning process. Here's an example of a top box from <a href="/en-US/docs/Learn/Understanding_URLs">"Understanding URLs and their structure"</a>. You can use this article as an model when writing your own.</p> + +<table class="learn-box standard-table"> + <tbody> + <tr> + <th scope="row">Prerequisites:</th> + <td>You need to first know <a class="new" href="https://developer.mozilla.org/en-US/docs/Learn/How_the_Internet_works">how the Internet works</a>, <a class="new" href="https://developer.mozilla.org/en-US/docs/Learn/What_is_a_Web_server">what a Web server is</a>, and <a class="new" href="https://developer.mozilla.org/en-US/docs/Learn/Understanding_links_on_the_web">the concepts behind links on the web</a>.</td> + </tr> + <tr> + <th scope="row">Objective:</th> + <td>You will learn what a URL is and how it works on the Web.</td> + </tr> + </tbody> +</table> + +<dl> + <dt>Prerequisites</dt> + <dd>What must the reader already know to follow the article? When possible, make each prerequisite a link to another Learning Area article covering the concept (unless it's a really basic article that doesn't require prior knowledge).</dd> + <dt>Objectives</dt> + <dd>This section briefly states what the reader will learn over the course of the article. This is a bit different than the one-liner; the one-liner summarizes the topic of the article, while the objectives section specifically lays out what the reader can expect to accomplish over the course of the article.</dd> +</dl> + +<div class="note"> +<p><strong>Note:</strong> To create this table, you can either copy and paste the example table above, or use MDN's editor's <a href="/en-US/docs/MDN/Contribute/Editor/Tables">table tool</a>. If you choose to use the table tool, you need to specifically add the <code>learn-box</code> CSS class in addition to the default <code>standard-table</code> class. To do this, when you create or edit the table's properties, go to the "Advanced" panel and set the <strong>Stylesheet Classes</strong> field to "<code>standard-table learn-box</code>".</p> +</div> + +<h3 id="Step_3_Write_a_full_description">Step 3: Write a full description</h3> + +<p>Next, write a longer description that provides a more thorough overview of the article highlighting the most important concepts. Don't forget to explain why the reader should take the time to learn this topic and read your article!</p> + +<h3 id="Step_4_Dig_deeper">Step 4: Dig deeper</h3> + +<p>When you're done with all that, you can finally dive deeply into the topic. You can structure this part of your article however you like (although feel free to consult our <a href="/en-US/docs/MDN/Contribute/Style_guide">style guide</a>). This is your chance to shine! Go into detail explaining the topic you're writing about. Provide links to the full reference documentation, explain how the technology works in detail, provide syntax and usage details, and so forth. It's up to you!</p> + +<p>As a guide, here are some writing tips for beginners:</p> + +<ul> + <li>Focus on a single topic. If you feel like you need to cover other topics, it means either you're missing a prerequisite article, or you need to break up your article into more than one.</li> + <li>Use simple English. Avoid technical terms when you can, or at least define them and <a href="https://developer.mozilla.org/en-US/docs/MDN/Contribute/Howto/Write_a_new_entry_in_the_Glossary#How_to_use_the_.7B.7BGlossary.7D.7D_macro">link to their glossary entries</a> where applicable.</li> + <li>Include straightforward examples to make the theoretical concepts easier to grasp. Many people learn best by example. Rather than writing academic papers, we want beginners to follow the text readily.</li> + <li>Visual aids often can make things easier to digest and carry extra information, so feel free to use images, diagrams, videos, and tables. If you're using diagrams or charts that include text, we encourage you to use {{Glossary("SVG")}} so our translation teams can localize the text.</li> +</ul> + +<p>Have a look at the first few sections of our <a href="/en-US/docs/Learn/JavaScript/Building_blocks/Functions">Functions — reusable blocks of code</a> article for some good descriptive sections.</p> + +<h3 id="Step_5_Provide_active_learning_material">Step 5: Provide "active learning" material</h3> + +<p>To illustrate the article and help the reader better understand what they're learning, be sure to provide exercises, tutorials, and tasks to accomplish. By having them actively and practically using and experimenting with the concepts your article explains, you can help "lock" the information into their brains.</p> + +<p>You can choose to include the examples directly in the page as <a href="/en-US/docs/MDN/Contribute/Structures/Live_samples">live samples</a> or <a href="/en-US/docs/MDN/Contribute/Editor/Links">link to them</a> if they don't really work as a live sample. If you're interested in helping create these valuable materials, please read the article <a href="https://developer.mozilla.org/en-US/docs/MDN/Contribute/Howto/Create_an_interactive_exercise_to_help_learning_the_web">Create an interactive exercise to help learning the Web</a>.</p> + +<p>If you can't provide links to existing active learning materials (you don't know of any or don't have time to create them), you should add the tag {{Tag("NeedsActiveLearning")}} to the article. That way other contributors can find articles that need active learning materials and help you come up with them.</p> + +<p>Have a look at <a href="/en-US/docs/Learn/CSS/Introduction_to_CSS/Simple_selectors#Active_learning_Selecting_different_elements">Active learning: selecting different elements</a> for a live interactive learning exercise, or <a href="/en-US/docs/Learn/JavaScript/Building_blocks/Functions#Active_learning_Playing_with_scope">Active learning: Playing with scope</a> for a different style of exercise that calls upon them to download a template locally and modify it following the provided steps.</p> + +<h3 id="Step_6_Get_the_article_reviewed_and_put_into_the_Learning_Area_navigation_menu">Step 6: Get the article reviewed, and put into the Learning Area navigation menu</h3> + +<p>After you've written your article, let us know so we can have a look at it, do a review, and suggest improvements. Again, see our <a href="/en-US/docs/Learn#Contact_us">Contact us</a> section for the best ways to get in touch.</p> + +<p>The last step is adding your article to the Learning Area main navigation menu. This menu is generated by the <a href="/en-US/docs/Template:LearnSidebar">LearnSidebar macro</a>, and requires special editing privileges, so talk to one of our team about your contribution.</p> + +<p>For now, add the menu to your page by adding the macro call \{{LearnSidebar}} into a paragraph at the top of your page.</p> + +<ul> +</ul> + +<h2 id="Suggested_articles">Suggested articles</h2> + +<p>So you want to contribute but you're not sure what to write about?</p> + +<p>The Learning Area team maintains <a href="https://trello.com/b/LDggrYSV">a Trello board with ideas of articles</a> to write. Feel free to pick one and get to work!</p> diff --git a/files/ar/mdn/contribute/howto/إنشاء_حساب_على_شبكة_مطوري_موزيلا/index.html b/files/ar/mdn/contribute/howto/إنشاء_حساب_على_شبكة_مطوري_موزيلا/index.html new file mode 100644 index 0000000000..5a0a255b5d --- /dev/null +++ b/files/ar/mdn/contribute/howto/إنشاء_حساب_على_شبكة_مطوري_موزيلا/index.html @@ -0,0 +1,43 @@ +--- +title: كيف تنشئ حساباً على شبكة MDN +slug: MDN/Contribute/Howto/إنشاء_حساب_على_شبكة_مطوري_موزيلا +tags: + - MDN Account + - إنشاء حساب MDN + - حساب MDN +translation_of: MDN/Contribute/Howto/Create_an_MDN_account +--- +<div>{{MDNSidebar}}</div> + +<p dir="rtl"><span class="seoSummary">عليك امتلاك ملف شخصي حتى تتمكن من التعديل على محتوى الشبكة، ولكنك لا تحتاج لإنشاء حساب إن كنت تريد القراءة والبحث في التوثيقات التي نتيحها. سيساعدك هذا الدليل على إعداد ملفك الشخصي في الشبكة.</span></p> + +<div class="pull-aside"> +<div class="moreinfo"> +<p dir="rtl"><strong>لما تحتاج الشبكة لعنوان البريد الإلكتروني؟</strong></p> + +<p dir="rtl">يُستخدم بريدك الإلكتروني لاسترجاع الحساب إذا لزم الأمر، كما يُستخدم من قبل مدراء الشبكة ليتمكنوا من التواصل معك حول حسابك ونشاطك على الشبكة.<br> + بالإضافة لذلك، يمكنك الاشتراك بالإشعارات (على سبيل المثال، يمكنك تلقي إشعار <a href="/ar/docs/MDN/Contribute/Howto/Watch_a_page">عندما يتم تعديل صفحة معينة</a>) والرسائل (على سبيل المثال، إن قمت بالإنضمام إلى فريق التجربة، فقد تتلقى رسائل إلكترونية حول الميزات الجديدة التي تحتاج للاختبار)<br> + لن يظهر بريدك الإلكتروني أبداً في الشبكة وسيتم استخدامه فقط وفقاً <a href="https://www.mozilla.org/privacy/websites/">لسياسة الخصوصية</a>.</p> + +<div class="note" dir="rtl">إذا قمت بتسجيل الدخول بالشبكة باستخدام GitHub و استخدمت "عدم الرد (noreply)" على بريد الغيت هاب، <em>فلن</em> تتلقى رسائل (بما فيها الإشعارات عندما تشترك بصفحة) من الشبكة.</div> +</div> +</div> + +<ol dir="rtl"> + <li>في أعلى كل صفحة ستجد زر <strong>تسجيل الدخول</strong>. اضغط على هذا الزر لعرض قائمة الخدمات التي ندعمها للمصادقة وتسجيل الدخول في الشبكة.</li> + <li>اختر إحدى تلك الخدمات. حالياً، غيت هاب هو الخيار الوحيد. لاحظ أنك إذا اخترت غيت هاب سيتم إضافة رابط لملفك الشخصي على الموقع في الشبكة.</li> + <li>اتبع الطلبات التي سيخبرك بها غيت هاب لتربط ملفك الشخصي بالشبكة.</li> + <li>حالما تعيدك خدمة المصادقة إلى الشبكة (والتي هي غيت هاب - إذا أخترتها -)، ستتمكن من إدخال اسم المستخدم وكلمة المرور، <em>سيتم عرض اسم المستخدم خاصتك للعموم لشكرك على العمل الذي قمت به. فلا تستخدم البريد الإلكتروني كاسم مستخدم.</em></li> + <li>اضغط على <strong>إنشاء ملف شخصي خاص بي على الشبكة</strong> (أو ما يقابله بالمعنى).</li> + <li>إذا كان البريد الإلكتروني الذي حددته في الخطوة الرابعة ليس هو نفسه الذي استخدمته مع خدمة المصادقة، فيرجى التحقق من بريدك الإلكتروني والضغط على رابط التأكيد المُرسل إليك.</li> +</ol> + +<p dir="rtl">هذا كل شيء! والآن أصبح لديك حساب على الشبكة، ويمكنك القيام بتعديلات مباشرةً!</p> + +<p dir="rtl">يمكنك الضغط على اسمك في الشريط العلوي لرؤية ملفك الشخصي. من هناك، يمكنك الضغط على زر<strong>تحرير</strong> (أو ما يقابله بالمعنى) للقيام بتغييرات على ملفك الشخصي.</p> + +<div class="note"> +<p dir="rtl">اسماء المستخدمين الجدد لا يمكن أن يحتوا على مسافات أو المحرف "@". تذكر أن اسم المستخدم الخاص بك سيظهر للعموم ليحدد الأعمال التي قمت بها.</p> +</div> + +<div id="eJOY__extension_root"> </div> diff --git a/files/ar/mdn/contribute/howto/كيفية_إنشاء_وتحرير_الصفحات/index.html b/files/ar/mdn/contribute/howto/كيفية_إنشاء_وتحرير_الصفحات/index.html new file mode 100644 index 0000000000..c4ab1b2bcf --- /dev/null +++ b/files/ar/mdn/contribute/howto/كيفية_إنشاء_وتحرير_الصفحات/index.html @@ -0,0 +1,179 @@ +--- +title: كيفية إنشاء وتحرير الصفحات +slug: MDN/Contribute/Howto/كيفية_إنشاء_وتحرير_الصفحات +translation_of: MDN/Contribute/Howto/Create_and_edit_pages +--- +<div>{{MDNSidebar}}</div> + +<p><span class="seoSummary">This article introduces new contributors to the process of editing existing pages and creating new ones.</span></p> + +<h2 id="Editing_an_existing_page">Editing an existing page</h2> + +<p>To edit a page:</p> + +<ol> + <li>Click the <strong>Edit</strong> button near the top right corner of the page.</li> + <li>The page then reloads, with an editing interface where you can add or delete information directly.</li> + <li>Add paragraphs, delete text, insert headings, and perform more of the basic functions involved in writing and editing.</li> +</ol> + +<p>See the guide to <a href="/en-US/docs/MDN/Contribute/Editor/Basics">Editor UI elements</a> in the <a href="/en-US/docs/MDN/Contribute/Editor">MDN Editor guide</a> for more information on using <strong>MDN</strong>'s built-in editor.</p> + +<h3 id="Preview_changes">Preview changes</h3> + +<p>To see what your changes look like:</p> + +<ul> + <li>Click the <strong>Preview</strong> button, within the editing function at the top or bottom of the page.</li> + <li>This opens the preview page, showing your revisions in a new window, or tab.</li> + <li>Each time you click this button, it refreshes your preview page with the latest changes.</li> +</ul> + +<p>Be careful! Previewing a page <strong>does not</strong> save your progress. Don't close the editing tab until you've saved your work.</p> + +<h3 id="Revision_comment">Revision comment</h3> + +<p>After previewing your changes, you will want to <em>save your revision</em>. Before you <strong>save</strong>, look for the revision comment box, below the editing box, leaving a comment to inform other contributors why you made changes. For example, you might have added a new section, changed some words to make the terminology more consistent, rewritten a paragraph to clarify the language, or removed information because it was redundant.</p> + +<h3 id="Table_of_Contents">Table of Contents</h3> + +<p>The 'In this Article' section of an article, is an auto-generated list of links to the headings on the page. The wording of these can be edited via the headings. It's also possible to remove a table of contents, or decrease its number of links, by selecting 'Edit Page Title and Properties', changing the value of the "TOC" drop down.</p> + +<h3 id="Tags">Tags</h3> + +<p>You can add or remove tags, which describe the page content and purpose, below the editing section. See <a href="/en-US/docs/MDN/Contribute/Tagging">How to properly tag pages</a>, for information on which tags to apply.</p> + +<h3 id="Review_needed">Review needed?</h3> + +<p>If an expert, or experienced contributor should review your edits, please request a technical review (for code, API's, or technologies), and/or an editorial review (for prose, grammar, and content), making sure the appropriate box is checked before you save.</p> + +<h3 id="Attach_files">Attach files</h3> + +<p>If you wish to <strong>attach a file</strong><em> </em>to an existing page, or to add an illustration for further clarification, this can be added to the bottom of the page. When uploading an image, please be sure to use an image optimization tool to make the file as small to download as possible. This improves page load time and helps MDN's performance overall. You may use your preferred tool, if you have one. Otherwise, we suggest <a href="https://tinypng.com/">TinyPNG</a>, a handy Web tool.</p> + +<h3 id="Publish_Discard_or_Keep_editing">Publish, Discard, or Keep editing</h3> + +<p>When you finish editing, and are happy with your preview, publish<strong> </strong>your work and comments by clicking the<em> green</em> <strong>Publish</strong> button, to the right of the page title, or towards the bottom of the page. If you wish to continue working, click <strong>Publish and keep editing</strong>, which publishes your changes and keeps the edit interface open. </p> + +<p>If you change your mind, you can discard edits, by clicking the<em> red</em><strong> Discard</strong> button. Note that discarding changes <em>permanently</em> discards them.</p> + +<p>Pressing <strong>Enter </strong>in the Revision Comment field is equivalent to clicking <strong>Publish and Keep Editing</strong>.</p> + +<div class="note"> +<p>Note: If attempting to save, but changes are rejected as invalid, and you feel the content is appropriate for MDN, <a href="mailto:mdn-admins@mozilla.com?subject=MDN%3A%20Content%20Rejection%20Appeal&body=%3CDescribe%20the%20content%20you%20were%20trying%20to%20save%20and%20where%20you%20were%20trying%20to%20place%20it.%3E">email the MDN admin team</a> for assistance.</p> +</div> + +<h2 id="Getting_page-creation_permissions">Getting page-creation permissions</h2> + +<p>For security reasons, newly-created accounts don't have the ability to create new pages. If you try to do so, you'll see a page instructing you how to get the page created. There are two options:</p> + +<ul> + <li><strong>Ask for the page to be created for you.</strong> To do this, <a href="https://bugzilla.mozilla.org/enter_bug.cgi?bug_file_loc=http%3A%2F%2F&bug_ignored=0&bug_severity=normal&bug_status=NEW&cf_fx_iteration=---&cf_fx_points=---&contenttypemethod=autodetect&contenttypeselection=text%2Fplain&flag_type-4=X&flag_type-607=X&flag_type-800=X&flag_type-803=X&form_name=enter_bug&maketemplate=Remember%20values%20as%20bookmarkable%20template&op_sys=Unspecified&priority=--&product=Developer%20Documentation&rep_platform=Unspecified&short_desc=Create%20page%3A%20&status_whiteboard=create-page&target_milestone=---&version=unspecified">file a documentation request bug</a>, with the subject "Create page: <page title>". Fill out the URL field with the location on MDN where you'd like the page to go, if you know where to place it. In the comment text, include information on why this page needs creating.</li> + <li><strong>Request page creation privileges.</strong> If you request page creation privileges, and they're granted to you, you'll be able to add new pages by following the instructions here. To request these privileges, <a href="mailto:mdn-admins@mozilla.org">email the MDN admin</a> team with your request. Include your username, why you would like to have the ability to create new pages. For instance, you're documenting a new API which involves many new pages, or you'd like to add new terms to the glossary. You should also have made useful contributions to this site's content, and been a contributor for some time. This length of time, and the other factors, are collectively considered.</li> +</ul> + +<h2 id="Creating_a_new_page">Creating a new page</h2> + +<p>Once you have page-creation permission, you can begin creating pages.</p> + +<p>If you do not know where to place a new article, <strong>do not worry.</strong> Put it anywhere, we will find it, move to where it belongs, or merge it into existing content. Whatever makes the most sense. Do not worry about making it perfect. We have happy helper gnomes who help making your content clean and rather luscious.</p> + +<p>There are a few ways to create a new page:</p> + +<ul> + <li><a href="#Missing_page_link">'Missing page' link.</a></li> + <li><a href="#New_page_without_link">New page without link.</a></li> + <li><a href="#Subpage_of_an_existing_page">Subpage of an existing page.</a></li> + <li><a href="#Clone_of_an_existing_page">Clone of an existing page.</a></li> + <li><a href="#Link_from_an_existing_page">Link from an existing page.</a></li> +</ul> + +<dl> +</dl> + +<h3 id="'Missing_page'_link">'Missing page' link</h3> + +<p>As with most wikis, it is possible to create a link to a page that is yet to exist. For example, an author might create a list of all the members of an API, before creating the pages for those members. On MDN, links to non-existent pages are typically displayed in red.</p> + +<p>To create a page from a 'missing page' link:</p> + +<ol> + <li>Log into MDN, and have page-creation permission. If not logged in, clicking a 'missing page' link results in a 404 (page not found) error.</li> + <li>Click the 'missing page' link. If you have page creation permission, the <a href="/en-US/docs/MDN/Contribute/Editor">MDN Editor UI</a> opens, ready for you to create the missing page.</li> + <li>Write the content of the page, and save it.</li> +</ol> + +<h3 id="New_page_without_link">New page without link</h3> + +<p><em>To create a new page without linking from another page</em>, enter a unique page name in the URL field of your browser. For example, if you enter:</p> + +<pre class="language-html">https://developer.mozilla.org/en-US/docs/FooBar</pre> + +<p>MDN creates a new page, with the title "FooBar", opening the editor for you to add new content. Refer to the <a href="#Editing_an_existing_page">Editing an existing page</a> section of this article, for information on how to use the editor mode.</p> + +<p><em>To create a new page without linking from another page</em>:</p> + +<ol> + <li>Log in, and have page-creation permission.</li> + <li>Enter the following in the URL field of your browser:</li> +</ol> + +<pre class="language-html">https://developer.mozilla.org/en-US/docs/new</pre> + +<p>MDN creates a new page, with a place for a title, opening the editor to add new content to this page. Refer to <a href="#Editing_an_existing_page">Editing an existing page</a>, for information on using editor mode.</p> + +<h3 id="Subpage_of_an_existing_page">Subpage of an existing page</h3> + +<p>To create a page you want to be below an existing page, in the page hierarchy:</p> + +<ol> + <li>On the 'parent' page, click the <strong>Advanced</strong> menu (the gear icon in the toolbar), then click <strong>New sub-page</strong>.</li> + <li>An editor view opens for creating a new document.</li> + <li>Add a title for this document, in the <strong>Title</strong> field.</li> + <li>Change the <strong>Slug</strong> field, if needed. For example, if the title is long, and a shorter URL seems appropriate. This field is automatically filled by the editor, substituting underscores for spaces found in the title, changing only the last part of the URL.</li> + <li>In the <strong>TOC</strong> field, select heading levels you want to be displayed in the table of contents for the page. Or select 'No table of contents', if one is not needed.</li> + <li>Write content of the page in the editor pane, saving your changes. Refer to <a href="#Editing_an_existing_page">Editing an existing page</a>, for further information on using editor mode.</li> +</ol> + +<h3 id="Clone_of_an_existing_page">Clone of an existing page</h3> + +<p>If there is an existing page, whose format you wish to use as a base for your new page, you can 'clone' that page, and then change its content.</p> + +<ol> + <li>On the original page, click the <strong>Advanced</strong> menu (the gear icon in the toolbar), and click <strong>Clone this page</strong>. An editor view opens, for creating a new document.</li> + <li>Change the <strong>Title</strong> of the page, as appropriate for the new content. The <strong>Slug</strong> field is updated automatically as you change the <strong>Title</strong> field.</li> + <li>Change the path portion of the <strong>Slug</strong> field, as needed, to put the new document in a different location in the document hierarchy. In most cases, this is not needed. A cloned page often has similar content to its original, and need to be in a similar location.</li> + <li>In the <strong>TOC</strong> field, select the heading levels you want to be automatically displayed in the table of contents for this page. Or select 'No table of contents', if one is not needed.</li> + <li>Write your content in the editor pane, saving your changes. Refer to <a href="#Editing_an_existing_page">Editing an existing page</a>, for more information on using editor mode.</li> +</ol> + +<h3 id="Link_from_an_existing_page">Link from an existing page</h3> + +<p>This is a bit of a hybrid. You can create a link on another page, then click the link you just inserted, to create the new page:</p> + +<ol> + <li>Enter the name of your new page, anywhere that makes sense in the text of an existing page.</li> + <li>Highlight this new name, and <strong>click the Link icon (<img alt="" src="https://developer.mozilla.org/files/3810/link-icon.png" style="height: 28px; width: 29px;">) </strong>in the editor's toolbar. The <strong>'Update Link'</strong> dialog opens, with the highlighted text in the<strong> 'Link To'</strong> field.</li> + <li>"/en-US/docs/" is inserted by default, to the beginning of the URL field.<em> Enter the name </em>of the page after "/en-US/docs/". The page name does not have to be the same as the link text.</li> + <li>Click OK, to create and insert the link.</li> +</ol> + +<p>If the page does not yet exist, the link is displayed in red. If the page <em>does</em> exist, the link is displayed blue. If you want to create a new page, but the page title you desire is already taken, check if it makes sense helping edit and improve the page already there. Otherwise, think of a unique title for your new page, and create a link for it. Refer to <a href="https://developer.mozilla.org/Project:en/Page_Naming_Guide" title="Project:en/Page_Naming_Guide">page naming guide</a> for guidelines.</p> + +<p>To add content to your new page, click on the red link you just created, after saving and closing the editor. The new page opens in editor mode, enabling you to start writing. Refer to <a href="#Editing_an_existing_page">Editing an existing page</a>, for further information on using editor mode.</p> + +<h2 id="Refreshing_page_content">Refreshing page content</h2> + +<p>MDN support of KumaScript macros, and integration of content from other pages, can sometimes be hampered by the need for caching of pages, for performance reasons. Pages are built from their source, and this output is cached for future requests. From that moment on, any macros (templates), or integrations (using the macro<span class="templateLink"><code><a href="https://developer.mozilla.org/en-US/docs/Template:Page">Page</a></code></span>), will not reflect later changes made to the macro, its output, or the contents of the integrated material.</p> + +<ul> + <li>To manually update a page, force-refresh your Web browser. MDN detects this, triggering a page rebuild, pulling in updated macro output, and integrating page content.</li> + <li>You can also configure pages to periodically rebuild, automatically. This should not be done, unless you expect the page to update frequently. See <a href="/en-US/docs/MDN/Contribute/Tools/Page_regeneration">Page regeneration</a>, for detailed information.</li> +</ul> + +<h2 id="See_also">See also</h2> + +<ul> + <li><a href="/en-US/docs/MDN/Contribute/Editor">MDN editor guide</a></li> + <li><a href="/en-US/docs/MDN/Contribute/Content/Style_guide">MDN style guide</a></li> +</ul> diff --git a/files/ar/mdn/contribute/index.html b/files/ar/mdn/contribute/index.html new file mode 100644 index 0000000000..c22c7b6d14 --- /dev/null +++ b/files/ar/mdn/contribute/index.html @@ -0,0 +1,38 @@ +--- +title: ساهم في شبكة مطوري موزيلا +slug: MDN/Contribute +tags: + - حول الشبكة + - صفحة هبوط +translation_of: MDN/Contribute +--- +<div>{{MDNSidebar}}</div><div>{{IncludeSubnav("/ar/docs/MDN")}}</div> + +<div dir="rtl">مرحباً بك! بزيارتك لهذه الصفحة، فأنت تأخذ أول خطوة لتصبح مساهماً في الشبكة!</div> + +<p dir="rtl"><span class="seoSummary">المقالات المسرودة هنا تغطي جميع جوانب المساهمة في الشبكة، بما فيها دليل التنسيق، ومقالات إرشادية لاستخدام محررنا والأدوات المختلفة، والمزيد. تأكد رجاءً من قراءة (والموافقة على) <a href="https://www.mozilla.org/ar/about/legal/terms/mozilla/">بنود استخدام موزيلا</a> قبل تعديل أو إنشاء أي صفحة.</span></p> + +<p dir="rtl">إذا لم تساهم في شبكة مطوري موزيلا مسبقاً، احرص على قراءة <a href="/ar/docs/MDN/Getting_started">دليل البدء</a> ليساعدك على انتقاء مهمة وتنفيذها.</p> + +<div class="row topicpage-table"> +<div class="section"> +<dl> + <dt class="landingPageList" dir="rtl"><a href="/ar/docs/MDN/Contribute/Howto">مقالات "كيف تقوم"</a></dt> + <dd class="landingPageList" dir="rtl">توفر هذه المقالات دلائل إرشادية خطوة بخطوة لتنفيذ مهمة معينة عند المساهمة في الشبكة.</dd> + <dt class="landingPageList" dir="rtl"><a href="/ar/docs/MDN/Contribute/Localize">ترجمة شبكة مطوري موزيلا</a></dt> + <dd class="landingPageList" dir="rtl">تُستخدم هذه الشبكة من أشخاص حول العالم كمرجع ودليل في تقنيات الويب، بالإضافة لاستخدامها كمرجع في أجزاء فيرفوكس الداخلية. تعتبر مجتمعات الترجمة خاصتنا الجزء الرئيسي من مشروع موزيلا؛ فعملهم في ترجمة وتوطين توثيقاتنا تساعد الناس حول العالم في تطوير الويب المفتوح. إن كنت ترغب في تعلم المزيد حول فِرق ترجمتنا، أو الانضمام لإحداها، أو حتى بدء فريق ترجمة جديد، فهذا هو المكان المناسب لتبدأ.</dd> +</dl> + +<dl> +</dl> +</div> + +<div class="section"> +<dl> + <dt class="landingPageList" dir="rtl"><a href="/ar/docs/MDN/Contribute/Tools">أدوات شبكة موزيلا للمطورين</a></dt> + <dd class="landingPageList" dir="rtl">توفر أدوات شبكة موزيلا للمطورين عدداً من الميزات، التي تجعل تتبع التقدم، وإدارة المحتوى، ومواكبة تحديثات الموقع أسهل.</dd> + <dt class="landingPageList" dir="rtl"><a href="/ar/docs/MDN/Contribute/Editor">دليلك نحو محرر شبكة مطوري موزيلا</a></dt> + <dd class="landingPageList" dir="rtl">الـ WYSIWYG (يقصد به <strong>ما تراه هو ما تحصل عليه</strong>) هو محرر تقدمه موسوعة شبكة مطوري موزيلا، يجعل من السهل المساهمة بمحتوى جديد. يوفر دليل محرر شبكة مطوري موزيلا بعض المعلومات عن كيفية استخدام محرر، فضلاً عن بعض المعلومات حول الميزات المفيدة التي قد تساهم في تحسين إنتاجيتك.</dd> +</dl> +</div> +</div> diff --git a/files/ar/mdn/contribute/localize/index.html b/files/ar/mdn/contribute/localize/index.html new file mode 100644 index 0000000000..ed2a2577cd --- /dev/null +++ b/files/ar/mdn/contribute/localize/index.html @@ -0,0 +1,29 @@ +--- +title: Localizing MDN +slug: MDN/Contribute/Localize +tags: + - Documentation + - Localization + - MDN + - NeedsTranslation + - TopicStub +translation_of: MDN/Contribute/Localize +--- +<div>{{MDNSidebar}}</div><p>MDN is used by people all over the world as a reference and guide to Web technologies, as well as to the internals of Firefox itself. Our localization communities are a key part of the Mozilla project; their work in translating and localizing our documentation helps people around the world develop for the open Web. If you'd like to learn more about our localization teams, join one of the teams, or even start a new localization, this is the place to begin.</p> +<p>{{LandingPageListSubpages}}</p> +<h2 id="Localization_tools">Localization tools</h2> +<p>There are several useful tools that you'll use during localization work:</p> +<dl> + <dt> + <a href="/en-US/docs/Mozilla/Localization/Localizing_with_Verbatim" title="/en-US/docs/Mozilla/Localization/Localizing_with_Verbatim">Verbatim</a></dt> + <dd> + Used for translation of strings across multiple Mozilla projects, including the MDN user interface (as well as the Firefox user interface).</dd> + <dt> + <a href="http://transvision.mozfr.org/" title="http://transvision.mozfr.org/">Transvision</a></dt> + <dd> + A utility provided by Mozilla France, which lets you search for occurrences of an English string, finding all the various translations into a target locale that are used throughout Mozilla code. Useful for finding the preferred translations for words or phrases.</dd> +</dl> +<h2 id="See_also">See also</h2> +<ul> + <li><a href="/en-US/docs/Mozilla/Localization" title="/en-US/docs/Mozilla/Localization">Localization at Mozilla</a></li> +</ul> diff --git a/files/ar/mdn/contribute/localize/صفحات_الترجمة/index.html b/files/ar/mdn/contribute/localize/صفحات_الترجمة/index.html new file mode 100644 index 0000000000..c2714fc285 --- /dev/null +++ b/files/ar/mdn/contribute/localize/صفحات_الترجمة/index.html @@ -0,0 +1,58 @@ +--- +title: ترجمة صفحات شبكة مطوري موزيلا +slug: MDN/Contribute/Localize/صفحات_الترجمة +tags: + - ترجمة + - ترجمة الصفحات + - توطين اللغة + - دليل الترجمة + - دليل ترجمة الصفحات +translation_of: MDN/Contribute/Localize/Translating_pages +--- +<div>{{MDNSidebar}}</div> + +<p dir="rtl">هذا المقال هو دليل أساسي لمعرفة كيفية ترجمة المحتوى على شبكة مطوري موزيلا، بما في ذلك آلية العمل المستخدمة في الترجمة و نصائح حول الطريقة الأمثل للتعامل مع أنواع المحتوى المختلفة.</p> + +<h2 dir="rtl" id="بدأ_صفحة_ترجمة_جديدة">بدأ صفحة ترجمة جديدة</h2> + +<p dir="rtl">عندما تجد صفحة ما تريد أن تترجمها, اتبع هذه الخطوات:</p> + +<ol dir="rtl"> + <li>انقر رمز اللغات لفتح قائمة <strong>اللغات</strong>، ثم اضغط على "<strong>اضافة ترجمة"</strong>. تظهر صفحة إختيار اللغة.</li> + <li>إختر اللغة التي تريد ترجمة الصفحة إليها. يفتح عرض ترجمة المادة مع نص اللغة الأصلية المعروضة على الجانب الأيسر.</li> + <li>تحت <strong>وصف الترجمة</strong>، يمكنك ترجمة العنوان و السبيكة إختياريا إلى اللغة المستهدفة. السبيكة هو الجزء الأخير من عنوان صفحة (على سبيل المثال, "صفحات_الترجمة" على هذا المقال.) بعض مجتمعات الترجمة لا تترجم السبيكة، بل تحتفظ بنفس السبيكة بالإنجليزية. قارن مع مقالات أخرى في لغتك لتحديد الممارسات العامة. بإمكانك الضغط على إشارة التصغير بجانب "<strong>وصف الترجمة</strong>" لإخفاء هذه المعلومة عند الانتهاء منها، لترك مجال أكبر أمام قسم <strong>المحتوى المترجم</strong>.</li> + <li>تحت<strong> ترجمة المحتوى</strong>، ترجم نص الصفحة.</li> + <li>إملأ على الأقل <strong>وسما</strong>ً واحداً للصفحة.</li> + <li>أضغط على "<strong>حفظ التغييرات</strong>" عند إنتهائك.</li> +</ol> + +<div class="note" dir="rtl"><strong>ملاحظة:</strong> يتم عرض عناصر واجهة المستخدم من عرض الترجمة المادة في البداية باللغة الإنجليزية. وفى الزيارات اللاحقة لترجمة مقال معين, تظهر واجهة المستخدم باللغة المناسبة اذا توفر ترجمة للموقع لهذه اللغة. يمكن ترجمة واجهة المستخدم لشبكة المطورين لموزيلا بإستعمال <a href="https://pontoon.mozilla.org/projects/mdn/">بونتوون</a>. انظر إلى <a href="/ar/docs/Mozilla/Localization/الترجمة_مع_بونتوون">الترجمة بإستخدام بونتوون </a>للحصول على تفاصيل حول كيفية استخدام هذه الأداة .</div> + +<h2 dir="rtl" id="تحرير_صفحة_مُترجمِة">تحرير صفحة مُترجمِة</h2> + +<ul dir="rtl"> + <li>في الصفحة المُترجمِة، أنقر فوق زر التحرير (مسمى أحيانا في اللغة الهدف). يفتح عرض ترجمة المقال.</li> +</ul> + +<p dir="rtl">اذا كانت النسخة الانجليزية قد تغيرت منذ اخر تعديل للترجمة, قائمة "المقالات المترجمة" تظهر مستوى المصدر "متغير" للتغييرات فى النسخة الانجليزية. هذا يساعدك على رؤية ما يلزم تحديثه في الترجمة.</p> + +<h2 dir="rtl" id="ترجمة_الوسوم">ترجمة الوسوم</h2> + +<p dir="rtl">مهم للغاية ذلك أن كل صفحة موسومة على الأقل بوسم واحد. حتى وان كان ذلك ترجمة. بشكل عام، استخدام نفس الوسوم في النسخة الأصلية هي فكرة جيدة.</p> + +<p dir="rtl">تستخدم بعض الوسوم كمرشحات للبحث ، أو كإتفاقيات بين المساهمين. لا ينبغي ترجمتها. لمعرفة هذه الوسوم، أقرأ <a href="https://developer.mozilla.org/en-US/docs/Project:MDN/Contributing/Tagging_standards">معايير الوسم</a>. لك حرية خلق وسوم مترجمة لمجموعة من المحتويات إن لم يكن محمياً بأحد معايير الوسوم.</p> + +<h2 dir="rtl" id="نصائح_للمترجمين_الجدد">نصائح للمترجمين الجدد</h2> + +<p dir="rtl">إذا كنت مترجما جديدا على شكبة مطوري موزيلا، ندعوك لقراءة بعض من إقترحاتنا:</p> + +<ul dir="rtl"> + <li>المقالات في المسرد (<em>المسرد هو فهرس للكلمات العسيرة مع شرح لها</em>) تعتبر جد جيدة بالنسبة للمترجمين الجدد، لأنها بسيطة وقصيرة.</li> + <li>المقالات الموسومة بــ <a href="en-US/docs/tag/l10n%3Apriority">"l10n:priority"</a> تعتبر ذا أهمية كبيرة لترجمتها.</li> + <li> إذا رأيت نصا بين أقواس معقوفة مزدوجة، مثل \{{some-text("more text")}}، أتركه غير مترجم، و لا تغير علامات الترقيم. هذا <a href="en-US/docs/MDN/Contribute/Structures/Macros">ماكرو</a>، حيث أنه يقوم بإنشاء هيكل في الصفحة، أو يقوم بشيء مفيد. قد ترى نصوصا غير مترجمة مولدة من طرف ماكرو، لا تقلق حيال ذلك إلى حين حصولك على الخبرة اللازمة في MDN. (تغيير هذا النص يتطلب <a href="en-US/docs/MDN/Contribute/Tools/Template_editing">إمتيازات خاصة</a> لأن الماكرو قد يكون فعالا للغاية). في حالة ما كنت فضوليا، يمكنك الإطلاع على <a href="en-US/docs/MDN/Contribute/Structures/Macros/Commonly-used_macros">الماكرو الأكثر إستعمالا</a> لترى بعضا من الاشياء التي يقوم بها الماكرو.</li> + <li>راجع <a href="en-US/docs/MDN/Contribute/Localize/Localization_projects">صفحة مشروع التوطين</a>* لإيجاد المزيد عن التوطين بمنطقتك.</li> +</ul> + +<div class="note"> +<p dir="rtl"><strong>التوطين:</strong> عملية تكييف منتج تُرجم مسبقاً إلى لغات مختلفة في منطقة أو بلد محدد، وبشكل أبسط، هو عملية ترجمة لمحتوى معين ما.</p> +</div> diff --git a/files/ar/mdn/contribute/persona_sign-in/index.html b/files/ar/mdn/contribute/persona_sign-in/index.html new file mode 100644 index 0000000000..ca4cc4805e --- /dev/null +++ b/files/ar/mdn/contribute/persona_sign-in/index.html @@ -0,0 +1,28 @@ +--- +title: MDN and Persona sign-ins +slug: MDN/Contribute/Persona_sign-in +translation_of: Archive/MDN/Persona_sign-ins +--- +<div>{{MDNSidebar}}</div><div class="warning"> +<p>Please <a href="/en-US/docs/MDN/Contribute/Howto/Link_a_GitHub_account">link your GitHub account to your MDN profile now</a> so you can continue to sign in to MDN.</p> +</div> + +<div class="threecolumns"> +<div class="syntaxbox">Currently, MDN lets contributors sign in using two different authentication providers: Mozilla Persona and GitHub. Starting on November 1, 2016, we will remove Persona as an option for logging in. Therefore, you must enable Github authentication on your profile to avoid losing login access to MDN.</div> +</div> + +<p>We recognize that this is an inconvenience, and we do apologize for it. Unfortunately, this is out of our control.</p> + +<h2 id="Why_is_Persona_being_removed">Why is Persona being removed?</h2> + +<p>Mozilla has shut down the Persona project, and its servers will be turned off in November, 2016. You can <a href="https://wiki.mozilla.org/Identity/Persona_Shutdown_Guidelines_for_Reliers#FAQs">learn more about Mozilla's decision</a> to shut down Persona on the Mozilla wiki.</p> + +<h2 id="When_will_Persona_be_removed">When will Persona be removed?</h2> + +<p>We will disable Persona as an authentication provider on November 1, 2016; in other words, the last day you'll be able to sign in to MDN using Persona will be October 31, 2016. We will be issuing increasingly frequent and increasingly urgent notifications to <a href="/en-US/docs/MDN/Contribute/Howto/Link_a_GitHub_account">add a GitHub account to your MDN profile</a> starting now. Please do this as soon as you can, in order to avoid any risk of losing access to your MDN account.</p> + +<h2 id="Will_MDN_offer_another_authentication_provider">Will MDN offer another authentication provider?</h2> + +<p>We would very much like to do so, but have not yet identified another provider which meets our requirements; in addition, we don't currently have the developer resources to integrate another provider. For the time being, your <em>only</em> option to keep contributor access to MDN is to <a href="/en-US/docs/MDN/Contribute/Howto/Link_a_GitHub_account">link your MDN profile to your GitHub account</a>.</p> + +<p>Keep in mind, of course, that you don't need to sign in to MDN in order to read our content. But if you have an account for contributing, and wish to be able to contribute at any time in the future, be sure to <em><strong>add a GitHub account to your profile as soon as you can,</strong></em> before October 31, 2016.</p> diff --git a/files/ar/mdn/guidelines/index.html b/files/ar/mdn/guidelines/index.html new file mode 100644 index 0000000000..8f14102c44 --- /dev/null +++ b/files/ar/mdn/guidelines/index.html @@ -0,0 +1,16 @@ +--- +title: Guidelines +slug: MDN/Guidelines +tags: + - Guidelines + - Landing + - MDN Meta + - NeedsTranslation + - TopicStub +translation_of: MDN/Guidelines +--- +<div>{{MDNSidebar}}</div><div>{{IncludeSubnav("/en-US/docs/MDN")}}</div> + +<p><span class="seoSummary">These guides provide details on how MDN documentation should be written and formatted, as well as how our code samples and other content should be presented.</span> By following these guides, you can ensure that the material you produce is clean and easy to use.</p> + +<p>{{LandingPageListSubpages}}</p> diff --git a/files/ar/mdn/guidelines/writing_style_guide/index.html b/files/ar/mdn/guidelines/writing_style_guide/index.html new file mode 100644 index 0000000000..1eed23f4b1 --- /dev/null +++ b/files/ar/mdn/guidelines/writing_style_guide/index.html @@ -0,0 +1,730 @@ +--- +title: Writing style guide +slug: MDN/Guidelines/Writing_style_guide +translation_of: MDN/Guidelines/Writing_style_guide +--- +<div>{{FirefoxSidebar}}</div> + +<div>{{IncludeSubnav("/en-US/docs/MDN")}}</div> + +<p>لتقديم الوثائق بطريقة منظمة وموحدة وسهلة القراءة ، يصف دليل نمط مستندات ويب MDN كيفية تنظيم النص وتهجيته وتنسيقه وما إلى ذلك. هذه إرشادات بدلاً من قواعد صارمة. نحن مهتمون بالمحتوى أكثر من التنسيق ، لذلك لا تشعر بأنك ملزم بتعلم دليل الأسلوب قبل المساهمة. لكن لا تنزعج أو تفاجأ إذا قام متطوِّر كادح في وقت لاحق بتحرير عملك ليتوافق مع هذا الدليل.</p> + +<p>تنطبق الجوانب اللغوية لهذا الدليل في المقام الأول على وثائق باللغة الإنجليزية. لغات أخرى قد يكون (وأرحب لإنشاء) دلائل الاسلوب. يجب نشرها كصفحات فرعية لصفحة فريق التعريب.</p> + +<p>بالنسبة لمعايير الأنماط التي تنطبق على المحتوى المكتوب لمواقع أخرى غير MDN ، يرجى الرجوع إلى <a href="https://www.mozilla.org/en-US/styleguide/">دليل أسلوب One Mozilla.</a></p> + + + +<h2 id="المبادئ">المبادئ</h2> + +<p>أفضل مكان للبدء به في أي دليل واسع النطاق للنشر هو مع بعض معايير النصوص الأساسية للمساعدة في الحفاظ على ثبات الوثائق. توضح الأقسام التالية بعضًا من هذه الأساسيات لمساعدتك.</p> + +<h3 id="عنوان_الصفحة">عنوان الصفحة</h3> + +<p>يتم استخدام عناوين الصفحات في نتائج البحث وتستخدم أيضًا لترتيب التسلسل الهرمي للصفحة في قائمة مسارات التنقل أعلى الصفحة. يمكن أن يكون عنوان الصفحة (الذي يتم عرضه في أعلى الصفحة وفي نتائج البحث) مختلفًا عن الصفحة "slug" ، وهو جزء من عنوان URL الخاص بالصفحة بعد "<locale> / docs /".</p> + +<h4 id="العنوان_ورسملة_العنوان">العنوان ورسملة العنوان</h4> + +<p>يجب أن تستخدم عناوين الصفحات وعناوين الأقسام طريقة الكتابة بالأحرف الكبيرة على شكل الجملة (لا تستخدم سوى الأحرف الكبيرة في الكلمة الأولى والأسماء المناسبة) بدلاً من الكتابة بالأحرف الكبيرة على نمط العنوان:</p> + +<ul> + <li><span class="correct"><strong>الصواب</strong></span>: "A new method for creating JavaScript rollovers"</li> + <li><span class="incorrect"><strong>الخطأ</strong></span>: "A New Method for Creating JavaScript Rollovers"</li> +</ul> + +<p>We have many older pages that were written before this style rule was established. Feel free to update them as needed if you like. We're gradually getting to them.</p> + +<h4 id="Choosing_titles_and_slugs">Choosing titles and slugs</h4> + +<p>Page slugs should be kept short; when creating a new level of hierarchy, the new level's component in the slug should just be a word or two.</p> + +<p>Page titles, on the other hand, may be as long as you like, within reason, and they should be descriptive.</p> + +<h4 id="Creating_new_subtrees">Creating new subtrees</h4> + +<p>When you need to add some articles about a topic or subject area, you will typically do so by creating a landing page, then adding subpages for each of the individual articles. The landing page should open with a paragraph or two describing the topic or technology, then provide a list of the subpages with descriptions of each page. You can automate the insertion of pages into the list using some macros we've created.</p> + +<p>For example, consider the <a href="/en-US/docs/Web/JavaScript">JavaScript</a> guide, which is structured as follows:</p> + +<ul> + <li><a href="/en-US/docs/Web/JavaScript/Guide" title="JavaScript/Guide">JavaScript/Guide</a> - Main table-of-contents page</li> + <li><a href="/en-US/docs/Web/JavaScript/Guide/JavaScript_Overview" title="JavaScript/Guide/JavaScript_Overview">JavaScript/Guide/JavaScript Overview</a></li> + <li><a href="/en-US/docs/JavaScript/Guide/Functions" title="JavaScript/Guide/Functions">JavaScript/Guide/Functions</a></li> + <li><a href="/en-US/docs/JavaScript/Guide/Details_of_the_Object_Model" title="JavaScript/Guide/Details_of_the_Object_Model">JavaScript/Guide/Details of the Object Model</a></li> +</ul> + +<p>Try to avoid putting your article at the top of the hierarchy, which slows the site down and makes search and site navigation less effective.</p> + +<h3 id="General_article_content_guidelines">General article content guidelines</h3> + +<p>When writing any document, it's important to know how much to say. If you ramble on too long, the article becomes tedious to read and nobody will use it. Getting the amount of coverage right is important for several reasons. Among those reasons: to ensure that the reader finds the information they truly need, and to provide enough quality material for search engines to adequately analyze and rank the article. We'll discuss the former (providing the information the reader may need) here. To learn a little about ensuring that pages are properly classified and ranked by search engines, see the article <a href="https://developer.mozilla.org/en-US/docs/MDN/Contribute/Howto/Write_for_SEO">How to write for SEO on MDN</a>.</p> + +<p>The goal is to write pages that include all the information that readers may need without going on too long about it all. We have a few recommendations in this area.</p> + +<h4 id="Consider_your_audience">Consider your audience</h4> + +<p>Keep in mind that these are guidelines. Some of these tips may not apply in every case. Certainly keep your article's audience in mind. An article on advanced network techniques likely doesn't need to go into as much detail about basic networking concepts as the typical article on networking code, for instance.</p> + +<h4 id="Provide_a_useful_summary">Provide a useful summary</h4> + +<p>Make sure the article's summary—that is, the opening paragraph or paragraphs before the first heading—provides enough information for the reader to understand if the article is likely to be covering what they're interested in reading about. In guide or tutorial content, the summary should let the reader know what topics will be covered and what they're already expected to know, if anything. It should mention the technology, technologies, and/or APIs that are being documented or discussed, with links to those, and it should offer hints as to the situations in which the article's contents might be useful.</p> + +<h5 id="Example_Too_short!">Example: Too short!</h5> + +<p>This example of a summary is far too short. It leaves out too much information, such as what it means exactly to "stroke" text, where the text is drawn, and so forth.</p> + +<div class="example-bad"> +<p><strong><code>CanvasRenderingContext2D.strokeText()</code></strong> draws a string.</p> +</div> + +<h5 id="Example_Too_long!">Example: Too long!</h5> + +<p>Here, we've updated the summary, but now it's far too long. Too much detail is included, and the text gets far too much into other methods and properties. Instead, the summary should focus on the <code>strokeText()</code> method, and should refer to the appropriate guide where the other details are offered.</p> + +<div class="example-bad"> +<p>When called, the Canvas 2D API method <strong><code>CanvasRenderingContext2D.strokeText()</code></strong> strokes the characters in the specified string beginning at the coordinates specified, using the current pen color. In the terminology of computer graphics, "stroking" text means to draw the outlines of the glyphs in the string without filling in the contents of each character with color.</p> + +<p>The text is drawn using the context's current font as specified in the context's {{domxref("CanvasRenderingContext2D.font", "font")}} property.</p> + +<p>The placement of the text relative to the specified coordinates are determined by the context's <code>textAlign</code>, <code>textBaseline</code>, and <code>direction</code> properties. <code>textAlign</code> controls the placement of the string relative to the X coordinate specified; if the value is <code>"center"</code>, then the string is drawn starting at <code>x - (stringWidth / 2)</code>, placing the specified X-coordinate in the middle of the string. If the value is <code>"left"</code>, the string is drawn starting at the specified value of <code>x</code>. And if <code>textAlign</code> is <code>"right"</code>, the text is drawn such that it ends at the specified X-coordinate.</p> + +<p>(etc etc etc...)</p> + +<p>You can, optionally, provide a fourth parameter that lets you specify a maximum width for the string, in pixels. If you provide this parameter, the text is compressed horizontally or scaled (or otherwise adjusted) to fit inside a space that wide when being drawn.</p> + +<p>You can call the <strong><code>fillText()</code></strong> method to draw a string's characters as filled with color instead of only drawing the outlines of the characters.</p> +</div> + +<h5 id="Example_Much_better!">Example: Much better!</h5> + +<p>Here we see a much better overview for the <code>strokeText()</code> method.</p> + +<div class="example-good"> +<p>The {{domxref("CanvasRenderingContext2D")}} method <code><strong>strokeText()</strong></code>, part of the <a href="/en-US/docs/Web/API/Canvas_API">Canvas 2D API</a>, strokes—that is, draws the outlines of—the characters of a specified string, anchored at the position indicated by the given X and Y coordinates. The text is drawn using the context's current {{domxref("CanvasRenderingContext2D.font", "font")}}, and is justified and aligned according to the {{domxref("CanvasRenderingContext2D.textAlign", "textAlign")}}, {{domxref("CanvasRenderingContext2D.textBaseline", "textBaseline")}}, and {{domxref("CanvasRenderingContext2D.direction", "direction")}} properties.</p> + +<p>For more details and further examples, see {{SectionOnPage("/en-US/docs/Learn/JavaScript/Client-side_web_APIs/Drawing_graphics", "Text")}} in the Learning Area as well as our main article on the subject, <a href="/en-US/docs/Web/API/Canvas_API/Tutorial/Drawing_text">Drawing text</a>.</p> +</div> + +<h4 id="Include_all_relevant_examples">Include all relevant examples</h4> + +<p>More pages should have examples than should not have them. The majority of pages most likely deserve multiple examples, in fact. It's important to ensure that you use examples to clarify what every parameter is used for, and to clarify any edge cases that may exist. You should also use examples to demonstrate solutions for common tasks, and you should use examples to demonstrate solutions to problems that may arise.</p> + +<p>Each example should be preceded by text explaining what the example does and anything the reader should know before beginning to read or try out the example.</p> + +<p>In addition, each piece of code should include an explanation of how it works. Keep in mind that it may make sense to break up a large piece of code into smaller portions so they can be described individually. The text following each piece of code should explain anything relevant, using an appropriate level of detail. If the code is very simple and doesn't really feature anything directly related to the API being documented, you may only give a quick summary of what it is and why it's there. If the code is intricate, uses the API being documented, or is technically creative, you should provide a more detailed explanation.</p> + +<p>When using the live sample system, it's helpful to be aware that all of the {{HTMLElement("pre")}} blocks in the area that contains the sample are concatenated together before running the example, which lets you break any or all of the HTML, CSS, and JavaScript into multiple segments, each optionally with its own descriptions, headings, and so forth. This makes documenting code incredibly powerful and flexible.</p> + +<h4 id="Overly-short_articles_are_hard_to_find">Overly-short articles are hard to find</h4> + +<p>If an article is "thin"—that is, too short—it may not be indexed properly (or at all) by search engines. As a rule of thumb, the article's body text should be at least 250-300 words. Don't artificially inflate a page that can't reasonably be expanded, but treat this guideline as a minimum target length when possible.</p> + +<h3 id="Sections_paragraphs_and_newlines">Sections, paragraphs, and newlines</h3> + +<p>Use heading levels in decreasing order: {{HTMLElement("h2")}} then {{HTMLElement("h3")}} then {{HTMLElement("h4")}}, without skipping levels. H2 is the highest level allowed because H1 is reserved for the page title. If you need more than three or four levels of headers you should consider breaking up the article into several smaller articles with a landing page, linking them together using the {{TemplateLink("Next")}}, {{TemplateLink("Previous")}}, and {{TemplateLink("PreviousNext")}} macros.</p> + +<p>The Enter (or Return) key on your keyboard starts a new paragraph. To insert a newline without a space, hold down the Shift key while pressing Enter.</p> + +<p>Don't create single subsections — you don't subdivide a topic into one. It's either two subheadings or more, or none at all.</p> + +<p>Don't have bumping heads, which are headings followed immediately by headings. Aside from looking horrible, it's helpful to readers if every heading has at least a brief intro after it to introduce the subsections beneath.</p> + +<h3 id="Lists">Lists</h3> + +<p>Lists should be formatted and structured uniformly across all contributions. Individual list items should be written with suitable punctuation, regardless of the list format. However, depending on the type of list you are creating, you will want to adjust your writing as described in the sections below.</p> + +<h4 id="Bulleted_Lists">Bulleted Lists</h4> + +<p>Bulleted lists should be used to group related pieces of concise information. Each item in the list should follow a similar sentence structure. Phrases and sentences in bulleted lists should include standard punctuation. Periods must appear at the end of each sentence in a bulleted list, including the item's final sentence, just as would be expected in a paragraph.</p> + +<p>An example of a correctly structured bulleted list:</p> + +<div class="example-good"> +<p>In this example we should include:</p> + +<ul> + <li>A condition, with a brief explanation.</li> + <li>A similar condition, with a brief explanation.</li> + <li>Yet another condition, with some further explanation.</li> +</ul> +</div> + +<p>Note how the same sentence structure repeats from bullet to bullet. In this example, each bullet point states a condition followed by a comma and a brief explanation, and each item in the list ends with a period.</p> + +<h4 id="Numbered_Lists">Numbered Lists</h4> + +<p>Numbered lists are used primarily to enumerate steps in a set of instructions. Because instructions can be complex, clarity is a priority, especially if the text in each list item is lengthy. As with bulleted lists, follow standard punctuation usage.</p> + +<p>An example of a correctly structured numbered list:</p> + +<div class="example-good"> +<p>In order to correctly structure a numbered list, you should:</p> + +<ol> + <li>Open with a heading or brief paragraph to introduce the instructions. It's important to provide the user with context before beginning the instructions.</li> + <li>Start creating your instructions, and keep each step in its own numbered item. Your instructions may be quite extensive, so it is important to write clearly and use correct punctuation.</li> + <li>After you have finished your instructions, close off the numbered list with a brief summary or explanation of the expected outcome upon completion.</li> +</ol> + +<p>This is an example of writing a closing explanation. We have created a short numbered list that provides instructive steps to produce a numbered list with the correct formatting.</p> +</div> + +<p>Note how the items in numbered lists read like short paragraphs. Because numbered lists are routinely used for instructional purposes, or to walk someone through an orderly procedure, be sure to keep each item focused: one item per number or step.</p> + +<h3 id="Text_formatting_and_styles">Text formatting and styles</h3> + +<p>Use the "Formatting Styles" drop-down list to apply predefined styles to selected content.</p> + +<div class="note">The "Note" style is used to call out important notes, like this one.</div> + +<div class="warning">Similarly, the "Warning" style creates warning boxes like this.</div> + +<p>Unless specifically instructed to do so, <strong>do not</strong> use the HTML <code>style</code> attribute to manually style content. If you can't do it using a predefined class, drop into {{IRCLink("mdn")}} and ask for help.</p> + +<h3 id="Code_sample_style_and_formatting">Code sample style and formatting</h3> + +<div class="note"> +<p><strong>Note</strong>: This section deals with the styling/formatting of code as it appears on an MDN article. If you want guidelines on actually writing code examples, see our <a href="/en-US/docs/MDN/Contribute/Guidelines/Code_samples">Code sample guidelines</a>.</p> +</div> + +<h4 id="Tabs_and_line_breaks">Tabs and line breaks</h4> + +<p>Use two spaces per tab in all code examples. Indent the code cleanly, with open-brace ("{") characters on the same line as the statement that opens the block. For example:</p> + +<pre class="brush: js notranslate">if (condition) { + /* handle the condition */ +} else { + /* handle the "else" case */ +} +</pre> + +<p>Long lines shouldn't be allowed to stretch off horizontally to the extent that they require horizontal scrolling to read. Instead, break at natural breaking points. Some examples follow:</p> + +<pre class="brush: js notranslate">if (class.CONDITION || class.OTHER_CONDITION || class.SOME_OTHER_CONDITION + || class.YET_ANOTHER_CONDITION ) { + /* something */ +} + +var toolkitProfileService = Components.classes["@mozilla.org/toolkit/profile-service;1"] + .createInstance(Components.interfaces.nsIToolkitProfileService); +</pre> + +<h4 id="Inline_code_formatting">Inline code formatting</h4> + +<p>Use the "Code" button (labeled with two angle brackets "<>") to apply inline code-style formatting to function names, variable names, and method names (this uses the {{HTMLElement("code")}} element). For example, "the <code class="js plain">frenchText()</code> function".</p> + +<p>Method names should be followed by a pair of parentheses: <code>doSomethingUseful()</code>. The parentheses help differentiate methods from other code terms.</p> + +<h4 id="Syntax_highlighting">Syntax highlighting</h4> + +<p><img alt="Screenshot of the 'Syntax Highlighter' menu." src="https://mdn.mozillademos.org/files/12682/Language%20list.png" style="border-style: solid; border-width: 1px; float: right; margin: 2px 4px;">Entire lines (or multiple lines) of code should be formatted using syntax highlighting rather than the {{HTMLElement("code")}} element. Select the appropriate language from the language list button (the one with the two code blocks), as seen in the screenshot to the right. This will insert a preformatted code box with line numbers and syntax highlighting for the chosen language.</p> + +<p>The following example shows text with JavaScript formatting:</p> + +<div class="line number2 index1 alt1"> +<pre class="brush: js notranslate">for (var i = 0, j = 9; i <= 9; i++, j--) + document.writeln("a[" + i + "][" + j + "]= " + a[i][j]);</pre> +</div> + +<p>If no appropriate language is available, use ("No Highlight" in the language menu). This will result in code without syntax highlighting:</p> + +<pre class="brush: plain notranslate">x = 42;</pre> + +<h4 id="Syntax_definitions">Syntax definitions</h4> + +<p>If you want to insert a syntax definition, you can choose the "Syntax Box" option from the "Styles" drop-down menu in the editor toolbar. This will give the syntax definition a special formatting distinguishing it from normal code.</p> + +<h4 id="Blocks_not_referring_to_code">Blocks not referring to code</h4> + +<p>There are a few use cases where a <pre> block does not refer to code and doesn't have syntax highlighting nor line numbers. In such cases you should add a <pre> without class. Those cases include things like tree structures:</p> + +<pre class="notranslate">root/ + + folder1/ + file1 + + folder2/ + file2 + file3 +</pre> + +<p>To create preformatted content without syntax highlighting and line numbers click the "pre" button in the toolbar. Then start to type the text.</p> + +<h4 id="Styling_HTML_element_references">Styling HTML element references</h4> + +<p>There are specific rules to follow when writing about HTML elements. These rules produce consistent descriptions of elements and their components. They also ensure correct linking to detailed documentation.</p> + +<dl> + <dt>Element names</dt> + <dd>Use the {{TemplateLink("HTMLElement")}} macro, which creates a link to the page for that element. For example, writing \{{HTMLElement("title")}} produces "{{HTMLElement("title")}}". If you don't want to create a link, <strong>enclose the name in angle brackets</strong> and use "Code (inline)" style (e.g., <code><title></code>).</dd> + <dt>Attribute names</dt> + <dd>Use <strong>bold face</strong>.</dd> + <dt>Attribute definitions</dt> + <dd>Use the {{TemplateLink("htmlattrdef")}} macro (e.g., <span class="nowiki">\{{htmlattrdef("type")}}</span>) for the definition term, so that it can be linked to from other pages, then use the {{TemplateLink("htmlattrxref")}} macro (e.g., <span class="nowiki">\{{htmlattrxref("attr","element")}}</span>) to reference attribute definitions.</dd> + <dt>Attribute values</dt> + <dd>Use "Code (inline)" style, and do not use quotation marks around strings, unless needed by the syntax of a code sample. For example: When the <strong>type</strong> attribute of an <code><input></code> element is set to <code>email</code> or <code>tel</code> ...</dd> +</dl> + +<h3 id="Latin_abbreviations">Latin abbreviations</h3> + +<h4 id="In_notes_and_parentheses">In notes and parentheses</h4> + +<ul> + <li>Common Latin abbreviations (etc., i.e., e.g.) may be used in parenthetical expressions and notes. Use periods in these abbreviations, followed by a comma or other appropriate punctuation. + <ul> + <li><span class="correct"><strong>Correct</strong></span>: Web browsers (e.g., Firefox) can be used ...</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: Web browsers e.g. Firefox can be used ...</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: Web browsers, e.g. Firefox, can be used ...</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: Web browsers, (eg: Firefox) can be used ...</li> + </ul> + </li> +</ul> + +<h4 id="In_running_text">In running text</h4> + +<ul> + <li>In regular text (i.e., text outside of notes or parentheses), use the English equivalent of the abbreviation. + <ul> + <li><span class="correct"><strong>Correct</strong></span>: ... web browsers, and so on.</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: ... web browsers, etc.</li> + <li><span class="correct"><strong>Correct</strong></span>: Web browsers such as Firefox can be used ...</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: Web browsers e.g. Firefox can be used ...</li> + </ul> + </li> +</ul> + +<h4 id="Meanings_and_English_equivalents_of_Latin_abbreviations">Meanings and English equivalents of Latin abbreviations</h4> + +<table class="fullwidth-table"> + <tbody> + <tr> + <th>Abbrev</th> + <th>Latin</th> + <th>English</th> + </tr> + <tr> + <td>cf.</td> + <td><em>confer</em></td> + <td>compare</td> + </tr> + <tr> + <td>e.g.</td> + <td><em>exempli gratia</em></td> + <td>for example</td> + </tr> + <tr> + <td>et al.</td> + <td><em>et alii</em></td> + <td>and others</td> + </tr> + <tr> + <td>etc.</td> + <td><em>et cetera</em></td> + <td>and so forth, and so on</td> + </tr> + <tr> + <td>i.e.</td> + <td><em>id est</em></td> + <td>that is, in other words</td> + </tr> + <tr> + <td>N.B.</td> + <td><em>nota bene</em></td> + <td>note well</td> + </tr> + <tr> + <td>P.S.</td> + <td><em>post scriptum</em></td> + <td>postscript</td> + </tr> + </tbody> +</table> + +<div class="note"> +<p>Always consider whether it's truly beneficial to use a Latin abbreviation. Some of these are used so rarely that many readers won't understand the meaning, and others are often confused with one another. And be sure that <strong>you</strong> use them correctly, if you choose to do so. For example, be careful not to confuse "e.g." with "i.e.", which is a common error.</p> +</div> + +<h3 id="Acronyms_and_abbreviations">Acronyms and abbreviations</h3> + +<h4 id="Capitalization_and_periods">Capitalization and periods</h4> + +<p>Use full capitals and delete periods in all acronyms and abbreviations, including organizations such as "US" and "UN".</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: XUL</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: X.U.L.; Xul</li> +</ul> + +<h4 id="Expansion">Expansion</h4> + +<p>On the first mention of a term on a page, expand acronyms likely to be unfamiliar to users. When in doubt, expand it, or, better, link it to the article or <a href="/en-US/docs/Glossary">glossary</a> entry describing the technology.</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: "XUL (XML User Interface Language) is Mozilla's XML-based language..."</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: "XUL is Mozilla's XML-based language..."</li> +</ul> + +<h4 id="Plurals_of_acronyms_and_abbreviations">Plurals of acronyms and abbreviations</h4> + +<p>For plurals of acronyms or abbreviations, add <em>s</em>. Don't use an apostrophe. Ever. Please.</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: CD-ROMs</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: CD-ROM's</li> +</ul> + +<h4 id="Versus_vs._and_v.">"Versus", "vs.", and "v."</h4> + +<p>The contraction "vs." is preferred.</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: this vs. that</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: this v. that</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: this versus that</li> +</ul> + +<h3 id="Capitalization">Capitalization</h3> + +<p>Use standard English capitalization rules in body text, and capitalize "World Wide Web." It is acceptable to use lower case for "web" (used alone or as a modifier) and "internet;" this guideline is a change from a previous version of this guide, so you may find many instances of "Web" and "Internet" on MDN. Feel free to change these as you are making other changes, but editing an article just to change capitalization is not necessary.</p> + +<p>Keyboard keys should use sentence-style capitalization, not all-caps capitalization. For example, "Enter" not "ENTER."</p> + +<h3 id="Contractions">Contractions</h3> + +<p>Our writing style tends to be casual, so you should feel free to use contractions (e.g., "don't", "can't", "shouldn't") if you prefer.</p> + +<h3 id="Pluralization">Pluralization</h3> + +<p>Use English-style plurals, not the Latin- or Greek-influenced forms.</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: syllabuses, octopuses</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: syllabi, octopi</li> +</ul> + +<h3 id="Hyphenation">Hyphenation</h3> + +<p>Hyphenate compounds when the last letter of the prefix is a vowel and is the same as the first letter of the root.</p> + +<ul> + <li><font color="green"><strong>Correct</strong></font>: email, re-elect, co-op</li> + <li><font color="red"><strong>Incorrect</strong></font>: e-mail, reelect, coop</li> +</ul> + +<h3 id="Gender-neutral_language">Gender-neutral language</h3> + +<p>It is a good idea to use gender-neutral language in any writing where gender is irrelevant to the subject matter, to make the text as inclusive as possible. So for example, if you are talking about the actions of a specific man, usage of he/his would be fine, but if the subject is a person of either gender, he/his isn't appropriate.<br> + <br> + Let's take the following example:</p> + +<blockquote> +<p>A confirmation dialog appears, asking the user if he allows the Web page to make use of his Web cam.</p> +</blockquote> + +<blockquote> +<p>A confirmation dialog appears, asking the user if she allows the Web page to make use of her Web cam.</p> +</blockquote> + +<p>Both versions are gender-specific. To fix this, use gender-neutral pronouns:</p> + +<blockquote> +<p>A confirmation dialog appears, asking the user if they allow the Web page to make use of their Web cam.</p> +</blockquote> + +<div class="note"> +<p>MDN allows the use of this very common syntax (which is controversial among usage authorities), to make up for the lack of a neutral gender in English. The use of the third-person plural as a gender neutral pronoun (that is, using "they," "them", "their," and "theirs") is an accepted practice, commonly known as "<a href="https://en.wikipedia.org/wiki/Singular_they">singular 'they.'</a>"</p> +</div> + +<p>You can use both genders:</p> + +<blockquote> +<p>A confirmation dialog appears, asking the user if he or she allows the web page to make use of his/her web cam.</p> +</blockquote> + +<p>making the users plural:</p> + +<blockquote> +<p>A confirmation dialog appears, asking the users if they allow the web page to make use of their web cams.</p> +</blockquote> + +<p>The best solution, of course, is to rewrite and eliminate the pronouns:</p> + +<blockquote> +<p>A confirmation dialog appears, requesting the user's permission for web cam access.</p> +</blockquote> + +<blockquote> +<p>A confirmation dialog box appears, which asks the user for permission to use the web cam.</p> +</blockquote> + +<p>The last way of dealing with the problem is arguably better, as it is not only grammatically more correct but removes some of the complexity associated with dealing with genders across different languages that may have wildly varying gender rules. This solution can make translation easier for both readers and localizers.</p> + +<h3 id="Numbers_and_numerals">Numbers and numerals</h3> + +<h4 id="Dates">Dates</h4> + +<p>For dates (not including dates in code samples) use the format "January 1, 1990".</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: February 24, 2006</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: February 24th, 2006; 24 February, 2006; 24/02/2006</li> +</ul> + +<p>Alternately, you can use the YYYY/MM/DD format.</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: 2006/02/24</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: 02/24/2006; 24/02/2006; 02/24/06</li> +</ul> + +<h4 id="Decades">Decades</h4> + +<p>For decades, use the format "1990s". Don't use an apostrophe.</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: 1990s</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: 1990's</li> +</ul> + +<h4 id="Plurals_of_numerals">Plurals of numerals</h4> + +<p>For plurals of numerals add "s". Don't use an apostrophe.</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: 486s</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: 486's</li> +</ul> + +<h4 id="Commas">Commas</h4> + +<p>In running text, use commas only in five-digit and larger numbers.</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: 4000; 54,000</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: 4,000; 54000</li> +</ul> + +<h3 id="Punctuation">Punctuation</h3> + +<h4 id="Serial_comma">Serial comma</h4> + +<p><strong>Use the serial comma</strong>. The serial (also known as "Oxford") comma is the comma that appears before the conjunction in a series of three or more items.</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: I will travel on trains, planes, and automobiles.</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: I will travel on trains, planes and automobiles.</li> +</ul> + +<div class="note"> +<p>This is in contrast to the <a href="https://www.mozilla.org/en-US/styleguide/" title="https://www.mozilla.org/en-US/styleguide/">One Mozilla style guide</a>, which specifies that the serial comma is not to be used. MDN is an exception to this rule.</p> +</div> + +<h4 id="Apostrophes_and_quotation_marks">Apostrophes and quotation marks</h4> + +<p><strong>Do not use "curly" quotes and quotation marks.</strong> On MDN, we only use straight quotes and apostrophes. There are a couple of reasons for this. First, because we need to choose one or the other for consistency, and second, because if curly quotes or apostrophes make their way into code snippets (even inline ones), readers may copy and paste them and expect them to function, which they will not.</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: Please don't use "curly quotes."</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: Please don‘t use “curly quotes.”</li> +</ul> + +<h3 id="Spelling">Spelling</h3> + +<p>For words with variant spellings, always use their American English spelling. In general, use the first entry at <a href="http://www.dictionary.com/">Dictionary.com</a>, unless that entry is listed as a variant spelling or as being primarily used in a non-American form of English; for example, if you <a href="http://www.dictionary.com/browse/behaviour">look up "behaviour"</a>, you find the phrase "Chiefly British" followed by a link to the American standard form, "<a href="http://dictionary.reference.com/browse/behavior">behavior</a>". Do not use variant spellings.</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: localize, behavior</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: localise, behaviour</li> +</ul> + +<h3 id="Terminology">Terminology</h3> + +<dl> +</dl> + +<h4 id="HTML_elements">HTML elements</h4> + +<p>Use "elements" to refer to HTML and XML elements, rather than "tags". In addition, they should almost always be wrapped in "<>", and should be in the {{HTMLElement("code")}} style. When you reference a given element for the first time in a section, you should use the {{TemplateLink("HTMLElement")}} macro to create a link to the documentation for the element (unless you're writing within that element's reference document page).</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: the {{HTMLElement("span")}} element</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: the span tag</li> +</ul> + +<h4 id="Parameters_vs._arguments">Parameters vs. arguments</h4> + +<p>The preferred term on MDN is <strong>parameters</strong>. Please avoid the term "arguments" for consistency if at all possible.</p> + +<h4 id="User_interface_actions">User interface actions</h4> + +<p>In task sequences, describe user interface actions using the imperative mood. Identify the user interface element by its label and type.</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: Click the Edit button.</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: Click Edit.</li> +</ul> + +<h3 id="Voice">Voice</h3> + +<p>While the active voice is preferred, the passive voice is also acceptable, given the informal feel of our content. Try to be consistent, though.</p> + +<h2 id="Wiki_markup_and_usage">Wiki markup and usage</h2> + +<h3 id="Links">Links</h3> + +<p>Links are a large part of what makes a wiki a powerful learning and teaching tool. Below you'll find some basic information, but you can find a complete guide to <a href="/en-US/docs/MDN/Contribute/Editor/Links">creating and editing links on MDN</a> in our editor guide.</p> + +<p>We encourage you to create appropriate links among articles; they help improve navigation and discoverability of content, and they provide important context to search engines like Google to help them provide better results. Every page should have a good set of links from words or phrases to other pages that expand upon the relevant ideas. This can be used both to define terms and to provide more in-depth or detailed documentation about a topic, or to connect to a related page that offers examples or information that may be of further interest.</p> + +<p>You can easily create links not only among pages on MDN (internal links) but also to pages outside MDN (external links).</p> + +<p>There are two ways to create links: you explicitly create a link using the Link button in the editor's toolbar—or by pressing <kbd>Ctrl</kbd>+<kbd>K</kbd> (<kbd>Cmd</kbd>-<kbd>K</kbd> on the Mac)—or you can use MDN's powerful macro system to generate links automatically or based on an input value.</p> + +<p>When deciding what text to use as a link, there are a few guidelines you can follow:</p> + +<ul> + <li>Whenever a macro exists which will create the link you need, and you are able to do so, please do. <a href="/en-US/docs/MDN/Contribute/Editor/Links#Using_link_macros">Using macros to create links</a> will not only help you get it right, but will allow future improvements to MDN to automatically be applied to your link.</li> + <li>For an API name, use the entire string of the API term as written in your content. The easiest way to do this is to <a href="/en-US/docs/MDN/Contribute/Editor/Links#Linking_to_documentation_for_APIs">use the appropriate macro</a> to construct a properly-formatted link for you.</li> + <li>For a term for which you're linking to a page defining or discussing that term, use the name of the term and no additional text as the link's text. For example: + <ul> + <li><span class="correct"><strong>Correct</strong></span>: You can use <a href="/en-US/docs/Web/JavaScript">JavaScript</a> code to create dynamic applications on the Web.</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: You can use <a href="/en-US/docs/Web/JavaScript">JavaScript code</a> to create dynamic applications on the Web.</li> + </ul> + </li> + <li>Otherwise, when adding a useful link to prose, try to choose an action and object phrase, such as: + <ul> + <li><span class="correct"><strong>Correct</strong></span>: If you'd like to <a href="/en-US/docs/Mozilla/Developer_guide">contribute to the Firefox project</a>, your first step is to <a href="/en-US/docs/Mozilla/Developer_guide/Build_Instructions">download and build Firefox</a>.</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: <a href="/en-US/docs/Mozilla/Developer_guide">If you'd like to contribute to the Firefox project</a>, your first step is to <a href="/en-US/docs/Mozilla/Developer_guide/Build_Instructions">download and build</a> Firefox.</li> + </ul> + </li> +</ul> + +<h4 id="URL_schemes">URL schemes</h4> + +<p>For security reasons, you should only create links that use the following schemes:</p> + +<ul> + <li><code>http://</code></li> + <li><code>https://</code></li> + <li><code>ftp://</code></li> + <li><code>mailto:</code></li> +</ul> + +<p>Others may or may not work, but are not supported and will probably be removed by editorial staff.</p> + +<div class="note"> +<p>In particular, be sure not to use the <code>about:</code> or <code>chrome://</code> schemes, as they will not work. Similarly, the <code>javascript:</code> scheme is blocked by most modern browsers, as is <code>jar:</code>.</p> +</div> + +<h3 id="Page_tags">Page tags</h3> + +<p>Tags provide meta information about a page and/or indicate that a page has specific improvements needed to its content. Every page in the wiki should have tags. You can find details on tagging in our <a href="/en-US/docs/MDN/Contribute/Howto/Tag">How to properly tag pages</a> guide.</p> + +<p>The tagging interface lives at the bottom of a page while you're in edit mode, and looks something like this:</p> + +<p><img alt="Screenshot of the UX for adding and removing tags on MDN" src="https://mdn.mozillademos.org/files/7859/tag-interface.png" style="border-style: solid; border-width: 1px; height: 167px; width: 863px;"></p> + +<p>To add a tag, click in the edit box at the end of the tag list and type the tag name you wish to add. Tags will autocomplete as you type. Press enter (or return) to submit the new tag. Each article may have as many tags as needed. For example, an article about using JavaScript in AJAX programming might have both "JavaScript" and "AJAX" as tags.</p> + +<p>To remove a tag, just click the little "X" icon in the tag.</p> + +<h4 id="Tagging_pages_that_need_work">Tagging pages that need work</h4> + +<p>In addition to using tags to track information about the documentation's quality and content, we also use them to mark articles as needing specific types of work.</p> + +<h4 id="Tagging_obsolete_pages">Tagging obsolete pages</h4> + +<p>Use the following tags for pages that are not current:</p> + +<ul> + <li><em>Junk</em>: Use for spam, pages created by mistake, or content that is so bad that it should be deleted. Pages with this tag are deleted from time to time.</li> + <li><em>Obsolete</em>: Use for content that is technically superseded, but still valid in context. For example an HTML element that is obsolete in HTML5 is still valid in HTML 4.01. You can also use the <span class="nowiki">{{TemplateLink("obsolete_header")}}</span> macro to put a prominent banner on the topic.</li> + <li><em>Archive</em>: Use for content that is technically superseded and no longer useful. If possible, add a note to the topic referring readers to a more current topic. For example, a page that describes how to use the Mozilla CVS repository should refer readers to a current topic on using Mercurial repos. (If no corresponding current topic exists, use the <em>NeedsUpdate</em> tag, and add an explanation on the Talk page.) Pages with the Archive tag are eventually moved from the main content of MDN to the <a href="/en-US/docs/Archive">Archive</a> section.</li> +</ul> + +<h3 id="SEO_summary">SEO summary</h3> + +<p>The SEO summary provides a short description of a page. It will be reported as a summary of the article to robots crawling the site, and will then appear in search results for the page. It is also used by macros that automate the construction of landing pages inside MDN itself.</p> + +<p>By default, the first paragraph of the page is used as the SEO summary. However, you can override this behavior by marking a section with the <a href="/en-US/docs/Project:MDN/Contributing/Editor_guide/Editing#Formatting_styles">"SEO summary" style in the WYSIWYG editor</a>.</p> + +<h3 id="Landing_pages">Landing pages</h3> + +<p><strong>Landing pages</strong> are pages at the root of a topic area of the site, such as the main <a href="/en-US/docs/CSS" title="CSS">CSS</a> or <a href="/en-US/docs/HTML" title="HTML">HTML</a> pages. They have a standard format that consists of three areas:</p> + +<ol> + <li>A brief (typically one paragraph) overview of what the technology is and how it's used. See {{anch("Writing a landing page overview")}} for tips.</li> + <li>A two-column list of links with appropriate headings. See {{anch("Creating a page link list")}} for guidelines.</li> + <li>An <strong>optional</strong> "Browser compatibility" section at the bottom of the page.</li> +</ol> + +<h4 id="Creating_a_page_link_list">Creating a page link list</h4> + +<p>The link list section of an MDN landing page consists of two columns. These are created using the following HTML:</p> + +<pre class="brush: html notranslate"><div class="row topicpage-table"> + <div class="section"> + ... left column contents ... + </div> + <div class="section"> + ... right column contents ... + </div> +</div></pre> + +<p>The left column should be a list of articles, with an <code><h2></code> header at the top of the left column explaining that it's a list of articles about the topic (e.g., "Documentation and tutorials about foo"); this header should use the CSS class "Documentation". Below that is a <code><dl></code> list of articles with each article's link in a <code><dt></code> block and a brief one-or-two sentence summary of the article in the corresponding <code><dd></code> block.</p> + +<p>The right column should contain one or more of the following sections, in order:</p> + +<dl> + <dt>Getting help from the community</dt> + <dd>This should provide information on Matrix chat roomsand mailing lists available on the topic. The heading should use the class "Community".</dd> + <dt>Tools</dt> + <dd>A list of tools the user can look at to help with the use of the technology described in this section of MDN. The heading should use the class "Tools".</dd> + <dt>Related topics</dt> + <dd>A list of links to landing pages for other, related, technologies of relevance. The heading should use the class "Related_Topics".</dd> +</dl> + +<p><strong><<<finish this once we finalize the landing page standards>>></strong></p> + +<h2 id="Using_inserting_images">Using, inserting images</h2> + +<p>It's sometimes helpful to provide an image in an article you create or modify, especially if the article is very technical. To include an image:</p> + +<ol> + <li>Attach the desired image file to the article (at the bottom of every article in edit mode)</li> + <li>Create an image in the WYSIWYG editor</li> + <li>In the WYSIWYG editor, in the drop-down list of attachments, select the newly created attachment that is your image</li> + <li>Press OK.</li> +</ol> + +<h2 id="Other_references">Other references</h2> + +<h3 id="Preferred_style_guides">Preferred style guides</h3> + +<p>If you have questions about usage and style not covered here, we recommend referring to the <a href="http://www.economist.com/styleguide/introduction">Economist style guide</a> or, failing that, the <a href="https://www.amazon.com/Chicago-Manual-Style-16th/dp/0226104206">Chicago Manual of Style</a>.</p> + +<h3 id="Preferred_dictionary">Preferred dictionary</h3> + +<p>For questions of spelling, please refer to <a href="http://www.dictionary.com/">Dictionary.com</a>. The spelling checker for this site uses American English. Please do not use variant spellings (e.g., use <em>color</em> rather than <em>colour</em>).</p> + +<p>We will be expanding the guide over time, so if you have specific questions that aren't covered in this document, please post them on the <a href="https://discourse.mozilla.org/c/mdn">MDN discussion forum</a>, so we know what should be added.</p> + +<h3 id="MDN-specific">MDN-specific</h3> + +<ul> + <li><a href="/en-US/docs/MDN/Contribute/Structures/Macros/Commonly-used_macros" title="Project:en/Custom_Templates">Commonly-used macros</a> on MDN, with explanations.</li> +</ul> + +<h3 id="Language_grammar_spelling">Language, grammar, spelling</h3> + +<p>If you're interested in improving your writing and editing skills, you may find the following resources to be helpful.</p> + +<ul> + <li><a href="http://www.amazon.com/Writing-Well-30th-Anniversary-Nonfiction/dp/0060891548">On Writing Well</a>, by William Zinsser (Amazon link)</li> + <li><a href="http://www.amazon.com/Style-Basics-Clarity-Grace-4th/dp/0205830765/" title="http://www.amazon.com/Style-Lessons-Clarity-Grace-Edition/dp/0321898680">Style: The Basics of Clarity and Grace</a>, by Joseph Williams and Gregory Colomb (Amazon link)</li> + <li><a href="https://brians.wsu.edu/common-errors-in-english-usage/">Common Errors in English</a></li> + <li><a href="http://www-personal.umich.edu/~jlawler/aue.html">English Grammar FAQ</a> (alt.usage.english)</li> + <li><a href="http://www.angryflower.com/bobsqu.gif">Bob's quick guide to the apostrophe, you idiots</a> (funny)</li> + <li><a href="http://www.amazon.com/Merriam-Websters-Concise-Dictionary-English-Usage/dp/B004L2KNI2" title="http://www.amazon.com/Merriam-Websters-Concise-Dictionary-English-Usage/dp/B004L2KNI2">Merriam-Webster's Concise Dictionary of English Usage</a> (Amazon link): Scholarly but user-friendly, evidence-based advice; very good for non-native speakers, especially for preposition usage.</li> + <li><a href="http://english.stackexchange.com/">English Language and Usage StackExchange</a>: Question and answer site for English language usage.</li> +</ul> diff --git a/files/ar/mdn/index.html b/files/ar/mdn/index.html new file mode 100644 index 0000000000..351c99c218 --- /dev/null +++ b/files/ar/mdn/index.html @@ -0,0 +1,28 @@ +--- +title: مشروع شبكة مطوري موزيلا +slug: MDN +tags: + - صفحة هبوط + - معلومات عن الشبكة +translation_of: MDN +--- +<div>{{MDNSidebar}}</div> + +<p dir="rtl"><strong>شبكة مطوري موزيلا</strong> (MDN) هي موسوعة نقوم فيها بتوثيق كل ما يخص الأنترنت المفتوح، التقنيات، وغيرها من الموضوعات التي تخص المطورين. أي شخص مرحب به لإضافة وتحرير المحتوى. تجدر الإشارة إلى أنك لست بحاجة إلى أن تكون مبرمجا أو أن تعرف الكثير عن التكنولوجيا؛ حيث أن هناك العديد من المهام المختلفة التي يمكنك القيام بها، من البسيط (مراجعة وتصحيح الأخطاء الإملائية) إلى المتقدم (كتابة وثائق حول الواجهات البرمجية).</p> + +<p class="summary" dir="rtl">هدف مشروع MDN هو توثيق الويب الحر، تكنولوجيات موزيلا وكذا مشاريعها. ندعوك لمساعدتنا في ذلك!</p> + +<p dir="rtl">نحن في حاجة إلى مساعدتك! إن الأمر بسيط. ولا تقلق حيال طلب الإذن أو إرتكاب الأخطاء. من جهة أخرى، ندعوك للتعرف على <a href="/ar/docs/MDN/Community">مجتمع شبكة مطوري موزيلا</a>، فنحن هنا لمساعدتك! التوثيق أسفله سوف يساعدك على الانطلاق</p> + +<ul class="card-grid"> + <li><span><a href="/ar/docs/MDN/Getting_started">بداية سريعة للوافدين الجدد</a></span> + + <p>هل أنت جديد على شبكة مطوري موزيلا وتود تعلم كيفية جعلها أفضل؟ إذن إبدأ من هنا</p> + </li> + <li><span><a href="/en-US/docs/MDN/Contribute">أنا مستخدم متمرس</a></span> + <p>أدخل إلى دليلنا الشامل والمعمق لمساهمي شبكة مطوري موزيلا لتعلم المزيد</p> + </li> + <li><span><a class="new" href="/ar/docs/MDN/About/Promote" rel="nofollow">أخبر الباقي عنا</a></span> + <p>إذا كنت تحب شبكة مطوري موزيلا، ساعد إذن على إخبار الناس عنها! يمكنك إيجاد كل مايمكنه مساعدتك على ذلك من أدوات وإرشادات</p> + </li> +</ul> diff --git a/files/ar/mdn/kuma/index.html b/files/ar/mdn/kuma/index.html new file mode 100644 index 0000000000..8ab5de16e5 --- /dev/null +++ b/files/ar/mdn/kuma/index.html @@ -0,0 +1,25 @@ +--- +title: برمجية الموسوعة كوما +slug: MDN/Kuma +tags: + - صفحة هبوط + - معلومات عن الشبكة +translation_of: MDN/Kuma +--- +<div>{{MDNSidebar}}</div> + +<div>{{IncludeSubnav("/ar/docs/MDN")}}</div> + +<p dir="rtl">كوما (Kuma) هي برمجيّة موسوعة مبنيّة باستخدام جانغو، وهي البرمجيّة التي تعتمد عليها شبكة مطوري موزيلا في عملها.</p> + +<p>{{SubpagesWithSummaries}}</p> + +<h2 dir="rtl" id="شارك_بتطوير_المنصة">شارك بتطوير المنصة</h2> + +<p dir="rtl">للمشاركة في تطوير كوما:</p> + +<ul dir="rtl"> + <li>قم بزيارة <a href="https://github.com/mozilla/kuma">صفحة المشروع على جيتهاب</a>.</li> + <li>تحقق من <a href="https://github.com/mozilla/kuma/blob/master/CONTRIBUTING.md">دليل المساهمة</a>.</li> + <li>إن لزم الأمر، تعمق في <a href="http://kuma.readthedocs.org/en/latest/">توثيق البرمجيّة الشامل</a>.</li> +</ul> diff --git a/files/ar/mdn/tools/deleting_pages/index.html b/files/ar/mdn/tools/deleting_pages/index.html new file mode 100644 index 0000000000..14b1632e0a --- /dev/null +++ b/files/ar/mdn/tools/deleting_pages/index.html @@ -0,0 +1,21 @@ +--- +title: Deleting pages +slug: MDN/Tools/Deleting_pages +tags: + - Guide + - MDN Meta + - Page-level + - Tools +translation_of: MDN/Tools/Page_deletion +--- +<div>{{MDNSidebar}}</div><p>Only MDN administrators are able to delete pages. <span class="seoSummary">This article explains how to request that a page be removed from MDN.</span></p> + +<p>To arrange for a page to be deleted, you should do the following:</p> + +<ol> + <li><strong>Do not erase or change the page content.</strong> We want to have the record of the page as it was at deletion time.</li> + <li>Add the tag "junk" to the page. Do not remove other tags.</li> + <li>If the page is particularly urgently in need of deletion (for example, its content is inappropriate, offensive, or technically dangerous), <a href="mailto:mdn-admins@mozilla.org" title="Notify an administrator">notify an MDN administrator</a>.</li> +</ol> + +<p>An administrator will delete the page when possible, after confirming that deletion is appropriate</p> diff --git a/files/ar/mdn/tools/index.html b/files/ar/mdn/tools/index.html new file mode 100644 index 0000000000..179ed3a070 --- /dev/null +++ b/files/ar/mdn/tools/index.html @@ -0,0 +1,15 @@ +--- +title: MDN tools +slug: MDN/Tools +tags: + - Landing + - MDN Meta +translation_of: MDN/Tools +--- +<div>{{MDNSidebar}}</div> + +<div>{{IncludeSubnav("/ar/docs/MDN")}}</div> + +<p>MDN offers a number of features that make it easier to track progress, manage content, and keep up with the latest changes to the site.</p> + +<div>{{LandingPageListSubpages}}</div> |