Difference between revisions of "User:Eabrace/ContactInfoStandard"

Latest revision as of 00:02, 14 December 2007

Note: This is only a proposal at this time, and is subject to change. As such, this is not necessarily the template you should follow if you're working on a contact page at this moment, but it might be helpful in offering ideas.

Relates to this forum topic:

Contact Article standardization

Working copy of an example located here.

Contact Overviews

First section in any contact article. Provides at-a-glance information about the contact.

 == Overview ==
 {{Infobox Contact
 |name= <name of contact>
 |image= <contact image>
 |img_capt= <caption under image, usually the contact's name>
 |zone= <link to zone the contact is located in>
 |x= <x-coord>
 |y= <y-coord>
 |z= <z-coord>
 |levels= <minimum level> - <maximum level>
 |introed= <link(s) to article(s) of contact(s) that introduce this contact>
 |intros= <link(s) to article(s) of contact(s) that this contact introduces>
 |enemies= <enemies; use {{Enemy <enemy name>}} for each enemy group>
 }}
 

 {{Contact Overview
 |Name=<name of contact>
 |City=<H, V, or HV>
 |Zone=<zone the contact is located in>
 |x= <x-coord>
 |y= <y-coord>
 |z= <z-coord>
 |Pronoun=<his, her, its, etc.>
 |HoodYN=<Y, N; indicates whether the contact is located in a particular neighborhood>
 |Hood=<neighborhood the contact is located in, if any>
 |OriginYN=<Y, N; indicates whether or not the contact has an Origin>
 |Origin=<origin of the contact, if any>
 |LevelYN=<Y, N; indicates whether the contact has a valid level range>
 |Level=<minimum level>-<maximum level>
 }}
 

 __TOC__

Could we possibly combine the Infobox Contact template with the Contact Overview template? I see a few common fields that would lend themselves to this. Perhaps, if we change the Contact Overview template to include the Infobox Contact template and feed in the following:

