User:Piripuwa/Template:Sentence POS/doc

From YPPedia
This is a usage of User:Piripuwa/Template:Sentence_POS.

Usage

These usage notes will not be included in articles bearing this template.


Piripuwa's template
This was made by User:Piripuwa for own use. Anyone can use this template. However please don't forget below:
  • Piripuwa may irregularly update it
  • You should use it like {{subst:template name...}}
  • If you use it with {{subst:}}, too much unnecessary　strings as template code may expand to the article.

If you have any questions, please leave message to Piripuwa's talk page.  

This is sentence for Pirate page Opening Sentence. This template will display first sentence on the pirate pages, link to their oceans of play, and optional {{piratestub}} (Usage).

Format

{{User:Piripuwa/Template:Sentence_POS
|piratename=Pirate's name
|ocean1=Ocean which the pirate mainly plays.
|rank1=Rank of the pirate on his/her mainly crew (optional)
|galleries=The number of oceans on which the pirate has galleries (optional)
|crew=Name of a crew which the pirate have joined on mainly ocean (optional)
|title=Title of the pirate on his/her mainly crew (optional)
|flag=Name of a flag which the crew have joined on mainly ocean (optional)
|role=A role of the pirate on mainly ocean (optional)
|stub=yes / no (optional)
|oceanX=The pirate's ocean from the second to the ninth (optional)
}}

Fields

name default value note
piratename Required. Pirate's name which would appear in-game.
ocean1 Required. Ocean which the pirate mainly plays.
rank1 Independent pirate Rank of the pirate on his/her mainly crew. If set rank1=captain, this template will display Piratename on the Ocean1 as a captain. (optional)
galleries 1 The number of oceans on which the pirate has galleries. For each ocean required.
crew Name of a crew which pirate joins on mainly ocean. If set crew=crewname, this template will display Piratename on the Ocean1 as a rank1 of the crew crewname. If you don't set rank1, this will not avail. (optional)
title Title of the pirate on his/her mainly crew. If set title=Monster Hunter, this template will display Piratename on the Ocean1 as a rank1 and Monster Hunter of the crew crewname.
flag Name of a flag which the crew have joined on mainly ocean. If set flag=flagname, this template will display Piratename on the Ocean1 as a role of the flag flagname. If you don't set both crew and rank1, this will not avail. (optional)
role member A role of the pirate on mainly ocean. If you don't set flag, this will not avail. (optional)
stub no If set stub=yes, this template will include {{Stub}} (Usage). And a page which include this template will be included in Category:Pirate stubs. (optional)
oceanX The pirate's ocean from the second to the ninth. If set Ocean2=Hunter, this template will display Pirate name is a pirate on the Ocean1 and Hunter oceans. X numbers should be equal to numbers of galleries. (optional)

Sample

Most simple sentence:

Code Display
{{User:Piripuwa/Template:Sentence_POS

|piratename=Samplepirate
|ocean1=Ice
}}

Samplepirate is a pirate on the Ice Ocean as an Independent pirate.



If you set all parameters, this template will display like below:

Code Display
{{User:Piripuwa/Template:Sentence_POS

|piratename=Samplepirate
|galleries=10
|ocean1=Viridian
|ocean2=Midnight
|ocean3=Hunter
|ocean4=Sage
|ocean5=Cobalt
|ocean6=Marachite
|ocean7=Opal
|ocean8=Jade
|ocean9=Crimson
|ocean10=Ice
|rank1=officer
|crew=Dread Ringers
|title=Alchemist
|flag=Vilya
|role=prince
|stub=yes
}}

Samplepirate is a pirate on the Viridian, Midnight, Hunter, Sage, Cobalt, Malachite, Opal, Jade, Crimson, and Ice Oceans. However, Samplepirate mainly plays on the Viridian ocean as an officer and Alchemist of the crew Dread Ringers, and a prince of the flag Vilya.


Pirate.png Arr! This article about a pirate in Puzzle Pirates be a stub. Ye can help YPPedia by expanding it.

If you set rank and crew name, but don't set role and flag name, this template will display like below:

Code Display
{{User:Piripuwa/Template:Sentence_POS

|piratename=Samplepirate
|galleries=2
|ocean1=Cobalt
|ocean2=Jade
|rank1=senior officer
|crew=Dread Ringers
}}

Samplepirate is a pirate on the Cobalt, and Jade Oceans. However, Samplepirate mainly plays on the Cobalt ocean as a senior officer of the crew Dread Ringers.



If you don't set rank and crew name, but set role and flag name, this template will display like below:

Code Display
{{User:Piripuwa/Template:Sentence_POS

|piratename=Samplepirate
|galleries=2
|ocean1=Cobalt
|ocean2=Jade
|role=King
|crew=Vilya
}}

Samplepirate is a pirate on the Cobalt, and Jade Oceans. However, Samplepirate mainly plays on the Cobalt ocean as an Independent pirate.



If you set rank and role, but don't set crew name and flag name, this template will display like below:

Code Display
{{User:Piripuwa/Template:Sentence_POS

|piratename=Samplepirate
|galleries=2
|ocean1=Cobalt
|ocean2=Jade
|rank1=senior officer
|role=prince
}}

Samplepirate is a pirate on the Cobalt, and Jade Oceans. However, Samplepirate mainly plays on the Cobalt ocean as a senior officer.



If you don't set rank and role, but set crew name and flag name, this template will display like below:

Code Display
{{User:Piripuwa/Template:Sentence_POS

|piratename=Samplepirate
|galleries=3
|ocean1=Viridian
|ocean2=Midnight
|ocean3=Hunter
|crew=Dread Ringers
|flag=Vilya
}}

Samplepirate is a pirate on the Viridian, Midnight, and Hunter Oceans. However, Samplepirate mainly plays on the Viridian ocean as an Independent pirate.



If you set role and flag name, but don't set crew name and rank1, this template will display like below:

Code Display
{{User:Piripuwa/Template:Sentence_POS

|piratename=Samplepirate
|galleries=3
|ocean1=Sage
|ocean2=Midnight
|ocean3=Hunter
|flag=Vilya
|role=prince
}}

Samplepirate is a pirate on the Sage, Midnight, and Hunter Oceans. However, Samplepirate mainly plays on the Sage ocean as an Independent pirate.



See Also

This template includes followings
  • {{piratestub}} (Usage) — Template to denote that an article about a pirate is incomplete and can use fleshing out.
Belows are important to create people's pirate page

Retrieved from "https://yppedia.puzzlepirates.com/index.php?title=User:Piripuwa/Template:Sentence_POS/doc&oldid=543363"