Template:Phone history/doc: Difference between revisions

From Tears of Themis Wiki
imported>Harmonea
m (tweaking icon field notes)
imported>Harmonea
(rewrite for header format instead of script format)
 
Line 1: Line 1:
{{doc/start}}
{{doc/start}}
==Description==
==Description==
Template used to display a script of any phone history item (Texts, calls, messages) using [[Template:Script]] while also storing information about the it to Cargo for querying on other pages.
Template used to display a small header containing information about any phone history item (Texts, calls, messages) while also storing it to Cargo for querying on other pages. It also contains an invisible anchor to #PhoneItem_(name) for quick linking.


==Usage==
==Usage==
Line 9: Line 9:
|contact=
|contact=
|unlock=
|unlock=
|script=
}}</pre>
}}</pre>


* The "name" field should display any label under which the call is stored in the phone object. For Video Calls this is typically the card name (when the call is attached to a card). For Text Messages, this is the "topic" tab.
* The "name" field should display any label under which the call/message is stored in the phone object. For Video Calls this is typically the card name (when the call is attached to a card). For Text Messages, this is the "topic" tab.
* The "historyType" field should be one of the following if you'd like the script to go through to the [[Phone]] page:
* The "historyType" field should be one of the following if you'd like the call/message to go through to the [[Phone]] page:
** Text Message
** Text Message
** Video Call
** Video Call
Line 20: Line 19:
* The "contact" field is the male lead involved in the call or message.
* The "contact" field is the male lead involved in the call or message.
* The "unlock" field is optional and should contain any information about how to unlock the call or message ''other'' than the name of the card or story.
* The "unlock" field is optional and should contain any information about how to unlock the call or message ''other'' than the name of the card or story.
* The "script" field should contain the script of the call or message using [[Template:SL]] and [[Template:SC]] as needed.
* An optional "icon" field exists to override the default icon filename if needed (applies to video calls only).
* An optional "icon" field exists to override the default icon filename if needed (applies to video calls only).


Line 29: Line 27:
|contact=Artem
|contact=Artem
|unlock=After Story 3
|unlock=After Story 3
|script=
{{SL|You|Mr. Wing, can you teach me how to make sweet and sour pork?}}
{{SL|Artem|Why are you asking about that all of a sudden?}}
}}</pre>
}}</pre>
{{Script
{|class="wikitable" style="margin:0px; padding:0px;"
|scriptHeader=Text Message: Sweet and Sour Pork (After Story 3)
!style="background: #c0c0c0" width="60px"|[[File:Phone text message icon.png|50px|link=Phone#Text Messages]]<br />Text Message
|characterLinks=Artem=Artem!Artem Wing,You!Main Character
|style="border-left:0px; padding-right:15px"|Artem:<br/>Sweet and Sour Pork
|script=
:''(After Story 3)''
{{SL|You|Mr. Wing, can you teach me how to make sweet and sour pork?}}
|}
{{SL|Artem|Why are you asking about that all of a sudden?}}
}}


{{doc/end}}
{{doc/end}}

Latest revision as of 00:24, 6 November 2021

Template-info.png Documentation
[purge]

Description[edit source]

Template used to display a small header containing information about any phone history item (Texts, calls, messages) while also storing it to Cargo for querying on other pages. It also contains an invisible anchor to #PhoneItem_(name) for quick linking.

Usage[edit source]

{{Phone history
|name=
|historyType=
|contact=
|unlock=
}}
  • The "name" field should display any label under which the call/message is stored in the phone object. For Video Calls this is typically the card name (when the call is attached to a card). For Text Messages, this is the "topic" tab.
  • The "historyType" field should be one of the following if you'd like the call/message to go through to the Phone page:
    • Text Message
    • Video Call
    • Voice Call
    • Voice Message
  • The "contact" field is the male lead involved in the call or message.
  • The "unlock" field is optional and should contain any information about how to unlock the call or message other than the name of the card or story.
  • An optional "icon" field exists to override the default icon filename if needed (applies to video calls only).

Example[edit source]

{{Phone history
|name=Sweet and Sour Pork
|historyType=Text Message
|contact=Artem
|unlock=After Story 3
}}
Phone text message icon.png
Text Message 		Artem:
Sweet and Sour Pork
(After Story 3)

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.

Retrieved from "http://tot.wiki/index.php?title=Template:Phone_history/doc&oldid=21518"