Help:Extension:ParserFunctions/th

ส่วนขยายพาร์สเซอร์ฟังก์ชั่น เป็นส่วนขยายที่จะเพิ่มพาร์สเซอร์ฟังก์ชั่นอื่นๆ อีก 10 ฟังก์ชั่น เพื่อสนับสนุนการใช้งาน เมจิกเวิร์ด ที่มีอยู่แล้วในซอฟท์แวร์มีเดียวิกิ, พาร์สเซอร์ฟังก์ชั่นที่ได้จากส่วนขยายนี้จะทำงานโดยใช้ฟอร์มต่อไปนี้ :
 *  

#expr:
ฟังก์ชั่นนี้จะคำนวนสูตรทางคณิตศาสตร์ และคืนค่าที่คำนวนแล้ว


 *  

ตัวดำเนินการที่ใช้ได้จะแสดงไว้ทางด้านขวา ตามลำดับ ดูที่ สำหรับรายระเอียดเพิ่มเติมของตัวดำเนินการแต่ละอย่าง, ความถูกต้องและรูปแบบของผลลัพธ์ที่คืนค่ามาอาจจะแตกต่างกันไป ขึ้นอยู่กับระบบปฏิบัติการของเซิร์ฟเวอร์ที่ซอฟท์แวร์มีเดียวิกิรันอยู่ และการจัดรูปแบบตัวเลขของภาษาที่เซิร์ฟเวอร์ใช้

เมื่อคำนวนค่าทางตรรกศาสตร์(Boolean algebra) ศูนย์จะถูกนับว่าเป็นค่าเท็จ (false) และค่าที่ไม่ใช่ศูนย์, จำนวนเต็มบวกและจำนวนเต็มลบ จะถูกนำว่าเป็นค่าจริง (true)


 *   &rarr; 
 *   &rarr; 

เมื่อป้อนค่าว่างให้ฟังก์ชั่นนี้ จะคืนค่าเป็นค่าว่าง, สำหรับสูตรคณิตศาสตร์ที่ไม่ถูกต้อง จะคืนค่าเป็นข้อความแสดงความผิดพลาด ซึ่งสามารถตรวจจับได้โดยฟังก์ชั่น #iferror:


 *   &rarr;  
 *  </tt> &rarr; 
 *  </tt> &rarr; 

#if:

 *  </tt>

ฟังก์ชั่นนี้จะตรวจสอบว่าพารามิเตอร์แรกเป็นค่าว่างหรือไม่ จะเป็นเท็จถ้าข้อความที่นำมาทดสอบ(test string</tt>) ว่างเปล่า หรือมีเฉพาะอักขระว่าง(เช่น เว้นวรรค, ขึ้นบรรทัดใหม่  เป็นต้น) ดังตัวอย่างต่อไปนี้:


 *  </tt> &rarr; 
 *  </tt> &rarr; 
 *  </tt> &rarr; 
 *  </tt> &rarr; 

ข้อความทดสอบ(test string</tt>) จะถูกนับว่าเป็นข้อความธรรมดาเสมอ, ดังนั้นสูตรทางคณิตศาสตร์จะไม่ถูกคำนวน ดังต่อไปนี้:


 *  </tt> &rarr; 

ค่าที่กำหนดให้คืนมาอย่างใดอย่างหนึ่งหรือทั้งสองอย่าง อาจละเว้นได้ ดังต่อไปนี้:

Either or both the return values may be omitted:


 *  </tt> &rarr;  
 *  </tt> &rarr;  
 *  </tt> &rarr;  

ดูที่ Help:Parser functions in templates สำหรับตัวอย่างเพิ่มเติมของพาร์สเซอร์ฟังก์ชั่นนี้

#ifeq:
พาร์สเซอร์ฟังก์ชั่นนี้จะเปรียบเทียบค่าทั้งสองที่กำหนดมา ว่าเหมือนกันหรือไม่


 *  </tt>

