Overview.html: Difference between revisions
m (→Resources: used the interlinking OFPEC instead of external link) |
m (Added text, rearranged the sections) |
||
| Line 4: | Line 4: | ||
The '''overview.html''' is an optional file. Optional simply means the game wont crash without it, but, it adds polish to your creative efforts. It appears on the notebook before you start a mission or campaign. When you click on a single mission or in campaign mode, on the right, you see an overview, which is mostly comprised of a picture and one or two lines of text. Alternatively, you could un-PBO an existing mission and use its '''overview.html''' as a template. | |||
The '''overview.html''' applies to: | The '''overview.html''' applies to: | ||
| Line 16: | Line 16: | ||
Version numbers and mission author details should really be kept to the ReadMe.txt file. | Version numbers and mission author details should really be kept to the ReadMe.txt file. | ||
==Anatomy of the overview.html== | |||
<html><br> | |||
<head><title>Overview or anything you like or nothing at all</title></head><br> | |||
<body><br> | |||
< h2 align="center">YOUR WAR< /h2><br> | |||
< p align="center"><img src="Apicture.jpg" width="230" height="170"></p><br> | |||
< p>a single sentence description< /p><br> | |||
< p>another sentence if you must< /p><br> | |||
</body><br> | |||
</html><br> | |||
The three displayed 'elements' of this html are | |||
* A centred title | |||
* A centered picture | |||
* One or more sentence descriptions | |||
Alter colored content to whatever you desire. | |||
===Centered Title=== | |||
<u>CAMPAIGN ONLY</u> Do not use this for missions | |||
Using this in missions has no ill effect. It is however, tautology. The same or similar 'title' is already displayed as part of the mission content and you are losing valuable space to repeat the same thing. '''Note''' that the h2 designators pretty it up into a bold font. | |||
'''Note:''' Other document sources indicate this should be a header tag "''Main''". They never discuss it in the context of campaign overviews, only 'missions'. It is completely unnecessary and will bugger up picture positioning if you use it. | |||
===Default Title=== | |||
Centered, '''default titles''' occur unconditionally for all missions. They do not appear for campaign overviews. | |||
The title of this overview (not the html <title> above, the name of the mission this overview represents) comes from one, of two sources. | |||
* The filename of the mission folder will be displayed. Eg Apples.Pbo.Cain OR | |||
* The breifingName= contained in the mission.sqm of the mission folder thusly | |||
class Intel | |||
{ | |||
breifingName= "One Big Pineapple"; | |||
It would be rare for you to want the mission filename to be displayed. In order to work 'correctly' ; | |||
* the breifingName= must exist | |||
* the breifingName= must be different to the filename. | |||
There is a "bug" in ofp, in that if the briefing name is identical to the primary name of the mission folder the mission folder is displayed. | |||
'''Example:''' folder name apples.cain (or apples.pbo.cain) | |||
breifingName="apples" : results in the briefing name effectively being ignored. For this reason, you will often see | |||
breifingName="apples " : (a space is added to force correct display) | |||
Or, the name of the folder containing the mission has underlines or some other 'device' to make it 'different'. | |||
'''Note:''' Filename title is also displayed as a diagnostic aid if you use cheat sequence -campaign. | |||
| Line 33: | Line 96: | ||
< p align="center" > | < p align="center" > | ||
==Resources== | |||
[http://www.flashpoint1985.com/index2.html BI] has a few tools to get you started. | [http://www.flashpoint1985.com/index2.html BI] has a few tools to get you started. | ||
[[OFPEC]] hosts a variety of tutorials on building a better briefing. | [[OFPEC]] hosts a variety of tutorials on building a better briefing. | ||
Revision as of 19:29, 3 June 2006
Introduction
The overview.html is an optional file. Optional simply means the game wont crash without it, but, it adds polish to your creative efforts. It appears on the notebook before you start a mission or campaign. When you click on a single mission or in campaign mode, on the right, you see an overview, which is mostly comprised of a picture and one or two lines of text. Alternatively, you could un-PBO an existing mission and use its overview.html as a template.
The overview.html applies to:
* single missions, * a campaign, and * individual missions of a campaign.
The overview of a mission within a campaign is not visible until after you have played that mission. The intent of all overviews is to simply provide a brief 'idea' of what the campaign/mission is. The keyword is brief, because real estate on that notepad is at a premium.
Version numbers and mission author details should really be kept to the ReadMe.txt file.
Anatomy of the overview.html
<html>
<head><title>Overview or anything you like or nothing at all</title></head>
<body>
< h2 align="center">YOUR WAR< /h2>
< p align="center"><img src="Apicture.jpg" width="230" height="170">
< p>a single sentence description< /p>
< p>another sentence if you must< /p>
</body>
</html>
The three displayed 'elements' of this html are
- A centred title
- A centered picture
- One or more sentence descriptions
Alter colored content to whatever you desire.
Centered Title
CAMPAIGN ONLY Do not use this for missions
Using this in missions has no ill effect. It is however, tautology. The same or similar 'title' is already displayed as part of the mission content and you are losing valuable space to repeat the same thing. Note that the h2 designators pretty it up into a bold font.
Note: Other document sources indicate this should be a header tag "Main". They never discuss it in the context of campaign overviews, only 'missions'. It is completely unnecessary and will bugger up picture positioning if you use it.
Default Title
Centered, default titles occur unconditionally for all missions. They do not appear for campaign overviews.
The title of this overview (not the html <title> above, the name of the mission this overview represents) comes from one, of two sources.
- The filename of the mission folder will be displayed. Eg Apples.Pbo.Cain OR
- The breifingName= contained in the mission.sqm of the mission folder thusly
class Intel
{
breifingName= "One Big Pineapple";
It would be rare for you to want the mission filename to be displayed. In order to work 'correctly' ;
- the breifingName= must exist
- the breifingName= must be different to the filename.
There is a "bug" in ofp, in that if the briefing name is identical to the primary name of the mission folder the mission folder is displayed.
Example: folder name apples.cain (or apples.pbo.cain)
breifingName="apples" : results in the briefing name effectively being ignored. For this reason, you will often see
breifingName="apples " : (a space is added to force correct display)
Or, the name of the folder containing the mission has underlines or some other 'device' to make it 'different'.
Note: Filename title is also displayed as a diagnostic aid if you use cheat sequence -campaign.
Pictures
Many people have trouble creating a good overview picture. Pictures must be in the following sizes keep in mind that very large pictures will not fit on the page.
64x64 128x128 256x256 512x512 1024x1024
Many simple html tags will work in the briefing.html or overview.html. For an added touch of professionalism, centre your text by adding the following above your main body of description.
< p align="center" >
Resources
BI has a few tools to get you started.
OFPEC hosts a variety of tutorials on building a better briefing.