Template:Infobox-Applicable-FSVersion/doc: Difference between revisions

From FSDeveloper Wiki
Jump to navigationJump to search
m (Updated Completed actions)
 
(21 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{:Ambox-Wiki-Editors}}
{{:Ambox-Wiki-Editors}}
{{Infobox-Applicable-FSVersion
{{Infobox-Applicable-FSVersion
| FSXI = false
| MSFS2024 = unknown
| FSXA = false
| MSFS2020 = unknown
| FSX = false
| FSXI = unknown
| FS2004 = false
| P3D5 = unknown
| P3D4 = unknown
| P3D3 = unknown
| P3D2 = true
| P3D = unknown
| FSW = unknown
| FSXSE = unknown
| FSXA = unknown
| FSX = unknown
| FS2004 = unknown
| FS2002 = true
| FS2002 = true
| XP10 = false
| XP11 = unknown
| XP9 = false
| XP10 = unknown
| XP9 = unknown
 
}}
}}
FS version applicability indicator for ''at-a-glance'' page content relevance.
The ''Infobox-Applicable-FSVersion'', (small box containing links, to right of this text),
<br>
provides ''at-a-glance'' indication of a page or category content's relevance to the various flight-simulator product versions.  


This page is listed in the wiki's ''FS2002 category'', as the ''Infobox-Applicable-FSVersion'' is set to ''FS2002''.
Applicable == Green background
<br>
<br>
It needed to be set to something as a demo.
Not Applicable == Red background
 
''For demonstration purposes'' - This current page's ''Infobox-Applicable-FSVersion'' is set to ''FS2002'' and ''LM P3D2''.
 
== Purpose ==
== Purpose ==
Many wiki pages contained -
Many wiki pages contained -
* No information relevant to current or recent FS versions.
* No information relevant to current or recent FS versions.
* No mention as to what version they applied to.
* No mention as to which FS version they applied to.
* No footer category version listing.
* No footer category FS-version listing.
 