ถ้าข้อความทั้งสองที่นำมาทดสอบเป็นค่าตัวเลข ฟังก์ชั่นนี้จะเปรียบเทียบข้อความเหล่านั้นตามแบบเลขคณิต ดังต่อไปนี้:


 *  </tt> &rarr; 
 *  </tt> &rarr; 

หรือไม่ ถ้าข้อความทดสอบเป็นข้อความตัวอักษร ฟังก์ชั่นนี้จะให้ความสำคัญกับตัวพิมพ์เล็กพิมพ์ใหญ่ ดังต่อไปนี้:


 * <tt> </tt> &rarr; 
 * <tt> </tt> &rarr; 
 * <tt> </tt> &rarr; 

#iferror:
ฟังก์ชั่นนี้จะรับค่าข้อความทดสอบ และคืนค่าผลลัพธ์ออกมาหนึ่งในสอง ฟังก์ชั่นนี้จะนับว่าเป็นจริง(<tt>true</tt>) เมื่อค่าข้อความที่ป้อนเข้ามามีวัตถุ HTML ที่มีแอตทริบิวต์ <tt>class="error"</tt> อยู่ซึ่งถูกสร้างขึ้นโดยพาร์สเซอร์ฟังก์ชั่นอื่นๆ อย่างเช่น <tt>#expr:</tt>, <tt>#time:</tt> and <tt>#rel2abs:</tt>, ความผิดพลาดของแม่แบบอันเกิดจากการวนลูป และความผิดพลาดทางพาร์สเซอร์ 'failsoft' อื่นๆ


 * <tt> </tt>

ข้อความทดสอบอย่างใดอย่างหนึ่งหรือทั้งสองอย่างสามารถละเว้นได้, ข้อความทดสอบจะถูกคืนค่าออกมาเมื่อไม่เกิดข้อผิดพลาด แต่ถ้าหาก ค่าที่จะแสดงเมื่อเกิดข้อผิดพลาด ถูกละเว้น เมื่อเกิดความผิดพลาดฟังก์ชั่นนี้จะคืนค่าว่างเปล่าออกมา ตามต่อไปนี้:


 * <tt> </tt> &rarr; 
 * <tt> </tt> &rarr; 
 * <tt> </tt> &rarr; 
 * <tt> </tt> &rarr; 
 * <tt> </tt> &rarr;  
 * <tt> </tt> &rarr;  

#ifexpr:
ฟังก์ชั่นนี้จะคำนวนสูตรทางคณิตศาสตร์ และคืนค่าออกมาหนึ่งในสองค่า ตามค่าทางตรรกศาสตร์ที่กำหนดเป็นผลลัพธ์ไว้


 * <tt> </tt>

นิพจน์ที่ป้อนเข้ามา จะถูกประมวลผลในลักษณะคล้ายกันกับ <tt>#expr:</tt> และใช้ตัวดำเนินการเหมือนกับฟังก์ชั่นดังกล่าว ค่าที่ส่งออกมาจะเป็นค่าทางตรรกศาสตร์. ฟังก์ชั่นนี้คล้ายกับ <tt>#ifeq:</tt> และ <tt>#expr:</tt>

ค่าว่างที่ป้อนเข้ามาจะถูกประมวลผลว่าเป็นค่าเท็จ


 * <tt> </tt> &rarr; 

ค่าที่เรากำหนดให้แสดงใดค่าหนึ่งหรือทั้งสอง สามารถที่จะละเว้นได้ ฟังก์ชั่นนี้จะไม่คืนค่าออกมาถ้าหากค่าที่กำหนดให้แสดงว่างเปล่า


 * <tt> </tt> &rarr; 
 * <tt> </tt> &rarr;  
 * <tt> </tt> &rarr;  
 * <tt> </tt> &rarr;  
 * <tt> </tt> &rarr;  

