diff options
Diffstat (limited to 'files/id/mdn')
| -rw-r--r-- | files/id/mdn/about/index.html | 135 | ||||
| -rw-r--r-- | files/id/mdn/contribute/feedback/index.html | 56 | ||||
| -rw-r--r-- | files/id/mdn/contribute/getting_started/index.html | 126 | ||||
| -rw-r--r-- | files/id/mdn/contribute/howto/index.html | 16 | ||||
| -rw-r--r-- | files/id/mdn/contribute/howto/tag/index.html | 373 | ||||
| -rw-r--r-- | files/id/mdn/contribute/index.html | 23 | ||||
| -rw-r--r-- | files/id/mdn/contribute/processes/index.html | 23 | ||||
| -rw-r--r-- | files/id/mdn/guidelines/index.html | 16 | ||||
| -rw-r--r-- | files/id/mdn/guidelines/writing_style_guide/index.html | 802 | ||||
| -rw-r--r-- | files/id/mdn/tools/index.html | 15 |
10 files changed, 0 insertions, 1585 deletions
diff --git a/files/id/mdn/about/index.html b/files/id/mdn/about/index.html deleted file mode 100644 index f220277d09..0000000000 --- a/files/id/mdn/about/index.html +++ /dev/null @@ -1,135 +0,0 @@ ---- -title: About MDN Web Docs -slug: MDN/About -translation_of: MDN/About ---- -<div>{{MDNSidebar}}</div> - -<div>{{IncludeSubNav("/en-US/docs/MDN")}}</div> - -<p>MDN Web Docs (yang sebelumnya dikenal sebagai MDN — the Mozilla Developer Network) adalah sebuah platform pembelajaran untuk teknologi web dan perangkat lunak yang berbasis Web. termasuk: </p> - -<ul> - <li>Standar Web seperti <a href="/en-US/docs/CSS" title="/en-US/docs/CSS">CSS</a>, <a href="/en-US/docs/HTML" title="/en-US/docs/HTML">HTML</a>, dan <a href="/en-US/docs/JavaScript" title="/en-US/docs/JavaScript">JavaScript</a></li> - <li><a href="/en-US/docs/Apps" title="/en-US/docs/Apps">Open Web app development</a></li> - <li><a href="/en-US/docs/Add-ons" title="/en-US/docs/Add-ons">Firefox add-on development</a></li> -</ul> - -<h2 id="Misi_Kami">Misi Kami</h2> - -<p>Misi MDN sederhana: menyediakan pengembang informasi yang pengembang butuhkan untuk membangun proyek <a href="https://wiki.developer.mozilla.org/en-US/docs/Web">open Web</a> dengan mudah. Jika MDN adalah sebuah teknologi terbuka di Web, kita ingin mendokumentasikannya.</p> - -<p>Kita juga menyediakan dokumentasi tentang <a href="https://wiki.developer.mozilla.org/en-US/docs/Mozilla">Mozilla products</a> dan cara <a href="https://wiki.developer.mozilla.org/en-US/docs/Mozilla">build and contribute to Mozilla projects</a>.</p> - -<p>Jika kamu tidak yakin apakah sebuah artikel harus dibahas di MDN, baca <a href="https://wiki.developer.mozilla.org/en-US/docs/Project:MDN/Contributing/Does_this_belong">Does this belong on MDN?</a></p> - -<h2 id="Cara_kamu_dapat_membantu">Cara kamu dapat membantu</h2> - -<p>Kamu tidak perlu menjadi seorang coder profesional atau penulis untuk membantu MDN! Kita mempunya banyak cara agar kamu dapat membantu, dari me-review artikel memastikan artikel tersebut masuk akal, kontribusi di tulisan, menambahkan contoh kode. Sebenarnya, ada banyak cara untuk membantu. Kami memiliki halaman <a href="/en-US/docs/MDN/Getting_started">Getting Started</a> yang membantu kamu mengambil tugas untuk dikerjakan berdasarkan ketertarikanmu dan jumlah waktu yang kamu luangkan!.</p> - -<p>Kamu juga dapat membantu dengan mempromosikan<a href="/en-US/docs/MDN/About/Promote"> MDN</a> pada blog atau website mu.</p> - -<h2 id="Komunitas_MDN">Komunitas MDN </h2> - -<p>Komunitas kita bersifat global. Kami memiliki kontributor yang luar biasa di seluruh dunia yang bekerja dengan berbagai bahasa. Jika kamu suka untuk belajar lebih banyak tentang kita, atau kamu butuh bantuan MDN, cek <a href="https://discourse.mozilla-community.org/c/mdn">discussion forum</a> kami atau saluran <a href="irc://irc.mozilla.org#mdn">IRC</a>! Kamu juga dapat menetahui berita terbaru tentang kamu dengan me- follow akun Twitter, <a href="http://twitter.com/MozDevNet">@MozDevNet</a>. Kamu juga dapat mengirimkan cuitan ke kami jika kau melihat sesuatu yang salah atau jika kamu suka memberikan masukkan (kami akan berterima kasih) pada penulis - penulis dan kontributor kami.</p> - - - -<h2 id="Menggunakan_konten_website_dokumentasi_MDN">Menggunakan konten website dokumentasi MDN</h2> - -<p>Konten MDN tersedia gratis, dan berlisensi open source.</p> - -<h3 id="Hak_cipta_dan_lisensi">Hak cipta dan lisensi</h3> - -<p>Konten MDN semuanya tersedia dengan berbagai variasi lisensi open source. Pada bagian ini membahas tipe-tipe konten yang kami sediakan dan lisensi yang berefek di masing-masingnya.</p> - -<h4 id="Dokumentasi_dan_artikel">Dokumentasi dan artikel</h4> - -<p><strong>MDN wiki documents</strong> telah disiapkan oleh kontribusi-kontribusi penulis baik dari dalam maupun dari luar Mozilla Foundation. Kecuali diyatakan lain, konten tersedia dibawah syarat <a class="external text" href="https://creativecommons.org/licenses/by-sa/2.5/" rel="nofollow">Creative Commons Attribution-ShareAlike license</a> (CC-BY-SA), v2.5 atau versi selanjutnya. </p> - -<p>Ketika menggukan ulang konten MDN, kamu perlu memastikan 2 hal:</p> - -<ol> - <li> - <p>Atribusi diberikan pada konten orisinil.</p> - - <p>Mohon atribut "Kontributor Mozilla" dan termasuk sebuah tautan (online) atau URL (cetak) ke halaman wiki khusus untuk sumber konten. Contoh, untuk menyediakan atribusi pada artikel ini, kamu dapat menulis:</p> - - <blockquote> - <p><a href="https://developer.mozilla.org/en-US/docs/MDN/About">About MDN</a> oleh <a href="https://developer.mozilla.org/en-US/docs/MDN/About$history">Mozilla Contributors</a> dibawah lisensi <a href="https://creativecommons.org/licenses/by-sa/2.5/">CC-BY-SA 2.5</a>.</p> - </blockquote> - - <p>Catat bahwa pada contoh, tautan "Mozilla Contributors" ke halaman official. liat <a href="https://wiki.creativecommons.org/Marking/Users">Best practices for attribution</a> untuk penjelasan lebih lanjut.</p> - </li> - <li> - <p>Penggunaan ulang di publikasikan dibawah lisensi yag sama dengan konten original—CC-BY-SA v2.5 atau versi selanjutnya.</p> - </li> -</ol> - -<h4 id="Contoh_kode_dan_bagian_kecil">Contoh kode dan bagian kecil</h4> - -<p>Contoh kode yang ditambahkan pada atau setelah 20 Agustus 2010 pada <a class="external" href="https://creativecommons.org/publicdomain/zero/1.0/">public domain</a> (<a href="https://creativecommons.org/publicdomain/zero/1.0/">CC0</a>). Tidak diperlukan pemberitahuan lisensi, tapi jika kamu butuh lisensi, kamu dapat menggunakan: "Any copyright is dedicated to the Public Domain. http://creativecommons.org/publicdomain/zero/1.0/".</p> - -<p>Contoh kode yang ditambahkan pada wiki ini sebelum 20 Agustus 2010 tersedia dibawah lisensi <a class="external" href="https://opensource.org/licenses/mit-license.php">MIT license</a>; Kamu harus menambahkan informasi atribusi pada MIT template: "© <tanggal revisi halaman wiki> <nama orang yang memasukkan ke wiki></p> - -<p>Kamu dapat menentukan lisensi mana pada sebuah contoh kode yang tersedia dibawah history artikel. Untuk menampilkan history :</p> - -<ol> - <li>Klik tombol <strong>Edit in wiki</strong> pada header artikel. Tombol ini membawa kamu pada artikel sama yang <a href="https://wiki.developer.mozilla.org">editable, wiki version of MDN Web Docs</a> (tapi tidak benar-benar menempatkan artikel pada mode edit). </li> - <li>Klik ikon berbentuk roda gigi pada header di artikel wiki, dan pilih <strong>History </strong>pada menu yang muncul.</li> - <li>Klik <strong>View All</strong>, dan lihat revisi terbaru yang ada sebelum 20 Agustus 2010 (jika ada) .</li> - <li>Klik stempel tanggal dari revisi untuk melihat revisi pada artikel dihari itu .</li> -</ol> - -<p>Jika terdapat contoh revisi yang kamu pilih, kemudian revisi itu ditambahkan sebelum lisensi dirubah dan tersedia dibawah syarat lisensi MIT. Jika contoh kode tidak ada atau tidak ada revisi sebelum 20 Agustus 2010, kemudian revisi telah ditambahkan setelah berubah dan pada domain publik.</p> - -<h4 id="Kontribusi">Kontribusi</h4> - -<p>Jika kamu berharap untuk berkontribusi pada wiki ini, kamu harus membuat dokumentasi tersedia dibawah lisensi Attribution-ShareAlike (atau ada kalanya sebuah lisensi alternatif yang secara khusus pada halaman yang kamu edit), dan contoh kode tersedia dibawah <a href="https://creativecommons.org/publicdomain/zero/1.0/">Creative Commons CC-0</a> (sebuah dedikasi Public Domain ). Menambahkan pada wiki ini berarti kamu setuju bahwa kontribusimu akan dibuat tersedia dibawah lisensi tersebut.</p> - -<p>Beberapa konten lama yang telah dibuat dibawah sebuah lisensi lain dari pada lisensi yang telah dijelaskan diatas; Konten ini ditunjukkan pada bagian bawah disetiap halaman melalui sebuah <a class="internal" href="/Archive/Meta_docs/Examples/Alternate_License_Block">Alternate License Block</a>.</p> - -<div class="warning"> -<p>Tidak ada halaman baru yang mungkin dibuat menggunakan alternate licenses.</p> -</div> - -<p><strong>Hak cipta untuk kontribusi materi tetap pada penulis kecuali penulis menetapkannya pada orang lain</strong>.</p> - -<p>Jika kamu memiliki pertanyaan atau kepentingan tentang diskusi disini, mohon hubungi<a class="external" href="mailto:mdn-admins@mozilla.org?subject=MDN%20licensing%20question" rel="nofollow" title="mailto:eshepherd@mozilla.com"> MDN administrators</a>.</p> - -<h4 id="Logo_merek_dagang_tanda_layanan_dan_tanda_kata.">Logo, merek dagang, tanda layanan dan tanda kata.</h4> - -<hr> -<p>Hak pada merek datang, logo, dan tanda layanan pada Mozilla Foundation, serta tampilan dan nuansa pada website, tidak berada dibawah lisensi Creative Commons, dan luasnya merupakan karya penulis (seperti logo dan desain grafis), mereka tidak termasuk pada karya yang dibawah lisensi pada persyaratan tersebut. Jika kamu menggunakan tulisan pada dokumen, dan berharap menggunakan hak ini, atau kamu punya pertanyaan-pertanyaan lain tentang mematuhi persyaratan lisensi pada koleksi ini. kamu harus menghubungi Mozilla Foundation disini: <a class="external text" href="mailto:licensing@mozilla.org" rel="nofollow" title="mailto:licensing@mozilla.org">licensing@mozilla.org</a>.</p> - -<h3 id="Menautkan_MDN">Menautkan MDN</h3> - -<p>Lihat artikel ini untuk pedoman <a href="/en-US/docs/MDN/About/Linking_to_MDN">linking to MDN</a> untuk praktek terbaik ketika menautkan.</p> - -<h2 id="Mengunduh_konten">Mengunduh konten</h2> - -<h3 id="Halaman_tunggal">Halaman tunggal</h3> - -<p>Kamu dapat menyalin konten dari halaman tunggal pada MDN dengan menambahkan <a href="/en-US/docs/MDN/Contribute/Tools/Document_parameters#URL_parameters">URL parameters</a> untuk menetapkan format yang kamu inginkan.</p> - -<h3 id="Alat_Third-party">Alat Third-party</h3> - -<p>Kamu dapat meliat konten MDN melalui alat third-party seperti <a href="https://kapeli.com/dash">Dash</a> (untuk macOS) dan <a href="https://zealdocs.org/">Zeal</a> (untuk Linux dan Windows).</p> - -<p><a href="https://kapeli.com/">Kapeli</a> juga mempublikasikan <a href="https://kapeli.com/mdn_offline">offline MDN docs</a> covering HTML, CSS, JavaScript, SVG, dan XSLT.</p> - -<h2 id="Melaporkan_masalah_pada_Documen_Web_MDN">Melaporkan masalah pada Documen Web MDN</h2> - -<p>lihat <a href="/en-US/docs/MDN/Contribute/Howto/Report_a_problem">How to report a problem on MDN</a>.</p> - -<h2 id="Sejarah_Dokumen_Web_MDN">Sejarah Dokumen Web MDN</h2> - -<p>MDN Web Docs (sebelumnya <em>Mozilla Developer Network (MDN)</em>, sebelumnya <em>Mozilla Developer Center (MDC)</em>, a.k.a. <em>Devmo</em>) proyek dimulai pada awal 2005, ketika <a class="external" href="https://foundation.mozilla.org">Mozilla Foundation</a> memperoleh sebuah lisensi dari AOL untuk menggunakan konten original Netscape <a href="https://web.archive.org/web/*/devedge.netscape.com" title="Project:en/DevEdge">DevEdge</a>. Konten DevEdge merupakan konten yang masih sangat berguna yang kemudian di migrasi sukarelawan pada wiki ini sehingga konten ini menjadi mudah diperbarui dan dipelihara.</p> - -<p>Nama telah dirubah menjadi MDN Web Docs pada Juni 2017. Lihat <a href="https://blog.mozilla.org/opendesign/future-mdn-focus-web-docs/">The Future of MDN: A Focus on Web Docs</a> untuk alasan dibalik keputusan ini.</p> - -<p>Kamu dapat mencari lebih banyak sejarah MDN pada halaman <a href="/en-US/docs/MDN_at_ten">10th anniversary celebration</a> kami, termasuk sejarah lain oleh beberapa orang yang terlibat.</p> - -<h2 id="Tentang_Mozilla">Tentang Mozilla</h2> - -<p>Kalau kamu ingin mempelajari lebih banyak tentang siapa kita, bagaimana menjadi bagian dari <em>Mozilla</em> atau sekedar tempat menemukan kita, kamu berada di tempat yang tepat. Untuk menemukan hal yang mendorong kami dan yang membuat kami berbeda, mohon kunjungi halaman <a href="https://www.mozilla.org/en-US/mission/">mission</a> kita.</p> diff --git a/files/id/mdn/contribute/feedback/index.html b/files/id/mdn/contribute/feedback/index.html deleted file mode 100644 index fc2958dc4f..0000000000 --- a/files/id/mdn/contribute/feedback/index.html +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: 'Project:Tanggapan' -slug: MDN/Contribute/Feedback -tags: - - Dokumentasi - - MDN - - MDN Meta - - Panduan -translation_of: MDN/Contribute/Feedback ---- -<div>{{MDNSidebar}}</div> - -<p>Selamat datang di Mozilla Developer Network! Jika kamu mempunyai masalah, atau ingin meminta saran, ini tempat yang tepat. Kenyataannya kamu tertarik mengirimkan tanggapan membuat anda semakin menjadi bagian dari komunitas Mozilla, dan kami berterima kasih atas ketertarikan kamu.</p> - -<p>Kamu memiliki beberapa pilihan untuk menawarkan wawasan, artikel ini akan membantumu melakukannya.</p> - -<h2 id="Memperbarui_dokumentasi">Memperbarui dokumentasi</h2> - -<p>Pertama-tama, jika kamu melihat masalah dalam dokumentasi, kamu boleh mengkoreksinya sendiri. Masuk dengan <a href="https://www.persona.org/">Persona</a>, tekan tombol biru Edit sehingga membuka editor dan masukan kata untuk berkontribusi pada dokumentasi MDN. Dokumentasi di sini adalah pengetahuan, dan dikumpulkan oleh team relawan dan staff yang dibayar, jadi jangan malu -- tata bahasa kamu tidak harus sempurna. Kami akan membersihkan jika kamu membuat kesalahan; tak ada salahnya untuk dilakukan!</p> - -<p>Untuk informasi lebih lanjut tentang kontribusi untuk dokumentasi MDN, lihat:</p> - -<ul> - <li><a href="/en-US/docs/Project:Getting_started">Awal mula</a></li> - <li><a href="/en-US/docs/Project:How_to_Help">Cara membantu</a></li> - <li><a href="/en-US/docs/Project:MDN_editing_interface">Merubah tampilan MDN</a></li> -</ul> - -<h2 id="Gabung_dalam_percakapan">Gabung dalam percakapan</h2> - -<p>Bicara pada kami! Ada beberapa cara untuk terhubung dengan orang lain yang bekerja dalam konten MDN.</p> - -<h3 id="Obrolan">Obrolan</h3> - -<p>Kami menggunakan Internet Relay Chat (<a href="https://wiki.mozilla.org/IRC">IRC</a>) untuk mendiskusikan MDN dan kontennya. Kamu dapat bergabung dalam percakapan! Kami mempunyai beberapa saluran, tergantung pada minat kamu:</p> - -<dl> - <dt><a href="irc://irc.mozilla.org/mdn">Situs MDN (#mdn)</a></dt> - <dd>Saluran ini untuk diskusi umum MDN. Bila kamu tidak yakin dimana mendapatkan bantuan, atau masalah yang melibatakan kamu, kamu dapat bertanya di sini!</dd> - <dt><a href="irc://irc.mozilla.org/mdndev">Situs dokumentasi pengembang (#mdndev)</a></dt> - <dd>Di saluran #mdndev ini kita membahas tentang pekerjaan pengembang platform yang berjalan pada situs MDN. Bila kamu memiliki masalah tentang fungsionalitas website, atau ide tentang fitur, kamu dapat bergabung dalam pembahasan ini.</dd> -</dl> - -<h3 id="Asinkron_Diskusi">(Asinkron) Diskusi</h3> - -<p>Diskusi jangka panjang terjadi di <a href="https://discourse.mozilla-community.org/c/mdn">forum diskusi MDN</a> kita. Kamu bisa posting ke forum via email ke <a href="mailto:mdn@mozilla-community.org">mdn@mozilla-community.org</a>. Jika kamu bergabung dengan forum, kamu dapat memilih untuk memiliki pemberitahuan tentang diskusi yang dikirimkan kepada kamu melalui email juga.</p> - -<h2 id="Laporkan_masalah">Laporkan masalah</h2> - -<h3 id="Masalah_dokumentasi">Masalah dokumentasi</h3> - -<p>Bila kamu melihat masalah dalam dokumentasi dan tidak bisa memperbaikinya sendiri karena berbagai alasan, kamu dapat <a href="https://github.com/mdn/sprints/issues/new?template=issue-template.md&projects=mdn/sprints/2&labels=user-report">melaporkan masalah</a>! Kamu dapat menggunakan formulir ini untuk semua masalah dokumentasi, apakah itu koreksi sederhana atau permintaan untuk sepotong konten yang sama sekali baru. Seperti disebutkan sebelumnya, kami mengundang anda untuk berkontribusi dengan melakukan perubahan sendiri, tetapi opsi pelaporan ini tersedia untuk kamu juga.</p> - -<h3 id="Masalah_situs">Masalah situs</h3> - -<p>Bila kamu mengalami masalah dengan situs web MDN, atau memiliki ide untuk fitur baru dalam situs ini, anda dapat <a href="https://bugzilla.mozilla.org/form.mdn">mengajukan permintaan</a> dalam sistem Bugzilla juga.</p> diff --git a/files/id/mdn/contribute/getting_started/index.html b/files/id/mdn/contribute/getting_started/index.html deleted file mode 100644 index 04dd189549..0000000000 --- a/files/id/mdn/contribute/getting_started/index.html +++ /dev/null @@ -1,126 +0,0 @@ ---- -title: Langkah Awal Di MDN -slug: MDN/Contribute/Getting_started -tags: - - Dokumentasi - - Langkah Awal - - MDN - - Panduan - - Proyek MDN -translation_of: MDN/Contribute/Getting_started ---- -<div>{{MDNSidebar}}</div><div>{{IncludeSubnav("/id/docs/MDN")}}</div> - -<p id="What_is_MDN.3F"><span class="seoSummary">Kami adalah komunitas terbuka yang terdiri dari pengembang dan penulis sumber daya untuk Web yang lebih baik, terlepas dari merek, browser, atau perangkat. Siapa saja dapat memberikan kontribusinya dan mereka yang membuat kami semakin kuat. Bersama kita bisa melanjutkan untuk menggerakkan inovasi di Web untuk memberikan pelayanan yang lebih baik. Dimulai disini, dengan Anda. </span></p> - -<p><span>Setiap bagian dari MDN (dokumen, demonstrasi, dan situs itu sendiri) dibuat oleh komunitas terbuka para pengembang sumber daya. Bergabunglah bersama kami!</span></p> - -<h2 id="3_langkah_mudah_untuk_MDN"><span>3 langkah mudah untuk MDN</span></h2> - -<p>MDN adalah sebuah ensiklopedia, dimana <strong>semua orang</strong> bisa menambah dan mengedit konten. Anda tidak perlu menjadi seorang pemrogram atau mengetahui banyak hal mengenai teknologi. Ada beberapa tugas yang harus diselesaikan, mulai dari yang termudah (Mengoreksi bacaan and mengoreksi kesalahan penulisan) <span id="result_box" lang="id"><span class="hps">hingga yang kompleks</span></span> (menulis dokumentasi Program aplikasi antarmuka, <em>API</em>).</p> - -<p>Ikut berkontribusi sangatlah mudah dan aman. Bahkan jika Anda melakukan kesalahan, itu mudah diperbaiki. Bahkan jika Anda tidak mengetahui dengan tepat bagaimana suatu hal yang seharusnya benar, atau tata bahasa Anda tidak sepenuhnya bagus, jangan khawatir akan hal tersebut! Kami memiliki tim yang terdiri dari orang-orang yang bekerja untuk memastikan bahwa konten di MDN bisa lebih baik sebisa mungkin. Seseorang akan ikut serta untuk memastikan bahwa pekerjaan Anda rapih dan ditulis dengan benar.</p> - -<h3 id="Langkah_1_Membuat_akun_di_MDN">Langkah 1: Membuat akun di MDN</h3> - -<p>Untuk memulai kontribusi Anda di MDN, Anda memerlukan sebuah akun di MDN. Untuk keterangan lanjut, silahkan lihat <a href="/en-US/docs/MDN/Contribute/Howto/Create_an_MDN_account">bagaimana membuat sebuah akun</a>.</p> - -<h3 id="Langkah_2_Ambil_sebuah_tugas_untuk_diselesaikan">Langkah 2: Ambil sebuah tugas untuk diselesaikan</h3> - -<p>Setelah Anda selesai login, bacalah deskripsi mengenai perbedaan tipe tugas pada daftar dibawah ini, dan tentukan mana yang menjadi daya tarik bagi Anda. Anda bisa mengambil tugas manapun yang Anda sukai sebagai kontribusi yang Anda berikan.</p> - -<h3 id="Langkah_3_Kerjakan_tugas">Langkah 3: Kerjakan tugas</h3> - -<p>Setelah Anda menentukan tugas seperti apa yang Anda ingin kerjakan, temukan halaman yang spesifik, misalnya kode, atau yang lainnya untuk dikerjakan, dan lakukanlah!</p> - -<p>Jangan khawatir mengenai kesempurnaan dalam mengerjakan; kontributor MDN lainnya ada disini untuk membantu memperbaiki kesalahan yang terjadi. Jika Anda ingin melakukan percobaan sebelum melakukan sesuatu "yang nyata", Anda bisa mengedit halaman <a href="/en-US/docs/Sandbox">Kotakpasir</a>. Jika Anda memiliki pertanyaan selama melakukan pekerjaan, kunjungi halaman <a href="/en-US/docs/MDN/Community">Komunitas</a> untuk informasi di daftar surat menyurat (<em>mailing lists</em>) dan saluran bercakap (<em>Chat Channels</em>) dimana Anda bisa mendapatkan jawaban.</p> - -<p>Ketika Anda selesai, silahkan ambil item lainnya, atau lihat lagi <a href="#Other_things_you_can_do_on_MDN">Hal lain yang Anda bisa lakukan di MDN</a>.</p> - -<h2 id="Jenis-jenis_tugas_yang_memungkinkan">Jenis-jenis tugas yang memungkinkan</h2> - -<p>Ada banyak jalan yang dapat Anda ambil untuk berkontribusi untuk MDN tergantung keahlian yang Anda persiapkan dan sukai. Walaupun beberapa tugas bisa menghilangkan semangat, kami juga memiliki banyak kegiatan mudah yang tersedia. Kegiatan tersebut setidaknya hanya membutuhkan lima menit (atau kurang!) dari waktu Anda. Bersama dengan tugas dan dengan deskripsi yang pendek, Anda akan mengetahui <span id="result_box" lang="id"><span class="hps">berapa waktu</span> <span class="hps">perkiraan</span> <span class="hps">setiap</span> <span class="hps">jenis tugas</span> biasanya akan diselesaikan<span>.</span></span></p> - -<h3 id="Opsi_1_Saya_menyukai_kata-kata">Opsi 1: Saya menyukai kata-kata</h3> - -<p>Anda bisa membantu kami meninjau atau mengedit dokumen yang ada, dan menerapkan label yang benar.</p> - -<ul> - <li><a href="/en-US/docs/MDN/Contribute/Howto/Set_the_summary_for_a_page">Mengatur ringkasan untuk halaman</a> (5-15 menit)</li> - <li><a href="/en-US/docs/Project:MDN/Contributing/How_to/Do_an_editorial_review">Tinjauan tajuk rencana</a> (5–30 menit)</li> - <li><a href="/en-US/docs/MDN/User_guide/Writing#Editing_an_existing_page">Memperbaharui artikel yang ada dengan informasi baru</a> (5 menit-1 jam)</li> - <li><a href="/en-US/docs/MDN/User_guide/Writing#Adding_a_new_page">Tulis sebuah artikel tentang teknologi baru atau <em>API </em></a>(30 menit-2 jam)</li> -</ul> - -<div class="note"><strong>Catatan:</strong> Jika Anda sedang meninjau artikel atau menulis artikel yang baru, kami berharap Anda meninjau <a href="/en-US/docs/Project:MDN/Style_guide">Panduan Gaya</a>. Ini akan membantu untuk meyakinkan bahwa artikel tersebut sesuai.</div> - -<h3 id="Opsi_2_Saya_menyukai_kode">Opsi 2: Saya menyukai kode</h3> - -<p>Kami membutuhkan lebih banyak sampel kode! Anda juga dapat membantu membangun perangkat halaman kami, <a href="https://developer.mozilla.org/en-US/docs/Project:MDN/Kuma">Kuma</a>!</p> - -<ul> - <li><a href="/en-US/docs/Project:MDN/Contributing/How_to/Convert_code_samples_to_be_live_">Konversi sampel kode menjadi "aktif"</a> (30 menit)</li> - <li><a href="https://kuma.readthedocs.org/en/latest/installation-vagrant.html">Menyusun lingkungan membangun Kuma</a> (1 jam)</li> - <li><a href="https://github.com/mozilla/kuma#readme">Kirim kode tambalan Anda ke pusat kode Kuma</a> (1 jam)</li> - <li><a href="https://developer.mozilla.org/en-US/demos/submit">Mengajukan demonstrasi baru </a>(1 jam)</li> -</ul> - -<h3 id="Opsi_3_Saya_menyukai_kata-kata_dan_kode">Opsi 3: Saya menyukai kata-kata dan kode</h3> - -<p>Kami memiliki tugas-tugas yang membutuhkan teknis dan kemampuan bahasa bersama, seperti menulis artikel baru, meninjau keakurasian teknis, atau mengadapsikan dokumen-dokumen.</p> - -<ul> - <li><a href="/en-US/docs/Project:MDN/Contributing/How_to/Tag_JavaScript_pages">Halaman label JavaScript</a> (5 menit)</li> - <li><a href="/en-US/docs/MDN/Promote">Promosikan MDN di situs web Anda</a> (5 menit)</li> - <li><a href="/en-US/docs/Project:MDN/Contributing/How_to/Do_a_technical_review">Tinjauan teknis</a> (30 menit)</li> - <li><a href="/en-US/docs/Project:MDN/Contributing/How_to/Update_API_page_layout">Perbaharui tata ruang halaman API</a> (30 menit)</li> - <li><a href="/en-US/docs/MDN/Contribute/Creating_and_editing_pages#Creating_a_new_page">Tulis sebuah artikel baru yang akrab bagi Anda</a> (1 jam atau lebih)</li> -</ul> - -<h3 id="Opsi_4_Saya_ingin_MDN_ada_di_bahasa_saya">Opsi 4: Saya ingin MDN ada di bahasa saya</h3> - -<p>Semua lokalisasi and terjemahan selesai dikerjakan di MDN oleh komunitas sukarelawan kami yang mengagumkan.</p> - -<ul> - <li><a href="/en-US/docs/MDN/Contribute/Localize/Translating_pages">Menerjemahkan halaman</a> (2 jam)</li> - <li>Menghubungkan dengan lokalisir lainnya yang terdaftar di <a href="/en-US/docs/Project:MDN/Localizing/Localization_projects">Proyek lokalisasi</a> (30 menit)</li> -</ul> - -<h3 id="Opsi_5_Saya_menemukan_beberapa_kesalahan_informasi_tapi_saya_tidak_tahu_bagaimana_memperbaikinya">Opsi 5: Saya menemukan beberapa kesalahan informasi tapi saya tidak tahu bagaimana memperbaikinya</h3> - -<p>Anda dapat melaporkan masalah tersebut dengan <a class="external" href="https://bugzilla.mozilla.org/enter_bug.cgi?product=Mozilla%20Developer%20Network">mengisi dokumentasi kesalahan</a>. (5 menit)</p> - -<p>Gunakan nilai bidang ini:</p> - -<table class="standard-table"> - <tbody> - <tr> - <td><strong>Bidang Bugzilla</strong></td> - <td><strong>Nilai</strong></td> - </tr> - <tr> - <td><code>produk</code></td> - <td><a href="https://bugzilla.mozilla.org/enter_bug.cgi?product=Developer+Documentation">Dokumentasi Pengembang</a></td> - </tr> - <tr> - <td><code>komponen</code></td> - <td>[<span id="result_box" lang="id"><span class="hps">memilih</span> <span class="hps">daerah yang sesuai</span> <span class="hps">dengan topik</span><span>,</span> <span class="hps">atau</span> <span class="atn hps">"</span><span>Umum</span><span>"</span> <span class="hps">jika Anda tidak</span> <span class="hps">yakin</span> <span class="hps">atau</span> <span class="hps">Anda tidak melihat</span> mana <span class="hps">yang benar</span></span>]</td> - </tr> - <tr> - <td><code>URL</code></td> - <td>Halaman dimana Anda menemukan masalah</td> - </tr> - <tr> - <td><code>Deskripsi</code></td> - <td>Sebanyak yang Anda ketahui atau memiliki waktu untuk mengutarakan masalah tersebut dan dimana menemukan informasi yang benar. Ini dapat berisi orang-orang yang ("berbicara jadi-dan-jadi") sebaik mungkin seperti tautan Web.</td> - </tr> - </tbody> -</table> - -<h2 id="Hal-hal_lai_yang_bisa_Anda_lakukan_di_MDN">Hal-hal lai yang bisa Anda lakukan di MDN</h2> - -<ul> - <li><a href="/en-US/docs/Project:Community">Bergabung dengan komunitas MDN</a>.</li> - <li><a href="/en-US/profile">Isi profil Anda</a> jadi yang lain dapat mengetahui lebih tentangmu.</li> - <li>Belajar lebih lanjut tentang <a href="/en-US/docs/MDN/Contribute">berkontribusi untuk MDN</a>.</li> -</ul> diff --git a/files/id/mdn/contribute/howto/index.html b/files/id/mdn/contribute/howto/index.html deleted file mode 100644 index 1ac1697957..0000000000 --- a/files/id/mdn/contribute/howto/index.html +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: How-to guides -slug: MDN/Contribute/Howto -tags: - - Documentation - - Landing - - MDN - - NeedsTranslation - - TopicStub -translation_of: MDN/Contribute/Howto ---- -<div>{{MDNSidebar}}</div><div>{{IncludeSubnav("/id/docs/MDN")}}</div> - -<p>Artikel berikut menyediakan pedoman langkah - langkah untuk mencapai tujuan tertentu ketika berkontribusi di MDN.</p> - -<p>{{LandingPageListSubpages}}</p> diff --git a/files/id/mdn/contribute/howto/tag/index.html b/files/id/mdn/contribute/howto/tag/index.html deleted file mode 100644 index 8b0d868f78..0000000000 --- a/files/id/mdn/contribute/howto/tag/index.html +++ /dev/null @@ -1,373 +0,0 @@ ---- -title: How to properly tag pages -slug: MDN/Contribute/Howto/Tag -translation_of: MDN/Contribute/Howto/Tag ---- -<div>{{MDNSidebar}}</div><p dir="rtl">One important feature of MDN that helps users find content is the <strong>article tag</strong>. Each page can be tagged with zero or more tags <span style="line-height: 1.572;">(preferably at least one)</span><span style="line-height: 1.572;"> to help categorize the content. <span class="seoSummary">There are many ways tags are used to help organize information on MDN; this page will help you learn how to best tag pages to help information be organized, sorted, and located by readers.</span></span></p> - -<p>For a guide to the user interface for editing tags on pages, see the <a href="/en-US/docs/MDN/Contribute/Editor/Basics#The_tags_box">tagging section</a> in our editor guide.</p> - -<p>Note that proper use of tags is important; we are increasingly using automation to generate lists of content, landing pages, and cross-linking of articles. Failure to properly tag articles as indicated below can prevent articles from being listed correctly.</p> - -<h2 id="Ways_tags_are_used_on_MDN">Ways tags are used on MDN</h2> - -<p>There are several ways tags get used on MDN:</p> - -<dl> - <dt>Categorization</dt> - <dd>What type of document is it? Is it a reference? A tutorial? A landing page? These can be used when filtering searches, so they're really important!</dd> - <dt>Topic identification</dt> - <dd>What topic does the article cover? Is it about an API? The DOM? Graphics? These, too, are important, because they can be used as filters on searches.</dd> - <dt>Technology status</dt> - <dd>What's the status of the technology? Is it non-standard? Obsolete or deprecated? Experimental?</dd> - <dt>Skill level</dt> - <dd>For tutorials and guides, how advanced is the material covered by the article?</dd> - <dt>Document metadata</dt> - <dd>The writing community often needs a way to track information about pages in need of specific kinds of work. This is done using tags.</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="Category">Category</h3> - -<p>Tagging an article with one of these categories will help automatically constructed landing pages, table of contents pages, and the like be more accurately built. These terms will also be used by our new search system, eventually, to let the user locate reference or guide information by their choice.</p> - -<p>The following category names are standard tagging terms used on MDN.</p> - -<dl> - <dt><code>{{Tag("Intro")}}</code></dt> - <dd>The article provides introductory material about a topic. In theory there should be only one of these per technology area.</dd> - <dt><code>{{Tag("Featured")}}</code></dt> - <dd>The article is a high-importance article that should be featured in a special way on landing pages; this must be used sparingly. Only three or fewer of these should exist in any documentation area.</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. This shouldn't be used for very one-liner "syntax examples" but actual snippets of useful code, or for full usable samples.</dd> -</dl> - -<h3 id="Topic">Topic</h3> - -<p>By identifying the article's topic area, you can also help to generate better search results as well as landing pages and other navigational aids.</p> - -<p>While there's some room for flexibility here as new topic areas are identified, we try to keep these 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 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("Firefox OS")}}</code></li> - <li><code>{{Tag("Gecko")}}</code></li> - <li><code>{{Tag("XUL")}}</code></li> - <li><code>{{Tag("XPCOM")}}</code></li> - <li><code>{{Tag("SVG")}}</code></li> - <li><code>{{Tag("WebGL")}}</code></li> - <li><code>{{Tag("Element")}}</code></li> - <li><code>{{Tag("Node")}}</code></li> - <li><code>{{Tag("Tools")}}</code></li> - <li><code>{{Tag("Web")}}</code></li> -</ul> - -<p>In general, the name of an interface that has a number of related pages, such as <a href="/en-US/docs/Web/API/Node" title="/en-US/docs/Web/API/Node">Node</a> (which has many pages for its various properties and methods) makes a good topic identification tag, as does the name of an overall technology or technology type. A page about WebGL might be tagged with <code>Graphics</code> and <code>WebGL</code>, for example, while a page about the {{HTMLElement("canvas")}} element might be tagged <code>HTML</code>, <code>Element</code>, <code>Canvas</code>, and <code>Graphics</code>.</p> - -<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 what the status of the technology's specification is. This isn't as detailed as actually explaining what the spec is and where in the specification process the technology is (that's what the Specifications table is for), but it will help the reader judge, at a glance, whether using the technology described in the article is a good idea or not.</p> - -<p>Here are possible values for these tags:</p> - -<dl> - <dt><code>{{Tag("Non-standard")}}</code></dt> - <dd>Indicates that the technology or API described on the page is not part of a standard, but is considered stable in the browser or browsers that do implement it. If you don't use this tag, the assumption is made that the article covers something that's 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 has been marked as deprecated in the specification, and is expected 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 in the process of 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.</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>Regardless of the use of these tags, you should be sure to include a <a href="/en-US/docs/Project:Compatibility_tables" title="/en-US/docs/Project:Compatibility_tables">compatibility table</a> in your article!</p> - -<h3 id="Skill_level">Skill level</h3> - -<p>The skill level tag type is only used for guides and tutorials (that is, pages tagged <code>Guide</code>). It's used to help users whittle down tutorials based on their familiarity level with a technology, for example. 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 that 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("junk")}}</code></dt> - <dd>The article needs to be deleted.</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" title="/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" title="/en-US/docs/Project:MDN/Contributing/How_to_help/Code_samples">live sample system</a>.</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> - -<h3 id="Web_Literacy_Map">Web Literacy Map</h3> - -<p>The <a href="https://webmaker.org" rel="external">WebMaker</a> project, through the <a href="https://webmaker.org/literacy" rel="external">Web Literacy Map</a>, has defined a set of tags to qualify the various competencies and skills recommended to get better at reading, writing and participating on the Web. We use them on MDN to help our users to find the best resources to suit their needs:</p> - -<dl> - <dt>{{Tag("Navigation")}}</dt> - <dd>The articles provides information on how to browse the web.</dd> - <dt>{{Tag("WebMechanics")}}</dt> - <dd>The article provides information on how the web is organized and how it's working.</dd> - <dt>{{Tag("Search")}}</dt> - <dd>The article provides information on how to locate information, people and resources via the web.</dd> - <dt>{{Tag("Credibility")}}</dt> - <dd>The article provides information on how to critically evaluate information found on the web.</dd> - <dt>{{Tag("Security")}}</dt> - <dd>The article provides information on how to keep systems, identities, and content safe.</dd> - <dt>{{Tag("Composing")}}</dt> - <dd>The article provides information on how to create and curate content for the web.</dd> - <dt>{{Tag("Remixing")}}</dt> - <dd>The article provides information on how to modify existing web resources to create something new.</dd> - <dt>{{Tag("DesignAccessibility")}}</dt> - <dd>The article provides information on how to create universally effective communications through web resources.</dd> - <dt>{{Tag("CodingScripting")}}</dt> - <dd>The article provides information on how to code and/or create interactive experiences on the web.</dd> - <dt>{{Tag("infrastructure")}}</dt> - <dd>The article provides information which help understanding the Internet technical stack.</dd> - <dt>{{Tag("Sharing")}}</dt> - <dd>The article provides information on how to create resources with others.</dd> - <dt>{{Tag("Collaborating")}}</dt> - <dd>The article provides information on how to work with each other.</dd> - <dt>{{Tag("Community")}}</dt> - <dd>The article provides information on how to get involved in web communities and understanding their practices.</dd> - <dt>{{Tag("Privacy")}}</dt> - <dd>The article provides information on how to examine the consequences of sharing data online.</dd> - <dt>{{Tag("OpenPractices")}}</dt> - <dd>The article provides information on how to help keep the web universally accessible.</dd> -</dl> - -<h2 id="Putting_it_all_together">Putting it all together</h2> - -<p>So, with these different types of tags, you assemble them together to get the full set of tags for a page. A few examples:</p> - -<dl> - <dt>A tutorial about WebGL for beginners</dt> - <dd>Appropriate tags would be: <code>WebGL</code>, <code>Graphics</code>, <code>Guide</code>, <code>Beginner</code></dd> - <dt>Reference page for the {{HTMLElement("canvas")}} element</dt> - <dd>This should be tagged with <code>Canvas</code>, <code>HTML</code>, <code>Element</code>, <code>Graphics</code> <code>Reference</code></dd> - <dt>A landing page for Firefox OS developer tools</dt> - <dd>This should be tagged with <code>Tools</code>, <code>Firefox OS</code>, <code>Landing</code></dd> -</dl> - -<h2 id="Tagging_and_search_filters">Tagging and search filters</h2> - -<p>The upcoming search filter implementation, which will let users restrict the results of their searches based on criteria they specify, will rely on proper tagging of pages on MDN. Here's a table of the various search filters and which tags they look for.</p> - -<div class="note"> -<p><strong>Note:</strong> If multiple tags are listed under "Tag name," that means any one or more of those tags need to be present for the article to match.</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>Topic</th> - <td>Open Web Apps</td> - <td>{{Tag("Apps")}}</td> - </tr> - <tr> - <th> </th> - <td>HTML</td> - <td>{{Tag("HTML")}}</td> - </tr> - <tr> - <th> </th> - <td>CSS</td> - <td>{{Tag("CSS")}}</td> - </tr> - <tr> - <th> </th> - <td>JavaScript</td> - <td>{{Tag("JavaScript")}}</td> - </tr> - <tr> - <th> </th> - <td>APIs and DOM</td> - <td>{{Tag("API")}}</td> - </tr> - <tr> - <th> </th> - <td>Canvas</td> - <td>{{Tag("Canvas")}}</td> - </tr> - <tr> - <th> </th> - <td>SVG</td> - <td>{{Tag("SVG")}}</td> - </tr> - <tr> - <th> </th> - <td>MathML</td> - <td>{{Tag("MathML")}}</td> - </tr> - <tr> - <th> </th> - <td>WebGL</td> - <td>{{Tag("WebGL")}}</td> - </tr> - <tr> - <th> </th> - <td>XUL</td> - <td>{{Tag("XUL")}}</td> - </tr> - <tr> - <th> </th> - <td>Marketplace</td> - <td>{{Tag("Marketplace")}}</td> - </tr> - <tr> - <th> </th> - <td>Firefox</td> - <td>{{Tag("Firefox")}}</td> - </tr> - <tr> - <th> </th> - <td>Firefox for Android</td> - <td>{{Tag("Firefox Mobile")}}</td> - </tr> - <tr> - <th> </th> - <td>Firefox for Desktop</td> - <td>{{Tag("Firefox Desktop")}}</td> - </tr> - <tr> - <th> </th> - <td>Firefox OS</td> - <td>{{Tag("Firefox OS")}}</td> - </tr> - <tr> - <th> </th> - <td>Mobile</td> - <td>{{Tag("Mobile")}}</td> - </tr> - <tr> - <th> </th> - <td>Web Development</td> - <td>{{Tag("Web Development")}}</td> - </tr> - <tr> - <th> </th> - <td>Add-ons & Extensions</td> - <td>{{Tag("Add-ons ")}}|| {{Tag("Extensions")}} || {{Tag("Plugins")}} || {{Tag("Themes")}}</td> - </tr> - <tr> - <th> </th> - <td>Games</td> - <td>{{Tag("Games")}}</td> - </tr> - <tr> - <th>Skill level</th> - <td>I'm an Expert</td> - <td>{{Tag("Advanced")}}</td> - </tr> - <tr> - <th> </th> - <td>Intermediate</td> - <td>{{Tag("Intermediate")}}</td> - </tr> - <tr> - <th> </th> - <td>I'm Learning</td> - <td>{{Tag("Beginner")}}</td> - </tr> - <tr> - <th>Document type</th> - <td>Docs</td> - <td><em>This will restrict the search to docs content, leaving out Hacks and other MDN content.</em></td> - </tr> - <tr> - <th> </th> - <td>Demos</td> - <td><em>This will include Demo Studio content in the search results.</em></td> - </tr> - <tr> - <th> </th> - <td>Tools</td> - <td>{{Tag("Tools")}}</td> - </tr> - <tr> - <th> </th> - <td>Code Samples</td> - <td>{{Tag("Example")}}</td> - </tr> - <tr> - <th> </th> - <td>How-To & Tutorial</td> - <td>{{Tag("Guide")}}</td> - </tr> - <tr> - <th> </th> - <td>Developer Profiles</td> - <td><em>This will include developer profiles from the MDN site in the search results.</em></td> - </tr> - <tr> - <th> </th> - <td>External Resources</td> - <td><em>This is something the dev team will need to figure out.</em></td> - </tr> - </tbody> -</table> - -<h2 id="Tagging_problems_you_can_fix">Tagging problems you can fix</h2> - -<p>There are several types of problems with tags you can help fix:</p> - -<dl> - <dt>No tags</dt> - <dd>All articles should have at least one tag, and usually more than one. Generally, at a minimum, articles should have at least a "<a href="/en-US/docs/Project:MDN/Contributing/Tagging_standards#Category" title="/en-US/docs/Project:MDN/Contributing/Tagging_standards#Categories">category</a>" tag and a "<a href="/en-US/docs/Project:MDN/Contributing/Tagging_standards#Topic" title="/en-US/docs/Project:MDN/Contributing/Tagging_standards#Topic">topic</a>" tag. Often other tags are appropriate as well, but if you can help us ensure that at least these are present, you'll be a documentation hero!</dd> - <dt>Tags that don't follow our tagging standards</dt> - <dd>We have a <a href="/en-US/docs/Project:MDN/Contributing/Tagging_standards" title="/en-US/docs/Project:MDN/Contributing/Tagging_standards">Tagging standards</a> guide that explains how we use tags, including lists of appropriate tags to use on various types of documentation. Ideally, all articles should follow these standards, so if you see a page whose tags don't do so, please fix it!</dd> - <dt>Incorrect tags</dt> - <dd>If you're looking at an article about HTML and it's got the "JavaScript" tag on it, that's probably wrong! Similarly, if an article is about Mozilla internals but has the "Web" tag on it, that's probably wrong too. Remove these tags (and, if missing, add the right ones). This type of problem includes misspelled tags. "JavaScript" or "Javascript" for example (the latter actually will match, since tags are case-insensitive, but it's just not right!).</dd> - <dt>Missing tags</dt> - <dd>If an article has some tags, but not all of the appropriate ones, feel free to add more. Maybe you're looking at a page in the JavaScript reference, which is correctly tagged with "JavaScript" but has no other tags. Since it's a reference page, this should also have the "Reference" tag. You're invited to add it!</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 tags for a page, leaving a page with 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". These need to be deleted posthaste!</dd> -</dl> - -<p>If you see one (or more) of these problems, you can help by <a href="/en-US/docs/Project:MDN/Contributing/Getting_started#Logging_into_MDN">logging into MDN</a>, then clicking the Edit button 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" title="/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" title="/en-US/docs/Project:MDN/Contributing/Editor_guide">MDN editor guide</a>.</p> diff --git a/files/id/mdn/contribute/index.html b/files/id/mdn/contribute/index.html deleted file mode 100644 index 4d76fd020d..0000000000 --- a/files/id/mdn/contribute/index.html +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Contributing to MDN -slug: MDN/Contribute -tags: - - Documentation - - Guide - - Landing - - MDN - - NeedsTranslation - - TopicStub -translation_of: MDN/Contribute ---- -<div>{{MDNSidebar}}</div><div>{{IncludeSubnav("/en-US/docs/MDN")}}</div> - -<p>Selamat Datang! Dengan mengunjungi halaman ini, anda telah mengambil satu langkah menjadi kontributor di MDN!</p> - -<p><span class="seoSummary">Daftar paduan disini memuat semua aspek kontribusi ke MDN, diantaranya paduan style, paduan menggunakan alat dan editor kami, dan banyak lagi. Pastikan anda membaca (dan aduan tentang) <a href="https://www.mozilla.org/en-US/about/legal/terms/mozilla/">Mozilla Terms</a> sebelum mengedit atau membuat halaman. </span></p> - -<p>Jika anda belum pernah berkontribusi di MDN, Paduan <a href="/en-US/docs/MDN/Getting_started">Memulai</a> bisa membantu anda memulai.</p> - -<div class="row topicpage-table"> </div> - -<p>{{LandingPageListSubPages()}}</p> diff --git a/files/id/mdn/contribute/processes/index.html b/files/id/mdn/contribute/processes/index.html deleted file mode 100644 index d01213c69f..0000000000 --- a/files/id/mdn/contribute/processes/index.html +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Proses dokumentasi -slug: MDN/Contribute/Processes -tags: - - ButuhPenerjemahan - - Landing - - MDN Meta - - Meta MDN - - NeedsTranslation - - Pendaratan - - Processes - - Proses - - RintisanTopik - - TopicStub -translation_of: MDN/Contribute/Processes ---- -<div>{{MDNSidebar}}</div> - -<div>{{IncludeSubnav("/en-US/docs/MDN")}}</div> - -<p>The MDN documentation project is enormous; there are a huge number of technologies to cover, and we have hundreds of contributors all over the world. To help bring order to chaos, we've got standard processes to follow when working on specific documentation-related tasks. Here you'll find guides to those processes.</p> - -<p>{{LandingPageListSubPages()}}</p> diff --git a/files/id/mdn/guidelines/index.html b/files/id/mdn/guidelines/index.html deleted file mode 100644 index fdedce143e..0000000000 --- a/files/id/mdn/guidelines/index.html +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: MDN content and style guides -slug: MDN/Guidelines -tags: - - Documentation - - Landing - - MDN - - NeedsTranslation - - TopicStub -translation_of: MDN/Guidelines ---- -<div>{{MDNSidebar}}</div><div>{{IncludeSubnav("/en-US/docs/MDN")}}</div> - -<p><span class="seoSummary">Paduan berikut memberikan detail bagaimana dokumentasi MDN harus ditulis dan format tulisannya, juga cara bagaimana contoh kode dan konten lainnya di sampaikan.</span> Dengan mengikuti paduan berikut, anda dapat memastikan bahwa semua material yang anda buat asli dan mudah digunakan.</p> - -<p>{{LandingPageListSubpages}}</p> diff --git a/files/id/mdn/guidelines/writing_style_guide/index.html b/files/id/mdn/guidelines/writing_style_guide/index.html deleted file mode 100644 index b3ad6bb25f..0000000000 --- a/files/id/mdn/guidelines/writing_style_guide/index.html +++ /dev/null @@ -1,802 +0,0 @@ ---- -title: Writing style guide -slug: MDN/Guidelines/Writing_style_guide -tags: - - tags bahasa Indonesia -translation_of: MDN/Guidelines/Writing_style_guide ---- -<div>{{MDNSidebar}}</div> - -<div>{{IncludeSubnav("/en-US/docs/MDN")}}</div> - -<p><span class="seoSummary">To present documentation in an organized, standardized, and easy-to-read manner, the MDN Web Docs style guide describes how text should be organized, spelled, formatted, and so on. These are guidelines rather than strict rules.</span> We are more interested in content than formatting, so don't feel obligated to learn the style guide before contributing. Do not be upset or surprised, however, if an industrious volunteer later edits your work to conform to this guide.</p> - -<p>The language aspects of this guide apply primarily to English-language documentation. Other languages may have (and are welcome to create) style guides. These should be published as subpages of the localization team's page.</p> - -<p>For style standards that apply to content written for sites other than MDN, refer to the <a href="https://www.mozilla.org/en-US/styleguide/" title="https://www.mozilla.org/en-US/styleguide/">One Mozilla style guide</a>.</p> - -<h2 id="Basics">Basics</h2> - -<p>The best place to start in any extensive publishing style guide is with some very basic text standards to help keep documentation consistent. The following sections outline some of these basics to help you.</p> - -<h3 id="Page_titles">Page titles</h3> - -<p>Page titles are used in search results and also used to structure the page hierarchy in the breadcrumb list at the top of the page. The page title (which is displayed at the top of the page and in the search results) can be different from the page "slug", which is the portion of the page's URL following "<em><locale>/docs/</em>".</p> - -<h4 id="Title_and_heading_capitalization">Title and heading capitalization</h4> - -<p>Page titles and section headings should use sentence-style capitalization (only capitalize the first word and proper nouns) rather than headline-style capitalization:</p> - -<ul> - <li><span class="correct"><strong>Correct</strong></span>: "A new method for creating JavaScript rollovers"</li> - <li><span class="incorrect"><strong>Incorrect</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> - -<div class="blockIndicator note"> -<p>Note: Adding articles requires <a href="https://wiki.developer.mozilla.org/en-US/docs/MDN/Contribute/Howto/Create_and_edit_pages#Getting_page-creation_permissions">page creation privileges</a>.</p> -</div> - -<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, or provide excessive detail, 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.</p> - -<p>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="/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.</p> - -<p>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.</p> - -<p>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 not. The majority of pages probably deserve multiple examples, in fact.</p> - -<p>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> - -<h5 id="Code_Examples">Code Examples</h5> - -<p>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.</p> - -<p>The text following each piece of code should explain anything relevant, using an appropriate level of detail.</p> - -<ul> - <li>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.</li> - <li>If the code is intricate, uses the API being documented, or is technically creative, you should provide a more detailed explanation.</li> -</ul> - -<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, 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.</p> - -<p>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, consider breaking up the article into several smaller articles with a landing page, and linking them together using the following macros: {{TemplateLink("Next")}}, {{TemplateLink("Previous")}}, and {{TemplateLink("PreviousNext")}}.</p> - -<h4 id="Heading_dos_and_donts">Heading dos and donts</h4> - -<ul> - <li>Don't create single subsections. Don't subdivide a topic into a single subtopic. It's either two subheadings or more, or none at all.</li> - <li>Don't use styles and classes within headings. This includes the {{HTMLElement("code")}} element for code terms. So don't make a heading "Using the <code>SuperAmazingThing</code> interface". It should instead just be "Using the SuperAmazingThing interface".</li> - <li>Avoid using macros within headings (except for certain macros that are specifically designed to be used in headings).</li> - <li>Don't create "bumping heads." These are headings followed immediately by a subheading, with no content text in between. This doesn't look good, and leaves readers without any explanatory text at the beginning of the outer section.</li> -</ul> - -<p>The <kbd>Enter</kbd> (or <kbd>Return</kbd>) key on your keyboard starts a new paragraph. To insert a newline, rather than a new paragraph (that is, to create a {{HTMLElement("br")}} instead of a {{HTMLElement("p")}}), hold down the <kbd>Shift</kbd> key while pressing <kbd>Enter</kbd>.</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 <strong>"Formatting Styles"</strong> drop-down list to apply predefined styles to selected content.</p> - -<div class="note">The <strong>"Note Box"</strong> style is used to call out important notes, like this one.</div> - -<div class="warning">Similarly, the <strong>"Warning Box"</strong> style creates warning boxes like this.</div> - -<p>Unless specifically instructed to do so, <em>do not</em> use the HTML <code>style</code> attribute to manually style content. If you can't do it using a predefined class, ask for help in the <a href="https://discourse.mozilla.org/c/mdn">MDN discussion forum</a>.</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 ("<code>{</code>") 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> - -<div class="note"> -<p><strong>Note:</strong> <em>Do not</em> use the {{HTMLElement("code")}} element inside the {{HTMLElement("pre")}} block!</p> - -<p>While this structure is used on some sites, we do not do so on MDN; nesting these elements will break certain aspects of our styling.</p> -</div> - -<p>The following example shows text with JavaScript formatting:</p> - -<div class="line number2 index1 alt1"> -<pre class="brush: js notranslate">for (let 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>When writing the syntax description section of a reference page, use the <em>"Syntax Box"</em> option in the <strong>"Styles"</strong> drop-down menu in the editor toolbar. This creates a specially-formatted box used specifically for syntax definitions, distinguishing them from other code blocks.</p> - -<h4 id="Blocks_not_referring_to_code">Blocks not referring to code</h4> - -<p>There are a few use cases where a <code><pre></code> block does not refer to code and doesn't have syntax highlighting nor line numbers. In such cases you should add a <code><pre></code> without a <code>class</code> attribute. 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_mentions_of_HTML_elements">Styling mentions of HTML elements</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 the "Inline Code" style (e.g., <code><title></code>).</dd> - <dt>Attribute names</dt> - <dd>Use "Inline Code" style to put attribute names in <code>code font</code>. Additionally, put them in <strong><code>bold face</code></strong> when the attribute is mentioned in association with an explanation of what it does, or the first time it's used in the article.</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 easily by simply using the {{TemplateLink("htmlattrxref")}} macro (e.g., <span class="nowiki">\{{htmlattrxref("attr","element")}}</span>) to reference attribute definitions.</dd> - <dt>Attribute values</dt> - <dd>Use the "Inline Code" style to apply <code><code></code> to attribute values, and don't use quotation marks around string values, unless needed by the syntax of a code sample.</dd> - <dd>For example: "When the <code>type</code> 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"> - <thead> - <tr> - <th scope="col">Abbrev</th> - <th scope="col">Latin</th> - <th scope="col">English</th> - </tr> - </thead> - <tbody> - <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.</p> - -<p>Also, be sure that <em>you</em> 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." The only exception is that if you wish to abbreviate the name of the "Escape" key, you may use "ESC".</p> - -<p>Certain words should always be capitalized (such as trademarks which include capital letters), or words derived from the name of a person (unless it's being used within code, and the rules of the language in which the code is written mandate lower-casing). Some examples:</p> - -<ul> - <li>Boolean (named for English mathematician and logician {{interwiki("wikipedia", "George Boole")}})</li> - <li>JavaScript (a trademark of Oracle Corporation, it should always be written as trademarked)</li> - <li>Python, TypeScript, Django, and other programming languages and framework names</li> -</ul> - -<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" is 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.</p> - -<p>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. 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 different 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.</p> - -<p>There are a couple of reasons for this.</p> - -<ol> - <li>We need to choose one or the other for consistency.</li> - <li>If curly quotes or apostrophes make their way into code snippets—even inline ones—readers may copy and paste them, expecting them to function (which they will not).</li> -</ol> - -<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.</p> - -<p>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> - -<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.</p> - -<p>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 whenever 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, avoid 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.</p> - -<p>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> - -<dl> - <dt>Junk</dt> - <dd>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.</dd> - <dt>Obsolete</dt> - <dd>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.</dd> - <dt>Archive</dt> - <dd>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.</dd> -</dl> - -<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. (In other words, it's not just for SEO.)</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 rooms and 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>{{TODO("Finish this once we finalize the landing page standards")}}</strong></p> - -<h2 id="Using_and_inserting_images">Using and 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>Before uploading your image, please ensure that it's as small as possible by using an image optiization tool. - <ol> - <li>For bitmap images (JPG or PNG), consider a tool such as <a href="https://imageoptim.com/mac">ImageOptim</a> (macOS), <a href="https://tinypng.com/">TinyPNG</a> (web service), or <a href="https://trimage.org/">Trimage</a> (Linux).</li> - <li>For SVG images, use the <code><a href="https://github.com/svg/svgo">svgo</a></code> tool to optimize the SVG file before sending it. The default configuration is fine.</li> - </ol> - </li> - <li>Attach the desired image file to the article (at the bottom of every article in edit mode). If your artwork is a diagram in SVG format (which is ideal if there is text that may need to be localized), you can't upload it directly, but you can ask an MDN admin to do it for you.</li> - <li>Click the "insert image" button in the MDN documentation 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> - -<div class="warning"> -<p><strong>Important:</strong> Remember to save any changes you've made before uploading an attachment to your article! The editor is closed during the upload process, and currently <em>does not verify</em> whether or not you wish to save your work when it does so.</p> -</div> - -<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="https://docs.microsoft.com/en-us/style-guide/welcome/">Microsoft Writing Style Guide</a> or, failing that, the <a href="https://www.amazon.com/Chicago-Manual-Style-16th/dp/0226104206">Chicago Manual of Style</a>. An <a href="https://faculty.cascadia.edu/cma/HIST148/cmscrib.pdf">unofficial crib sheet for the Chicago Manual of Style</a> is available online.</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/id/mdn/tools/index.html b/files/id/mdn/tools/index.html deleted file mode 100644 index 56d1e866ff..0000000000 --- a/files/id/mdn/tools/index.html +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: MDN user guide -slug: MDN/Tools -tags: - - Documentation - - Landing - - MDN - - NeedsTranslation - - TopicStub -translation_of: MDN/Tools -translation_of_original: MDN/User_guide -original_slug: MDN/User_guide ---- -<div>{{MDNSidebar}}</div><p>The Mozilla Developer Network site is an advanced system for finding, reading, and contributing to documentation and sample code for Web developers (as well as for Firefox and Firefox OS developers). The MDN user guide provides articles detailing how to use MDN to find the documentation you need, and, if you wish, how to help make the material better, more expansive, and more complete.</p> -<p>{{SubpagesWithSummaries}}</p> |