แม่แบบ:หน้าย่อยคู่มือการใช้งาน
 | นี่คือหน้าย่อยเอกสารกำกับของ แม่แบบ:หน้าย่อยคู่มือการใช้งาน ใช้ในการเขียนคำอธิบายวิธีการใช้งาน จัดหมวดหมู่ และเนื้อหาอื่น ๆ ที่ไม่ได้เป็นส่วนหนึ่งของหน้าแม่แบบต้นฉบับ |
แม่แบบนี้จะแสดงผลข้อความว่าหน้าปัจจุบันเป็นหน้าย่อยเอกสารกำกับ (หรือหน้าย่อยคู่มือการใช้งาน)
การใช้งาน
[แก้]{{หน้าย่อยคู่มือการใช้งาน}}- หรือ
{{หน้าย่อยคู่มือการใช้งาน|[[หน้าที่มีเอกสารประกอบรวมผ่าน]]}}
เอกสารประกอบกล่องผู้ใช้
[แก้]หากต้องการตั้งค่าแม่แบบนี้เพื่อให้ปรากฏคำว่า "กล่องผู้ใช้" และ "หน้ากล่องผู้ใช้" แทนที่จะเป็นคำว่า "แม่แบบ" และ "หน้าแม่แบบ" หรือ "แม่แบบผู้ใช้" และ "หน้าแม่แบบผู้ใช้" ให้ใช้แม่แบบต่อไปนี้แทน:
{{Userbox documentation subpage}}- หรือ
{{Userbox documentation subpage|[[หน้ากล่องผู้ใช้]]}}
การปรับแต่งข้อความ
[แก้]สามารถใช้พารามิเตอร์ |text1= และ |text2= เพื่อตั้งค่าข้อความของบรรทัดแรกและบรรทัดที่สองของแม่แบบตามลำดับ หากตั้งค่า text1 แต่ไม่ได้ตั้งค่า text2 ข้อความของทั้งสองบรรทัดจะมาจาก text1:
{{Documentation subpage |text1='''''text1 ปรากฏที่นี่''''' |text2='''''text2 ปรากฏที่นี่'''''}}
| นี่คือหน้าย่อยเอกสารกำกับของ [หน้า] ใช้ในการเขียนคำอธิบายวิธีการใช้งาน จัดหมวดหมู่ และเนื้อหาอื่น ๆ ที่ไม่ได้เป็นส่วนหนึ่งของtext2 ปรากฏที่นี่ต้นฉบับ |
{{Documentation subpage |text2='''''text2 ปรากฏที่นี่'''''}}
| นี่คือหน้าย่อยเอกสารกำกับของ [หน้า] ใช้ในการเขียนคำอธิบายวิธีการใช้งาน จัดหมวดหมู่ และเนื้อหาอื่น ๆ ที่ไม่ได้เป็นส่วนหนึ่งของtext2 ปรากฏที่นี่ต้นฉบับ |
{{Documentation subpage |text1='''''text1 ปรากฏที่นี่'''''}}
| นี่คือหน้าย่อยเอกสารกำกับของ [หน้า] ใช้ในการเขียนคำอธิบายวิธีการใช้งาน จัดหมวดหมู่ และเนื้อหาอื่น ๆ ที่ไม่ได้เป็นส่วนหนึ่งของtext1 ปรากฏที่นี่ต้นฉบับ |
พารามิเตอร์อื่น ๆ
[แก้]|inhibit=yes จะป้องกันไม่ให้แม่แบบนี้สร้างหมวดหมู่ใด ๆ (โดยค่าเริ่มต้นจะมีการเพิ่มหมวดหมู่ "หน้าเอกสารกำกับเนมสเปซ" (ปกติคือ หมวดหมู่:หน้าเอกสารกำกับแม่แบบ) หรือเพิ่มหมวดหมู่ หมวดหมู่:หน้าย่อยเอกสารกำกับที่ไม่มีหน้าที่สอดคล้องกัน หากไม่มีหน้าหลักอยู่)
ผลแสดง
[แก้]โดยปกติแม่แบบนี้ควรวางไว้ที่ด้านบนของหน้า /doc ผลลัพธ์จะเปลี่ยนแปลงขึ้นอยู่กับว่าจะดูจากที่ไหน:
- ในหน้า /doc จะแสดงผลกล่องอธิบายเอกสารประกอบแม่แบบและลิงก์ไปยังหน้าแม่แบบ
- วิธีแก้ไขหากชื่อของหน้าเอกสารกำกับไม่ได้ลงท้ายด้วย '/doc' ให้ใช้
|override=เพื่อระบุชื่อของหน้าย่อยเอกสารกำกับ ตัวอย่างเช่น หากเอกสารกำกับอยู่ที่ "แม่แบบ:ตัวอย่าง/Documentation" ให้ใช้|override=documentation(ต้องใช้ตัวพิมพ์เล็กแม่แบบถึงจะทำงาน)
- วิธีแก้ไขหากชื่อของหน้าเอกสารกำกับไม่ได้ลงท้ายด้วย '/doc' ให้ใช้
- ในหน้าอื่น ๆ เช่น หน้าที่รวมผ่านหน้า /doc แม่แบบนี้จะไม่ปรากฏ ส่วนในหน้าแม่แบบเอง (ซึ่งมีแม่แบบ
{{Documentation}}อยู่) จะระบุโดยอัตโนมัติว่าเอกสารประกอบนั้นรวมผ่านมาจากหน้าย่อย
เอกสารกำกับมอดูล
[แก้]แม่แบบนี้จะแสดงบนหน้าย่อย /doc ในเนมสเปซมอดูลโดยอัตโนมัติ ซึ่งจะดำเนินการโดยอัตโนมัติผ่าน มีเดียวิกิ:Scribunto-doc-page-header แต่วิธีนี้จะเพิ่มหน้าเอกสารกำกับดังกล่าวลงใน หมวดหมู่:หน้าเอกสารกำกับมอดูล ไม่ได้ ดังนั้น หน้าเอกสารกำกับมอดูลบางหน้าจึงต้องทำการรวมผ่านแม่แบบนี้ด้วยตนเอง หรือเพิ่มหมวดหมู่โดยตรงเพื่อแก้ไขปัญหานี้
การจัดหมวดหมู่อัตโนมัติ
[แก้]นอกจากแสดงข้อความแล้ว แม่แบบนี้ยังเพิ่มหน้าลงใน หมวดหมู่:หน้าเอกสารกำกับแม่แบบ, หมวดหมู่:หน้าเอกสารกำกับผู้ใช้ หรืออื่น ๆ ที่คล้ายกัน (ตั้งชื่อตามเนมสเปซหัวเรื่อง) แต่จะดำเนินการกับหน้าเอกสารกำกับในเนมสเปซที่มีคุณลักษณะที่สามารถมีหน้าย่อยได้เท่านั้น โดยค่าเริ่มต้นดัชนีการเรียงลำดับจะเป็นชื่อหน้าโดยไม่มีเนมสเปซ ตัวอย่างเช่น แม่แบบ:Foo จะถูกเรียงลำดับจากคำว่า "Foo" หรือภายใต้ดัชนีการเรียงลำดับอื่น เช่น "F"