#ifexist:
This function takes an input string, interprets it as a page title, and returns one of two values depending on whether or not the page exists on the local wiki.


 * <tt> </tt>

The function evaluates to <tt>true</tt> if the page exists, whether it contains content, is visibly blank (contains meta-data such as category links or magic words, but no visible content), is blank, or is a redirect. Only pages that are redlinked evaluate to false, including if the page used to exist but has been deleted.


 * <tt> </tt> &rarr; 
 * <tt> </tt> &rarr; 

The function evaluates to true for system messages that have been customised, and for special pages that are defined by the software.


 * <tt> </tt> &rarr; 
 * <tt> </tt> &rarr;
 * <tt> </tt> &rarr;

<tt>#ifexist:</tt> is considered an "expensive parser function", only a limited number of which can be included on any one page (including functions inside transcluded templates). When this limit is exceeded, the page is categorised into Category:, and any further <tt>#ifexist:</tt> functions automatically return false, whether the target page exists or not.

If a page checks a target using <tt>#ifexist:</tt>, then that page will appear in the list for the target page. So if the code <tt> </tt> were included live on this page, /Foo will list.

On wikis using a shared media repository, <tt>#ifexist:</tt> can be used to check if a file has been uploaded to the repository, but not to the wiki itself:
 * <tt> </tt>  &rarr; 
 * <tt> </tt> &rarr; 
 * <tt> </tt> &rarr; 

If a local description page has been created for the file, the result is exists for all of the above.

#rel2abs:
This function converts a relative file path into an absolute filepath.


 * <tt> </tt>
 * <tt> </tt>

Within the <tt>path</tt> input, the following syntax is valid:
 * &rarr; the current level
 * &rarr; "go up one level"
 * &rarr; "go down one level into the subdirectory /foo"

If the <tt>base path</tt> is not specified, the full page name of the page will be used instead:


 * <tt> </tt> &rarr; '''
 * <tt> </tt> &rarr; '''
 * <tt> </tt> &rarr; '''
 * <tt> </tt> &rarr; '''

Invalid syntax, such as <tt>/.</tt> or <tt>/./</tt>, is ignored. Since no more than two consecutive full stops are permitted, sequences such as these can be used to separate successive statements:


 * <tt> </tt> &rarr; '''
 * <tt> </tt> &rarr; '''
 * <tt> </tt> &rarr; '''
 * <tt> </tt> &rarr; '''

#switch:
This function compares one input value against several test cases, returning an associated string if a match is found.

The <tt>default result</tt> is returned if no <tt>case</tt> string matches the <tt>comparison string</tt>. In this syntax, the default result must be the last parameter and must not contain a raw equals sign. Alternatively, the default result may be explicitly declared with a case string of "<tt>#default</tt>"; default results declared in this way may be placed anywhere within the function:


 * <tt> </tt> &rarr; 

If no match is made, no content is added. It is possible to have 'fall through' values, where several <tt>case</tt> strings return the same <tt>result</tt> string. This minimises duplication.

Here cases 2, 3 and 4 all return <tt>result2</tt>; cases 6 and 7 both return <tt>result4</tt>

As with <tt>#ifeq:</tt>, the comparison is made numerically if both the comparison string and the case string being tested are numeric; or as case-sensitive string otherwise. A <tt>case</tt> string may be empty:
 * <tt> </tt> &rarr; 

Once a match is found, subsequent <tt>cases</tt> are ignored:
 * <tt> </tt> &rarr; 

#time:
This parser function takes a date and/or time construct and formats it according to the syntax given. A date/time object can be specified; the default is the value of the magic word <tt> </tt> – that is, the time the page was last rendered into HTML.


 * <tt> </tt>
 * <tt> </tt>