|name= <name of contact>
|image= <contact image>
|img_capt= 
|zone= <name of the zone the contact is located in>
|x= <x-coord>
|y= <y-coord>
|z= <z-coord>
|levelmin= <minimum level>
|levelmax= <maximum level>
|introed= <link(s) to article(s) of contact(s) that introduce this contact>
|intros= <link(s) to article(s) of contact(s) that this contact introduces>
|enemies= <enemies; use {{Enemy <enemy name>}} for each enemy group>
|badges=<any badges that are rewarded by this contact's missions, either linked to the mission that offers the badge 
(i.e. [[#Badge Mission Name|Badge Name]], or linked to badge using 
 template>
|city=<h, H, v, V, hv, or HV>
|pronoun=<his, her, its, etc.>
|hood=<neighborhood the contact is located in, if any>
|origin=<origin of the contact, if any>

Introductions

== Introductions ==
=== Contact Introduced By===
*<link to contact that introduces this contact>
*<link to contact that introduces this contact>


=== New Contacts ===
*{{New Contact <NewContactName>}}
*{{New Contact <NewContactName>}}
*{{New Contact <NewContactName>}}


=== Information ===
'''<contact's Title shown in the "ask about this contact" information>'''


<text description from the "ask about this contact" information>


=== Initial Contact ===
<briefing text shown the first time you speak to this contact>


=== Below Level Requirement ===
<briefing text shown if you speak to this contact before reaching the contact's minimum required level>


=== Unfamiliar Contact ===
<briefing text shown if you speak to this contact before being introduced>


=== Too Busy ===
<briefing text shown if you speak to this contact with three task already in assigned missions>

Although the "Too Busy" and "Unfamiliar Contact" briefing text are not usually recorded, if someone wanted to put them in, this would give them a place to do it.

The "New Contact" templates are recent additions to articles. Since the introduction text for a new contact is the same regardless of who is introducing the contact, use of a template for each contact's introduction allows us to only have to enter the text once and makes it easier to maintain the text.

Store

== Store ==
* [[Inspirations]]
* {{Store <origin>|Level=<enhancement level>|Price=<price of enhancements as % of base price>}} {{P10Only}} <-if they only sell power 10s
* {{Store Nat Mag|Level=15|Price=150}}

The "Store" template will display information about the origin, level, and cost of the enhancements that a contact sells and link to the the store article that shows the prices of those enhancements. For example:

Level 15 Natural/Magic Dual Origin Enhancements (150% base costs)

Badge Mission

Currently: Used only if the contact offers a mission that rewards a badge and that mission is not part of a story arc?

Proposed: Remove section. Rather than spelling out the entire mission here or listing the badges and linking to the articles, include the badges offered in the overview section and link to specific missions from there.

Why? Because sometimes, the badge mission might be part of an arc.

Story Arcs

Current:

== Story Arc ==
=== <story arc title> ===
'''Souvenir:''' <name of the souvenir as it appears in the "Souvenir" tab of the Clues Window>


<introductory souvenir text>


'''<story arc title>'''


<souvenir story arc recap text>

Proposed:

== <story arc title> (Story Arc) ==

And separate the souvenir into its own section.

Souvenirs

Creating a template for Souvenirs. Maybe something like this:

{{Souvenir
|name=<name of the souvenir as it appears in the "Souvenir" tab of the Clues Window>
|text= <introductory souvenir text>


'''<story arc title>'''


<souvenir story arc recap text>
}}

Or:

{{Souvenir
|name=<name of the souvenir as it appears in the "Souvenir" tab of the Clues Window>
|intro=<introductory souvenir text>
|title=<story arc title>
|recap=<souvenir story arc recap text>
}}

In either case, the souvenir would be placed at the top of the Story Arc it belongs to (before all of the missions, directly under the name of the arc).

=== Souvenir ===
{{Souvenir
|name=<name of the souvenir as it appears in the "Souvenir" tab of the Clues Window>
|intro=<introductory souvenir text>
|title=<story arc title>
|recap=<souvenir story arc recap text>
}}

Missions

THIS SECTION CURRENTLY UNDER REVISION TO FIND A WAY TO REMOVE THE MISSION BRIEFING TEMPLATE FROM PRIMARY CONTACT BRIEFINGS/DEBRIEFINGS AND STILL MAINTAIN A FORMATTING STANDARD [1]

With changes in the Story Arc format, all missions would now be placed at the same level in the TOC, group by either arc, or as generic missions.

For each mission:

=== {{UL|<name of mission>}} ===
'''<name of story arc><br />Part:  <mission number in arc>'''


{{Mission Briefing
|Contact=<contact name>
|Brief=<briefing text before accepting mission>
|Accept=<briefing text after accepting mission>
|Solicit=<text for unnecessarily soliciting a contact between acceptance and completion of a mission>}}


{{Mission Objective
|Entrance=<introduction text in the box that pops up when you enter the mission>
|Primary=<primary mission objective>
|Secondary1=<first secondary mission objective>
|Secondary2=<second secondary mission objective>
|Secondary3=<third secondary mission objective>
|Secondary4=<fourth secondary mission objective>
|Additional1=<first objective added to your mission after an event, i.e. "Lead hostage to exit", "Find mission exit.">
|Additional2=<second objective added to your mission after an event>
|Additional3=<third objective added to your mission after an event>
|Completion=<text at mission completion - usually displays in the same font/tab as rewards text,
always shows as last line in mission info after mission completion>}}

The only thing I can think of here is maybe differentiating between successful and failed mission completion text. Maybe a separate parameter for the mission failed text?

|Completion=<text for succesful mission completion>
|Failure=<text for mission failure>

Also, add a parameter for any badges this mission offers

|Badge=<name of badge>

That parameter would then be used to generate a BadgeBox under the mission objectives.

Successful completion of this mission rewards you with the [[<badge article>]] accomplishment badge.
{{BadgeBox|<badge icon image>|<badge name>|<badge description text>}}

If there are interactions with other contacts during a mission (anything involving clicking on a contact and bringing up a new briefing window), add one of these for each:

{{Mission Briefing
|Contact=<contact name>
|Brief=<briefing text during interaction>}}

If the Primary objective changes during the mission for any reason and can't be easily covered by the "Additional" parameter of the objectives, add one of these each time:

{{Mission Objective
|Entrance=<introduction text in the box that pops up when you enter the mission>
|Primary=<primary mission objective>
|Secondary1=<first secondary mission objective>
|Secondary2=<second secondary mission objective>
|Secondary3=<third secondary mission objective>
|Secondary4=<fourth secondary mission objective>
|Additional1=<first objective added to your mission after an event, i.e. "Lead hostage to exit", "Find mission exit.">
|Additional2=<second objective added to your mission after an event>
|Additional3=<third objective added to your mission after an event>
|Completion=<text at mission completion>}}

List all of the unfriendly enemy groups that appear in the mission:

'''Enemies'''
{{Enemy <enemy group 1>}}
{{Enemy <enemy group 2>}}
{{Enemy <enemy group 3>}}

List notable NPCs (may include AVs, named bosses, hostages, anyone of interest in the mission):

'''Notable NPCs'''
*'''<notable NPC 1>''' ([[faction]], rank)
*'''[[<notable NPC 2>]]''' ([[faction]], rank)
*'''<named mob>''' ([[faction#unnamed mob|faction unnamed mob]], rank)
*'''<NPC hostage name>''' (NPC, hostage)

Now that we know the players involved, if there are any cutscenes that occur during the mission, place them here:

{{Cutscene|Text='''<NPC 1>:'''
:<NPC 1's first line of text>
:<NPC 1's second line of text>


'''<NPC 2>:'''
:<NPC 2's first line of text>
:<NPC 2's second line of text>


'''<NPC 1>:'''
:<NPC 1's third line of text>}}

Currently, several articles (including the ones I've worked on) include dialog associated with any of these NPCs under the name of the NPC. But this won't work in cases where two notable NPCs are bantering back and forth or a generic mob of no other particular interest has some interesting dialog. So, my suggestion is to add a section for dialog:

'''Notable Dialog'''


<NPC 1>:  ''<single line dialog text>''


<NPC 1>:  ''<first line of banter>''<br />
<NPC 2>:  ''<second line of banter>''<br />
<NPC 1>:  ''<third line of banter>''


<NPC 1>:  ''<first line dialog text>''<br />
<NPC 1>:  ''<second line dialog text>''<br />
<NPC 1>:  ''<third line dialog text>''

Notable Dialog should only include text that isn't part of a previous section (such as briefings or cutscenes).

Some missions will give you clues either during the mission or after the mission is complete. For each clue, insert a new Clue box:

{{Mission Clue
|Name=<name of clue (as it appears in the Clues Window)>
|Text=<text of the clue>}}

In some missions, a failure will give you a different clue than a successful completion. There's currently no set method (that I'm aware of) for showing this. Perhaps a second set of parameters for use in a failed mission:

|FailedName=<name of clue (as it appears in the Clues Window)>
|FailedText=<text of the clue>

These two parameters could be used to create a second Clue box with the failed clue name and clue text. The two boxes would specify either "Successful" or "Failed".

After the mission is complete and you either return to or call your contact, the debriefing text appears:

{{Mission Briefing
|Type=Debriefing
|Contact=<contact name>
|Debrief=<successful mission text>}}

Again, this currently only allows for successful mission completion text. This can be worked around.

{{Mission Briefing
|Contact=Dark Watcher
|Text=''(If Successful)'' <successful mission text>
''(If Failed)'' <failed mission text>}}

And then insert the next mission:

=== {{UL|<name of mission>}} ===
'''<name of story arc><br />Part:  <mission number in arc>'''
etc.

Side Missions

Very similar to each mission entry in the Story Arc missions, but since they aren't part of an arc, they're placed in a different section.

=== {{UL|<name of mission>}} ===
'''<name of story arc><br />Part:  <mission number in arc>'''


{{Mission Briefing
|Type=Briefing
|Contact=<contact name>
|Text=<briefing text before accepting mission>


<briefing text after accepting mission>}}


{{Mission Objective
|Entrance=<introduction text in the box that pops up when you enter the mission>
|Primary=<primary mission objective>
|Secondary1=<first secondary mission objective>
|Secondary2=<second secondary mission objective>
|Secondary3=<third secondary mission objective>
|Secondary4=<fourth secondary mission objective>
|Additional1=<first objective added to your mission after an event, i.e. "Lead hostage to exit", "Find mission exit.">
|Additional2=<second objective added to your mission after an event>
|Additional3=<third objective added to your mission after an event>
|Completion=<text at mission completion>}}


etc.

See Also

A section with links to any related articles.

== See Also ==
* [[Article 1]]
* [[Article 2]]
* [[Article 3]]

Character History

An uncommon section, but it does show up once in a while. Usually used for characters that have had details or backstory revealed in sources outside of the game such as comics or novels. This section is pretty freeform and may include pictures, text, additional references, etc.

If any of the information in this section might be considered a spoiler, these templates should be placed around the potential spoilers:

{{spoiler}}
{{endspoiler}}

Category

And, of course any category information that should be added to those generated automatically by templates should be placed at the end of the article.

Example Entry

And putting all of that together into one big, fat set of code:

 == Overview ==
 {{Contact Overview
 |name= <name of contact>
 |image= <contact image>
 |img_capt= <caption under image, usually the contact's title, taken from description>
 |zone= <name of the zone the contact is located in>
 |x= <x-coord>
 |y= <y-coord>
 |z= <z-coord>
 |levelmin= <minimum level>
 |levelmax= <maximum level>
 |introed= <link(s) to article(s) of contact(s) that introduce this contact>
 |intros= <link(s) to article(s) of contact(s) that this contact introduces>
 |enemies= <enemies; use {{Enemy <enemy name>}} for each enemy group>
 |badges=<any badges that are rewarded by this contact's missions, either linked to the mission that offers the badge
 (i.e. [[#Badge Mission Name|Badge Name]]), or linked to the badge using a template
 |city=<h, H, v, V, hv, or HV>
 |pronoun=<his, her, its, etc.>
 |hood=<neighborhood the contact is located in, if any>
 |origin=<origin of the contact, if any>
 }}
 

 __TOC__


== Introductions ==
=== Contact Introduced By===
*<link to contact that introduces this contact>
*<link to contact that introduces this contact>


=== New Contacts ===
*{{New Contact <NewContactName>}}
*{{New Contact <NewContactName>}}
*{{New Contact <NewContactName>}}


=== Information ===
'''<contact's Title shown in the "ask about this contact" information>'''


<text description from the "ask about this contact" information>


=== Initial Contact ===
<briefing text shown the first time you speak to this contact>


=== Below Level Requirement ===
<briefing text shown if you speak to this contact before reaching the contact's minimum required level>


=== Unfamiliar Contact ===
<briefing text shown if you speak to this contact before being introduced>


=== Too Busy ===
<briefing text shown if you speak to this contact with three task already in assigned missions>


== Store ==
== Store ==
* [[Inspirations]]
* {{Store <origin>|Level=<enhancement level>|Price=<price of enhancements as % of base price>}} {{P10Only}} <-if they only sell power 10s
* {{Store Nat Mag|Level=15|Price=150}}


== <story arc title> (Story Arc) ==
=== Souvenir ===
{{Souvenir
|name=<name of the souvenir as it appears in the "Souvenir" tab of the Clues Window>
|intro=<introductory souvenir text>
|title=<story arc title>
|recap=<souvenir story arc recap text>
}}


=== {{UL|<name of mission>}} ===
'''<name of story arc><br />Part:  <mission number in arc>'''


{{Mission Briefing
|Contact=<contact name>
|Brief=<briefing text before accepting mission>
|Accept=<briefing text after accepting mission>
|Solicit=<text for unnecessarily soliciting a contact between acceptance and completion of a mission>}}


<briefing text after accepting mission>}}


{{Mission Objective
|Entrance=<introduction text in the box that pops up when you enter the mission>
|Primary=<primary mission objective>
|Secondary1=<first secondary mission objective>
|Secondary2=<second secondary mission objective>
|Secondary3=<third secondary mission objective>
|Secondary4=<fourth secondary mission objective>
|Additional1=<first objective added to your mission after an event, i.e. "Lead hostage to exit", "Find mission exit.">
|Additional2=<second objective added to your mission after an event>
|Additional3=<third objective added to your mission after an event>
|Completion=<text for succesful mission completion>
|Failure=<text for mission failure>
|Badge=<badge name>


{{Mission Briefing
|Type=Briefing
|Contact=<2nd contact name>
|Text=<briefing text during interaction>}}


{{Mission Objective
|Entrance=<introduction text in the box that pops up when you enter the mission>
|Primary=<new primary mission objective>
|Secondary1=<first secondary mission objective>
|Secondary2=<second secondary mission objective>
|Secondary3=<third secondary mission objective>
|Secondary4=<fourth secondary mission objective>
|Additional1=<first objective added to your mission after an event, i.e. "Lead hostage to exit", "Find mission exit.">
|Additional2=<second objective added to your mission after an event>
|Additional3=<third objective added to your mission after an event>
|Completion=<text at mission completion>
|Failure=<text for mission failure>
|Badge=<badge name>}}


'''Enemies'''
{{Enemy <enemy group 1>}}
{{Enemy <enemy group 2>}}
{{Enemy <enemy group 3>}}


'''Notable NPCs'''
*'''<notable NPC 1>''' ([[faction]], rank)
*'''[[<notable NPC 2>]]''' ([[faction]], rank)
*'''<named mob>''' ([[faction#unnamed mob|faction unnamed mob]], rank)
*'''<NPC hostage name>''' (NPC, hostage)


{{Cutscene|Text='''<NPC 1>:'''
:<NPC 1's first line of text>
:<NPC 1's second line of text>


'''<NPC 2>:'''
:<NPC 2's first line of text>
:<NPC 2's second line of text>


'''<NPC 1>:'''
:<NPC 1's third line of text>}}


'''Notable Dialog'''


<NPC 1>:  ''<single line dialog text>''


<NPC 1>:  ''<first line of banter>''<br />
<NPC 2>:  ''<second line of banter>''<br />
<NPC 1>:  ''<third line of banter>''


<NPC 1>:  ''<first line dialog text>''<br />
<NPC 1>:  ''<second line dialog text>''<br />
<NPC 1>:  ''<third line dialog text>''


{{Mission Clue
|Name=<name of clue (as it appears in the Clues Window)>
|Text=<text of the clue>
|FailedName=<name of clue (as it appears in the Clues Window)>
|FailedText=<text of the clue>}}


{{Mission Briefing
|Contact=<contact name>
|Debrief=<successful mission text>
|FailedText=<failed mission text>}}


=== {{UL|<name of mission>}} ===
'''<name of story arc><br />Part:  <mission number in arc>'''
etc.


== Side Missions ==
=== {{UL|<name of mission>}} ===
'''<name of story arc><br />Part:  <mission number in arc>'''


{{Mission Briefing
|Contact=<contact name>
|Brief=<briefing text before accepting mission>
|Accept=<briefing text after accepting mission>
|Solicit=<text for unnecessarily soliciting a contact between acceptance and completion of a mission>}}


<briefing text after accepting mission>}}


{{Mission Objective
|Entrance=<introduction text in the box that pops up when you enter the mission>
|Primary=<primary mission objective>
|Secondary1=<first secondary mission objective>
|Secondary2=<second secondary mission objective>
|Secondary3=<third secondary mission objective>
|Secondary4=<fourth secondary mission objective>
|Additional1=<first objective added to your mission after an event, i.e. "Lead hostage to exit", "Find mission exit.">
|Additional2=<second objective added to your mission after an event>
|Additional3=<third objective added to your mission after an event>
|Completion=<text at mission completion>}}


etc.


== See Also ==
* [[Article 1]]
* [[Article 2]]
* [[Article 3]]


== Character History ==
{{spoiler}}
{{endspoiler}}


[[Category info]]