แม่แบบ:แจ้งปรับปรุงหน้าอัตโนมัติ/doc

แม่แบบนี้ใช้ในหน้า User:Nullzerobot/ปรับปรุงหน้าอัตโนมัติ เพื่อระบุให้บอตทำการปรับปรุงหน้านั้นเป็นระยะจากหน้าต้นทาง และหากมีข้อความส่วนใดที่ต้องการการแปล สามารถเขียนให้บอตแทนที่คำอัตโนมัติได้เลย

การใช้งาน

เบื้องต้น ต้องมีพารามิเตอร์ "หน้า" "ต้นทาง" "แจ้ง" (เป็นพารามิเตอร์จำเป็น)

{{แจ้งปรับปรุงหน้าอัตโนมัติ
| หน้า =   <!-- ชื่อหน้าที่จะให้ทำการปรับปรุง          เช่น: แม่แบบ:กล่องข้อมูล -->
| ต้นทาง = <!-- ชื่อหน้าที่จะให้เป็นต้นแบบในการปรับปรุง เช่น: en:Template:Infobox -->
| แจ้ง =   <!-- รายการชื่อผู้ใช้ที่จะให้แจ้งเตือนเมื่อมีการปรับปรุง โดยให้ทำเป็น unordered list 
           <!-- และใช้ {{User0}} ในแต่ละชื่อ เช่น:
* {{User0|abc}}
* {{User0|def}} -->
}}

นอกจากนี้ ยังสามารถมีพารามิเตอร์เสริมได้อีก

{{แจ้งปรับปรุงหน้าอัตโนมัติ
| หน้า =
| ต้นทาง =
| แจ้ง =
| รอเสถียร =       <!-- เป็นการบอกว่าจะให้ปรับปรุงหน้าก็ต่อเมื่อหน้าต้นทางเสถียร (ไม่มีการแก้) เป็นเวลาที่กำหนด -->
                   <!-- เช่น: 10 แปลว่าปรับปรุงก็ต่อเมื่อไม่มีความเคลื่อนไหว 10 วัน -->
| กระบะทราย =      <!-- เป็นการบอกว่าให้ปรับปรุงหน้าไปที่กระบะทราย (/sandbox) แทนที่จะปรับปรุงลงหน้าโดยตรง -->
                   <!-- มีค่าเป็น ใช่/ไม่ (หากไม่ อาจไม่ระบุพารามิเตอร์นี้เลยก็ได้) -->
| พัก =            <!-- เป็นการบอกว่าไม่ให้ดำเนินการการปรับปรุงนี้ชั่วคราว -->
                   <!-- มีค่าเป็น ใช่/ไม่ (หากไม่ อาจไม่ระบุพารามิเตอร์นี้เลยก็ได้) -->
| ค้นหา1 =         <!-- ข้อความที่จะให้ค้นหา เพื่อที่จะแทนที่ (ดูพารามิเตอร์แทนที่ประกอบ) เช่น: "\{\{infobox" -->
| แทนที่1 =        <!-- ข้อความที่จะให้แทนที่ (ดูพารามิเตอร์ค้นหาประกอบ)                  เช่น: "\{\{กล่องข้อมูล" -->
| ค้นหา2 =         <!-- เช่น: "ABCabc" -->
| แทนที่2 =        <!-- เช่น: "กขค012" -->
| ...            
| ...              <!-- เช่น: มีข้อความ "{{infobox|name=ABCabc|class1=qwe}}" เมื่อค้นหาและแทนที่ตามที่ยกตัวอย่างมา -->
| ...              <!-- จะได้ข้อความ "{{กล่องข้อมูล|name=กขค012|class1=qwe}}" -->
| ...              <!-- ดูรายละเอียดเพิ่มเติมที่หัวข้อการเข้ารหัส -->
| ...
| ... <!--  ด้านล่างนี้คือพารามิเตอร์สำหรับการปรับปรุงหน้าในเนมสเปซแม่แบบโดยเฉพาะ  -->
| ...
| พารามิเตอร์1 =   <!-- พารามิเตอร์จากหน้าต้นทาง             เช่น: name จาก {{{name}}} -->
| แปล1 =           <!-- พารามิเตอร์แปลในหน้าที่จะให้ปรับปรุง เช่น: ชื่อ จาก {{{ชื่อ}}} -->
| พารามิเตอร์2 =   <!-- เช่น: col จาก {{{col|...}}} -->
| แปล2 =           <!-- เช่น: สี  จาก {{{สี|...}}} -->
| ...
| ...              <!-- เช่น: มีข้อความ "{{{name|John {{#if:{{{col|}}}|{{{col}}}}}}}}" -->
| ...              <!-- เช่น: จะได้ข้อความ "{{{ชื่อ{{{name|John {{#if:{{{สี|{{{col|}}}}}}|{{{สี|{{{col}}}}}}}}}}}}}}" -->
| ...
| ล้าสมัย1 =       <!-- พารามิเตอร์ที่ล้าสมัยแล้ว ต้องการให้เลิกใช้โดยเด็ดขาด เช่น: fullname จาก {{{fullname}}} -->
| แทนที่ล้าสมัย1 = <!-- กลุ่มพารามิเตอร์ที่ให้ใช้แทนที่พารามิเตอร์ที่ล้าสมัยแล้ว เช่น: realname, name -->
| ผิดพลาดล้าสมัย1 = <!-- ขึ้นข้อความเตือนว่าผิดพลาดหรือไม่ มีค่าเป็น ใช่/ไม่ -->
| ...
| หมวดหมู่1 =      <!-- หมวดหมู่ที่จะให้เพิ่มหน้าที่ใช้พารามิเตอร์ล้าสมัยนี้ -->
                   <!-- เช่น: หน้าที่มีการเรียกใช้แม่แบบxxxพร้อมพารามิเตอร์ล้าสมัย -->
| ...
| ...              <!-- โดยหน้าใดที่ยังใช้พารามิเตอร์ล้าสมัยอยู่ จะมีข้อความสีแดงขึ้นเตือนว่าพารามิเตอร์ล้าสมัย -->
| ...              <!-- และจะจัดหน้าเหล่านั้นเข้าหมวดหมู่โดยอัตโนมัติ -->
| ...
}}