The list of accepted formatting codes is given in the table to the right. Any character in the formatting string that is not recognised is passed through unaltered. There are also two ways to escape characters within the formatting string: In addition, the digraph <tt>xx</tt> is interpreted as a single literal "x".
 * 1) A backslash followed by a formatting character is interpreted as a single literal character
 * 2) characters enclosed in double quotes are considered literal characters, and the quotes are removed


 * <tt> </tt> &rarr; 
 * <tt> </tt> &rarr; 
 * <tt> </tt> &rarr; 
 * <tt> </tt> &rarr; 
 * <tt> </tt> &rarr; 

The <tt>date/time object</tt> can be in any format accepted by PHP's strtotime function. Both absolute (eg <tt>20 December 2000</tt>) and relative (eg <tt>+20 hours</tt>) times are accepted.

Full or partial absolute dates can be specified; the function will 'fill in' parts of the date that are not specified using the current values:


 * <tt> </tt> &rarr; '''

A four-digit number is interpreted as hours and minutes if possible, and otherwise as year: <tt> </tt> &rarr; ''' Input is treated as a time rather than a year. <tt> </tt> &rarr; ''' Since 19:60 is not a valid time, 1960 is treated as a year.

A six-digit number is interpreted as hours, minutes and seconds if possible, but otherwise as an error (not, for instance, a year and month): <tt> </tt> &rarr; ''' Input is treated as a time rather than a year+month code. <tt> </tt> &rarr; ''' Although 19:60:09 is not a valid time, 196009 is not interpreted as September 1960.

The function performs a certain amount of date mathematics:


 * <tt> </tt> &rarr; '''
 * <tt> </tt> &rarr; '''
 * <tt> </tt> &rarr; '''
 * <tt> </tt> &rarr; '''

#timel:
This function is identical to <tt> </tt>, except that it uses the local time of the wiki (as set in ) when no date is given.


 * <tt> </tt> &rarr; 
 * <tt> </tt> &rarr; 
 * <tt> </tt> &rarr; 
 * <tt> </tt> &rarr; 

#titleparts:
This function separates a pagetitle into segments based on slashes, then returns some of those segments as output.


 * <tt> </tt>

If the <tt>number of segments</tt> parameter is not specified, it defaults to "0", which returns all the segments. If the <tt>first segment</tt> parameter is not specified or is "0", it defaults to "1":


 * <tt> </tt> &rarr; 
 * <tt> </tt> &rarr; 
 * <tt> </tt> &rarr; 
 * <tt> </tt> &rarr; 

Negative values are accepted for both values. Negative values for <tt>number of segments</tt> effectively 'strips' segments from the end of the string. Negative values for <tt>first segment</tt> translates to "add this value to the total number of segments", loosely equivalent to "count from the right":


 * <tt> </tt> &rarr; 
 * <tt> </tt> &rarr;  
 * <tt> </tt> &rarr;   Strips one segment from the end of the string, then returns the second segment and beyond

The string is split a maximum of 25 times; further slashes are ignored. The string is also limited to 255 characters, as it is treated as a page title:


 * <tt> </tt> &rarr; 

Substitution
Parser functions can be substituted by prefixing the hash character with <tt>subst:</tt>:


 * <tt> </tt> &rarr; the code <tt>    </tt> will be inserted in the wikitext since the page  exists.

Tables
Parser functions will mangle wikitable syntax, treating all the raw pipe characters as parameter divisors. To avoid this, most wikis create the template    :! with its contents only a raw pipe character. This 'hides' the pipe from the MediaWiki parser, ensuring that it is not considered until after all the templates and variables on a page have been expanded. Alternatively, raw HTML table syntax can be used, although this is less intuitive and more error-prone.

Stripping whitespace
Whitespace, including newlines, tabs, and spaces, is stripped from the beginning and end of all the parameters of these parser functions. If this is not desirable, adding any non-whitespace characters (including the HTML encoding for a whitespace character, invisible Unicode characters such as the zero-width space or direction marks, or sequences recognised and stripped by the MediaWiki parser such as <tt>  </tt>) will prevent further stripping:


 * &rarr; 


 * &rarr; 


 * &rarr;