โครงการ:ตัวช่วยของพีดี (PD help)

From mediawiki.org
This page is a translated version of the page Project:PD help and the translation is 100% complete.
Help pages are released without copyrights (as public domain)
Help pages are released without copyrights (as public domain)

Project:PD help is a project to create a set of concise user help pages for MediaWiki users, i.e. for visitors to a website which is powered by MediaWiki. The project covers all content in the Help namespace. The main entry point for this is ช่วยเหลือ:เนื้อหา .

This help documentation is separate from the Manual (the GFDL or CC BY-SA-licensed MediaWiki administrator's manual). Contributors, please be clear about the differences! The PD help pages do not contain information for server administrators, about how to install, configure, or maintain MediaWiki software. See the 'Goal' section below, for a detailed statement of what we are trying to achieve.

ความปลอดภัย Please do not copy and paste content from Meta-Wiki's Help pages in here. They were written under the GFDL or CC BY-SA license and are not in the public domain.

เป้าหมาย

เป้าหมายคือการจัดเตรียมชุดของเพจ ซึ่งสามารถคัดลอกไปยังการติดตั้ง Wiki ใหม่หรือรวมอยู่ในการแจกจ่ายมีเดียวิกิ (MediaWiki) ซึ่งจะรวมถึงข้อมูลผู้ใช้พื้นฐาน พร้อมด้วยข้อมูลเมทา (Meta) อื่น ๆ ในรูปแบบที่กระชับพอสมควร แนวคิดพื้นฐาน คือ การสร้าง "คู่มือผู้ใช้" แบบ ย่อ ไม่ใช่งานอ้างอิง ควรเน้นที่สิ่งที่ผู้ใช้ต้องการและไม่อธิบายฟังก์ชันอื่น ๆ

สัญญาอนุญาต

ผลงานสร้างสรรค์ ตัวช่วยของพีดี (PD Help) ได้รับการเผยแพร่เป็น สาธารณสมบัติ ผ่านทาง CC0 waiver นี่เป็นสิ่งจำเป็นเพื่อให้ผู้ใช้สามารถคัดลอกข้อความลงในการติดตั้งวิกิของตนเองได้อย่างง่ายดาย โปรดตรวจสอบให้แน่ใจว่าคุณเข้าใจสิ่งต่อไปนี้ก่อนที่จะมีส่วนร่วม:

  • ทุกหน้าในตัวช่วยของพีดี (PD Help) ต้องมีบรรทัด {{PD Help Page}} เพื่อระบุตัวสัญญาอนุญาต
  • ไม่สามารถคัดลอกเนื้อหาจากที่อื่นไปยังหน้าเหล่านี้ได้ ข้อยกเว้นเพียงอย่างเดียวคือ:
  1. เนื้อหาที่คัดลอกเป็นเนื้อหาส่วนบุคคลของคุณ (เช่น ผู้แต่ง) หรือคุณได้รับอนุญาตเป็นลายลักษณ์อักษรจากผู้แต่งต้นฉบับ
  2. เนื้อหาที่มีอยู่แล้วใน "สาธารณสมบัติ" สามารถคัดลอกได้ที่นี่ อย่างไรก็ตาม ไม่ รวมหน้าเว็บที่เผยแพร่ส่วนใหญ่!
  • คุณกำลังสละสิทธิ์ทั้งหมดในข้อมูลที่คุณให้ไว้ที่นี่ แม้ว่าคุณจะยังคงมีผลงานสร้างสรรค์ของคุณอยู่ในรายการและระบุแหล่งที่มาในไซต์นี้ ผู้อื่นสามารถคัดลอกข้อความโดยไม่ต้องให้เครดิต และสามารถปรับเปลี่ยนได้ตามที่เห็นสมควร

ผู้อ่านเป้าหมาย: ผู้ใช้ทั่วไป

หน้าช่วยเหลือมีเป้าหมายเป็นอย่างมากที่ผู้เยี่ยมชมเว็บไซต์วิกิปกติ

ไม่ใช่ ผู้ดูแลระบบเซิร์ฟเวอร์

เราไม่ได้มุ่งหมายที่จะทำซ้ำเอกสารมีเดียวิกิฉบับเต็ม ข้อมูลที่กำหนดเป้าหมายไปที่ผู้ดูแลระบบเซิร์ฟเวอร์ รายละเอียดการติดตั้ง การกำหนดค่า หรือการบำรุงรักษามีเดียวิกิอยู่ใน คู่มือ

ข้อยกเว้นเล็กน้อย "เท่านั้น" สำหรับเรื่องนี้ คือช่อง "คำแนะนำสำหรับผู้ดูแลระบบ" (อธิบายไว้ด้านล่าง)

ข้อมูลที่โดดเด่นน้อยกว่าสำหรับผู้ใช้สิทธิ ผู้ดูแลระบบ (sysop) / ผู้แลระบบสิทธิ์แต่งตั้ง (bureaucrat)

หน้าช่วยเหลือ จะไม่สมบูรณ์หากไม่ได้อธิบายว่าผู้ใช้สิทธิ 'ผู้ดูแลระบบ (sysop)' ทำอะไรได้บ้าง อย่างไรก็ตาม คุณลักษณะขั้นสูงเหล่านี้ไม่พร้อมใช้งานสำหรับผู้ชมเป้าหมายส่วนใหญ่ (ผู้ใช้วิกิส่วนใหญ่) ดังนั้น ข้อมูลนี้จะต้องถูกแยกจากเนื้อหาส่วนใหญ่เล็กน้อย เพื่อไม่ให้ผู้ใช้ทั่วไปต้องเผชิญกับข้อมูลที่ไม่เกี่ยวข้องกับพวกเขา

ภายใน "หน้าช่วยเหลือ" ส่วนใหญ่ การกล่าวถึงการกระทำสั้นๆ ที่ต้องใช้สิทธิ์ของผู้แลระบบ (sysop) อาจถือว่าจำเป็น แต่คำอธิบายโดยละเอียดของขั้นตอนของผู้แลระบบ (sysop) ควรซ่อนอยู่ในหน้าที่เชื่อมโยงที่ไม่เด่นชัด หรือควรละเว้นจาก หน้าช่วยเหลือ ทั้งหมด

ส่วนนี้ยังคง อยู่ระหว่างการอภิปราย

หลักเกณฑ์ด้านบรรณาธิการ

  • สร้างลิงก์ระหว่างหน้าต่างๆ แต่หลีกเลี่ยงการลิงก์ไปยังเนมสเปซอื่นๆ บน MediaWiki.org เก็บลิงก์ไว้ภายในไปยังหน้าช่วยเหลือที่เป็นสาธารณสมบัติ หรือสร้างลิงก์ภายนอก (URL แบบเต็ม) ไปยังแหล่งข้อมูลที่เกี่ยวข้อง เช่น ใน meta.wikimedia.org เพื่อให้ง่ายต่อการคัดลอกข้อความลงในการติดตั้งวิกิใหม่ อย่าใช้ลิงก์ระหว่างวิกิ เนื่องจากลิงก์เหล่านี้อาจไม่มีอยู่ในวิกิเป้าหมาย
  • เราอาจไม่ต้องการสลับใน {{SITENAME}} ไวยากรณ์ที่ใดก็ได้ มีเดียวิกิคือชื่อของซอฟต์แวร์ที่เรากำลังอธิบาย นี่คือ ซอฟต์แวร์การจัดการเนื้อหา (CMS) ที่ช่วยให้วิกิปลายทางทำงาน ดังนั้นทุกที่ที่ข้อความของเราอ้างถึงซอฟต์แวร์ (ทุกที่ตลอดความช่วยเหลือ) ก็ควรปล่อยให้เป็นสตริงตามตัวอักษร 'มีเดียวิกิ' หากข้อความช่วยเหลือกล่าวถึงชื่อเว็บไซต์ด้วยเหตุผลบางประการ อาจเป็นข้อยกเว้นที่เหมาะสม (ใช้ {{SITENAME}}) อย่างไรก็ตาม เราจะ ไม่ แลกเปลี่ยนสิ่งนี้ในทุกที่ที่เราพูดถึงคำว่ามีเดียวิกิ
  • การแปลควรทำ หลัง หน้าเวอร์ชันภาษาอังกฤษมีสถานะเสถียรแล้ว หลักการตั้งชื่อคือ Pagetitle/language-code (เช่น Help:Editing/pt)
  • เว้นแต่ว่าคุณมีโซลูชันที่สมบูรณ์แบบสำหรับการนำทางในคู่มือนี้ โปรดอย่าสร้างเทมเพลตการนำทาง และเน้นการสร้าง เนื้อหา ก่อน
  • ห้ามใช้ส่วนขยายเช่น Cite เนื่องจากไม่ได้ติดตั้งส่วนขยาย MediaWiki ทั้งหมด

การจัดรูปแบบ

  • การจัดรูปแบบควรสอดคล้องกัน ใช้ class="wikitable" สำหรับตารางใด ๆ ที่คุณสร้าง ไฮไลต์เซลล์หรือแถวด้วย {{Hl1}} เป็นต้น
  • มาร์กอัปและโค้ดวิกิทั้งหมดควรใส่ในแท็ก ‎<code> หรือ ‎<pre> ความช่วยเหลือสำหรับการแทรก: {{subst:nw|text}}
  • การอ้างอิงถึงข้อความเมนูและคำอธิบายทั้งหมดควรปรากฏใน ตัวเอียง

ภาพหน้าจอ

ภาพหน้าจอ มีประโยชน์ หน้าช่วยเหลือสาธารณสมบัติ ควรมีเฉพาะภาพหน้าจอที่เป็นสาธารณสมบัติ หลีกเลี่ยงการรวมโลโก้ใด ๆ ไว้ในภาพหน้าจอ และอัปโหลดไปยัง Commons ด้วยเทมเพลตลิขสิทธิ์ {{MediaWiki screenshot}} (สำหรับ GPL) และ {{CC-zero}} (สำหรับงานของผู้ใช้)

รูปภาพจะจัดส่งพร้อมกับเอกสารประกอบหรือเข้าถึงได้จากคอมมอนส์ ด้วย InstantCommons

คำแนะนำสำหรับผู้ดูแลระบบ

หากผู้ดูแลระบบเซิร์ฟเวอร์สามารถกำหนดค่าบางอย่างใน "วิธีใช้" ได้ คุณอาจแทรก "คำแนะนำสำหรับผู้ดูแลระบบ" ด้วย {{Admin tip}}

หมวดหมู่

ทุกหน้าในเนมสเปซ "Help:" เป็นส่วนหนึ่งของโครงการเอกสารวิธีใช้ที่เป็นสาธารณสมบัติตามคำจำกัดความ และควรจัดหมวดหมู่เป็น หมวดหมู่:ช่วยเหลือ หน้าช่วยเหลือ สำหรับส่วนขยายมีเดียวิกิ ควรจัดอยู่ในหมวดหมู่ย่อย หมวดหมู่:ความช่วยเหลือในการขยาย

หมวดหมู่เดิมของหน้าในเนมสเปซ "Help:" ซึ่งเป็นโครงการเอกสารวิธีใช้สาธารณสมบัติคือ Category:PD help เพื่อให้สอดคล้องกับความเรียบง่าย หมวดหมู่จึงเป็นเพียง หมวดหมู่:ช่วยเหลือ และทุกหน้าได้รับการอัปเดตแล้ว

ดูเพิ่ม

  • โครงการ:นโยบายภาษา  — หากคุณสนใจที่จะทำงานกับหน้าความช่วยเหลือในเวอร์ชัน 'ไม่ใช่ภาษาอังกฤษ
  • Project:PD help/export  — กล่าวถึงวิธีการที่เสนอในการสร้างดัมพ์ที่ใช้งานได้ของวิธีใช้: เนมสเปซ ยังอยู่ในขั้นตอนการสนทนาและยังไม่สามารถใช้งานได้
  • Project:PD help/mirroring  — กล่าวถึงวิธีการอื่นในการรับเนื้อหาจาก MediaWiki.org ซึ่งสามารถใช้ได้ในระหว่างนี้