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

From FSDeveloper Wiki
Jump to navigationJump to search
m (Changed MSFS to MSFS2020 - Prep to differentiating between MSFS2020 and MSFS2024)
m (Updated Completed actions)
Line 25: Line 25:
provides ''at-a-glance'' indication of a page or category content's relevance to the various flight-simulator product versions.  
provides ''at-a-glance'' indication of a page or category content's relevance to the various flight-simulator product versions.  


Applicable Green background  
Applicable == Green background  
<br>
<br>
Not Applicable Red background  
Not Applicable == Red background  
 


''For demonstration purposes'' - This current page's ''Infobox-Applicable-FSVersion'' is set to ''FS2002'' and ''LM P3D2''.
''For demonstration purposes'' - This current page's ''Infobox-Applicable-FSVersion'' is set to ''FS2002'' and ''LM P3D2''.
Line 88: Line 87:
* ''Show Preview'' to check elements display as intended.
* ''Show Preview'' to check elements display as intended.
* ''Save Page'' to make your edits permanent.
* ''Save Page'' to make your edits permanent.


'''Do not delete any of the FS version ''categories'' '''.
'''Do not delete any of the FS version ''categories'' '''.
* P3D2, (LM P3D version 2) - Placeholder, is commented out within the the downstream template, it will be activated on ''LM P3D2'' release.
* FSXI, (MS Flight) - Placeholder, is commented out within the the downstream template, it will be activated on ''MS Flight'' release.
* XP10 - Placeholder, is commented out within the the downstream template, it will be activated on request by admin.
* XP9 - Placeholder, is commented out within the the downstream template, it will be activated on request by admin.


=== Editing an existing Infobox ===
=== Editing an existing Infobox ===
Line 108: Line 102:
* 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.
* Reworked - FSXI as MS Flight
* Added - XP10 & XP9 - If not required '''anywhere in the entire Wiki''', I will then comment these out within the source template.
* Added - XP9, XP10, XP11
* Added - LM P3D & LM P3D v2 - The latter is currently commented-out in the source template.
* 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.

Revision as of 16:57, 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 FS-Version's categories.
  • Automatic footer generation of FS-Version Categories: links.
  • Simple to place & edit.
  • Extensible to suport future FS-versions.
  • FSXA referenced as a seperate version, (~50 FSXA exclusive pages to be created).

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.

Do not delete any of the FS version categories .

Editing an existing Infobox

Earlier versions of the infobox 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.

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.
  • 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.