The '''Applicable''' version infobox offers -
The '''Applicable FS-Version" infobox provides -
* Instant recognition.
* Instant recognition.
* Common reference point.
* Common reference point.
* Direct links to categories.
* Direct links to an FS-Version's relevant information.
* Automatic footer ''Categories:'' generation.
* Automatic footer generation of FS-Version ''Categories:'' links.
* Simple to place & edit.
* Simple to place & edit.
* Support for future versions.
* Extensible to suport future FS-versions.
* FSXA referenced as a seperate version, (~50 FSXA exclusive pages to be created).
 
<!--
== Usage ==
HIDE -
The box should be present on every page, (article or category).
template
 
applicable entries.
=== Positioning ===
applicability
The box should be positioned at the top of the page.
on the right-hand margin,
is to be placed at the top of '''all FS pages'''.
{{Infobox-Applicable-FSVersion
| FSXI = false
| FSXA = false
| FSX = false
| FS2004 = false
| FS2002 = false
| FS2000 = unknown
| FS98 = unknown
}}
<br>


Infobox-Applicable-FSVersion.
The box automatically aligns itself with the right-hand margin.
-->


== Useage ==
=== Installation ===
* Copy the following code.
* Copy the following code to your clipboard.
<pre>
<pre>
{{Infobox-Applicable-FSVersion
{{Infobox-Applicable-FSVersion
| FSXI = false
| MSFS2024 = unknown
| FSXA = false
| MSFS2020 = unknown
| FSX = false
| FSXI = unknown
| FS2004 = false
| P3D5 = unknown
| FS2002 = false
| P3D4 = unknown
| XP10 = false
| P3D3 = unknown
| XP9 = false
| P3D2 = unknown
| P3D = unknown
| FSW = unknown
| FSXSE = unknown
| FSXA = unknown
| FSX = unknown
| FS2004 = unknown
| FS2002 = unknown
| XP11 = unknown
| XP10 = unknown
| XP9 = unknown
 
}}
}}
</pre>
</pre>
* Paste into at the start of the top line of the page.
 
* Set the version applicability to '''true''', '''false''', or '''unknown''', (case insensitive).
* Open the target page for insertion.
* '''Do not delete any of the FS version ''categories'' '''.
* Click the page's EDIT tab.
* FSXI, (MS Flight) - Placeholder, is commented out within the the downstream template, it will be activated on MS Flight release.
* Position the cursor in the top of the page's EDIT BOX, (before any text).
* Paste the code into the top line of the page.
* Edit the version applicability from '''unknown''', to '''true''' or '''false''', (case insensitive).
* ''Show Preview'' to check elements display as intended.
* ''Save Page'' to make your edits permanent.
 
=== Editing an existing Infobox ===
Some older pages contain earlier versions of the infobox which do not include all the FS-Versions.
 
To update an infobox to provide full FS-Version coverage,
<br>
copy & paste the required lines into the infobox.
 
Or replace entirely, then edit accordingly.
 
'''Do not delete any of the FS version ''categories'' '''.


== Development ==
== Development ==
Line 72: Line 103:
* Added link to this page.
* Added link to this page.
* Modified the <nowiki><div></nowiki> code to align it with top edge, (was displaced by 1em).
* Modified the <nowiki><div></nowiki> code to align it with top edge, (was displaced by 1em).
* Automatically generates the matching FS version '''Categories:''' footer entries.
* Automatically inserts the matching FS version '''Categories:''' into page footer entries.
* Removed - FS2000 & FS98 - If not required '''anywhere in the entire Wiki''', I will then comment these out within the source template.
* Removed - FS2000 & FS98 - If not required '''anywhere in the entire Wiki''', I will then comment these out within the source template.
* Reworked - FSXI as MS Flight - Currently commented out within the source template.
* FSXA referenced as a seperate version.
* Added - XP10 & XP9 - If not required '''anywhere in the entire Wiki''', I will then comment these out within the source template.
* Reworked - FSXI as MS Flight
* Added - XP9, XP10, XP11
* Added - LM P3D through LM P3D v5
* Added - MSFS specific category
* Replaced - MSFS with MSFS2020, to differentiate from MSFS2024, (updated entries on every ARTICLE and CATEGORY where MSFS = true)
* Added - MSFS2024 specific category


=== ToDo ===
=== ToDo ===
* Add category generation suppression option for pages like this.
* Add category generation suppression option for pages like this.
* Not sure if this is an issue - Modify <nowiki><div></nowiki> so that ''boxes'' for <nowiki><code></nowiki> and <nowiki><pre></nowiki> display correctly.
* Not sure if this is an issue - Modify <nowiki><div></nowiki> so that ''boxes'' for <nowiki><code></nowiki> and <nowiki><pre></nowiki> display correctly.
=== Test Code ===
Test - {{lc:Convert UPPER to all LoWeR}}

Latest revision as of 17:09, 25 May 2024

The Infobox-Applicable-FSVersion, (small box containing links, to right of this text),
provides at-a-glance indication of a page or category content's relevance to the various flight-simulator product versions.

Applicable == Green background
Not Applicable == Red background

For demonstration purposes - This current page's Infobox-Applicable-FSVersion is set to FS2002 and LM P3D2.

Purpose

Many wiki pages contained -

  • No information relevant to current or recent FS versions.
  • No mention as to which FS version they applied to.
  • No footer category FS-version listing.


The Applicable FS-Version" infobox provides -

  • Instant recognition.
  • Common reference point.
  • Direct links to an FS-Version's relevant information.
  • Automatic footer generation of FS-Version Categories: links.
  • Simple to place & edit.
  • Extensible to suport future FS-versions.

Usage

The box should be present on every page, (article or category).

Positioning

The box should be positioned at the top of the page.

The box automatically aligns itself with the right-hand margin.

Installation

  • Copy the following code to your clipboard.
{{Infobox-Applicable-FSVersion
| MSFS2024 = unknown
| MSFS2020 = unknown
| FSXI = unknown
| P3D5 = unknown
| P3D4 = unknown
| P3D3 = unknown
| P3D2 = unknown
| P3D = unknown
| FSW = unknown
| FSXSE = unknown
| FSXA = unknown
| FSX = unknown
| FS2004 = unknown
| FS2002 = unknown
| XP11 = unknown
| XP10 = unknown
| XP9 = unknown

}}
  • Open the target page for insertion.
  • Click the page's EDIT tab.
  • Position the cursor in the top of the page's EDIT BOX, (before any text).
  • Paste the code into the top line of the page.
  • Edit the version applicability from unknown, to true or false, (case insensitive).
  • Show Preview to check elements display as intended.
  • Save Page to make your edits permanent.

Editing an existing Infobox

Some older pages contain earlier versions of the infobox which do not include all the FS-Versions.

To update an infobox to provide full FS-Version coverage,
copy & paste the required lines into the infobox.

Or replace entirely, then edit accordingly.

Do not delete any of the FS version categories .

Development

Completed

  • Added links to FS version category pages.
  • Added link to this page.
  • Modified the <div> code to align it with top edge, (was displaced by 1em).
  • Automatically inserts the matching FS version Categories: into page footer entries.
  • Removed - FS2000 & FS98 - If not required anywhere in the entire Wiki, I will then comment these out within the source template.
  • FSXA referenced as a seperate version.
  • Reworked - FSXI as MS Flight
  • Added - XP9, XP10, XP11
  • Added - LM P3D through LM P3D v5
  • Added - MSFS specific category
  • Replaced - MSFS with MSFS2020, to differentiate from MSFS2024, (updated entries on every ARTICLE and CATEGORY where MSFS = true)
  • Added - MSFS2024 specific category

ToDo

  • Add category generation suppression option for pages like this.
  • Not sure if this is an issue - Modify <div> so that boxes for <code> and <pre> display correctly.
Retrieved from ‘http://www.fsdeveloper.com/wiki/index.php?title=Template:Infobox-Applicable-FSVersion/doc&oldid=11978’