การเข้ารหัส

1. ต้องคร่อมข้อความค้นหาและแทนที่ด้วย "..." (เพื่อป้องกัน whitespace ด้านหน้าและหลัง)
2. ต้องใช้ \\ แทนที่ \ (เพื่อ escape character อื่น ๆ)
3. ต้องใช้ \! แทนที่ | (เพื่อไม่ให้ประมวลผลผิดเป็นพารามิเตอร์ใหม่)
4. ต้องใช้ \{ และ \} แทนที่ { และ } ตามลำดับ เพื่อกันการเรียก Parser function โดยไม่พึงประสงค์
5. อาจใช้ \n แทนที่การขึ้นบรรทัดใหม่ (เพื่อทำให้รหัสเขียนในบรรทัดเดียวได้)

หมายเหตุสำหรับพารามิเตอร์

1. บางหน้าจะมีการใช้กระบะทรายในหน้าต้นทางอยู่แล้ว ดังนั้นอาจจะไม่จำเป็นต้องใช้พารามิเตอร์ "รอเสถียร"

ตัวอย่าง

{{แจ้งปรับปรุงหน้าอัตโนมัติ
| หน้า = Module:Navbox
| ต้นทาง = en:Module:Navbox
| แจ้ง =
* {{User0|AbC}}
* {{User0|dEF}}
* {{User0|กขค}}
}}

หรือ

{{แจ้งปรับปรุงหน้าอัตโนมัติ
| หน้า = แม่แบบ:Navbar
| ต้นทาง = en:Template:Navbar
| แจ้ง =
* {{User0|Nullzero}}
| รอเสถียร = 7
| พัก = ใช่
| กระบะทราย = ใช่
| ค้นหา1 = "abcdef\n\{\{abc\!123\}\}abcdef=poi"
| แทนที่1 = "สวัสดีครับ"
| พารามิเตอร์1 = fontsize
| แปล1 = ขนาดฟอนต์
| ล้าสมัย1 = abc
| แทนที่ล้าสมัย1 = def, qwe
| ผิดพลาดล้าสมัย = ไม่
| หมวดหมู่1 = หน้าที่ใช้แม่แบบ Navbar ที่มีพารามิเตอร์ล้าสมัย
}}

ดูเพิ่ม

• ผู้ใช้:Nullzerobot/ปรับปรุงหน้าอัตโนมัติ