Single-quoted all examples.

2026-07-27 14:16:01 -07:00 · 2013-10-27 20:03:09 +00:00
parent ec8caebeb1
commit adc58ab14d
1 changed files with 43 additions and 43 deletions
@@ -128,22 +128,22 @@ h3{
 <p>Other keys may also be present, but are not processed by BOSS. The message and plugin data structures are detailed in the next section.
 <p>An example metadata file:
 <code class="box">globals:
-  - type: say
-    content: You are using the latest version of BOSS.
+  - type: 'say'
+    content: 'You are using the latest version of BOSS.'
    condition: 'version("BOSS", "3.0.0.0", ==)'
 plugins:
-  - name: Armamentarium.esm
+  - name: 'Armamentarium.esm'
    tag:
-      - Relev
-  - name: ArmamentariumFran.esm
+      - 'Relev'
+  - name: 'ArmamentariumFran.esm'
    tag:
-      - Relev
+      - 'Relev'
  - name: 'Beautiful People 2ch-Ed.esm'
    tag:
-      - Eyes
-      - Graphics
-      - Hair
-      - R.Relations
+      - 'Eyes'
+      - 'Graphics'
+      - 'Hair'
+      - 'R.Relations'
 </code>


@@ -163,10 +163,10 @@ plugins:
        <tr><td><code>condition</code><td>&#x2717;<td>A condition string that is evaluated to determine whether this Bash Tag should be suggested: if it evaluates to true, the Tag is suggested, otherwise it is ignored. See <a href="#cond">Condition Strings</a> for details.
 </table>
 <p>Examples:
-<code class="box">Relations</code>
+<code class="box">'Relations'</code>
 or
-<code class="box">name: -Relations
-condition: "file(\"Mart's Monster Mod for OOO.esm\") or file(\"FCOM_Convergence.esm\")"
+<code class="box">name: '-Relations'
+condition: 'file("Mart''s Monster Mod for OOO.esm") or file("FCOM_Convergence.esm")'
 </code>

 <h3 id="structs-file">File Data Structure</h3>
@@ -184,11 +184,11 @@ condition: "file(\"Mart's Monster Mod for OOO.esm\") or file(\"FCOM_Convergence.
 </table>

 <p>Examples:
-<code class="box">../obse_loader.exe</code>
+<code class="box">'../obse_loader.exe'</code>
 or
-<code class="box">name: ../obse_loader.exe
+<code class="box">name: '../obse_loader.exe'
 condition: 'version("../obse_loader.exe", "0.0.18.0", &gt;=)'
-display: OBSE v18+
+display: 'OBSE v18+'
 </code>

 <h3 id="structs-message">Message Data Structure</h3>
@@ -225,14 +225,14 @@ display: OBSE v18+


 <p>Examples (translations by Google):
-<code class="box">type: say
-condition: file("foo.esp")
+<code class="box">type: 'say'
+condition: 'file("foo.esp")'
 content:
-  - lang: eng
+  - lang: 'eng'
    str: 'An example link: http://www.example.com'
-  - lang: rus
+  - lang: 'rus'
    str: 'Это пример ссылки: http://www.example.com'
-  - lang: ger
+  - lang: 'ger'
    str: 'Ein Beispiel-Link: http://www.example.com'
 </code>
 would be displayed as
@@ -240,8 +240,8 @@ would be displayed as
 отмечать: Это пример ссылки: <a href="http://www.example.com">http://www.example.com</a>
 </blockquote>
 if the current language was Russian and <code>foo.esp</code> was installed, while
-<code class="box">type: say
-content: An alternative "http://www.example.com example link", with no translations.
+<code class="box">type: 'say'
+content: 'An alternative "http://www.example.com example link", with no translations.'
 </code>
 would be displayed as
 <blockquote>
@@ -263,11 +263,11 @@ would be displayed as
        <tr><td><code>ver</code><td>string list<td>&#x2713;<td>A list of versions that can be found at the URL.
 </table>
 <p>Examples:
-<code class="box">http://skyrim.nexusmods.com/mods/19/</code>
+<code class="box">'http://skyrim.nexusmods.com/mods/19/'</code>
 or
-<code class="box">link: http://steamcommunity.com/sharedfiles/filedetails/?id=87144366
+<code class="box">link: 'http://steamcommunity.com/sharedfiles/filedetails/?id=87144366'
 ver:
-  - 1.3.2c
+  - '1.3.2c'
 </code>

 <h3 id="structs-dirty">Dirty Info Data Structure</h3>
@@ -283,7 +283,7 @@ ver:
 </table>
 <p>Examples:
 <code class="box">crc: 0x3DF62AB
-util: "http://www.creationkit.com/TES5Edit_Cleaning_Guide_-_TES5Edit TES5Edit"
+util: '"http://www.creationkit.com/TES5Edit_Cleaning_Guide_-_TES5Edit TES5Edit"'
 itm: 4
 udr: 160
 nav: 0
@@ -307,23 +307,23 @@ nav: 0
        <tr><td><code>dirty</code><td>dirty info list<td>&#x2717;<td>An unordered list of dirty info structures for this plugin.
 </table>
 <p>Example:
-<code class="box">name: "Oscuro's_Oblivion_Overhaul.esm"
+<code class="box">name: 'Oscuro''s_Oblivion_Overhaul.esm'
 req:
-  - Oblivion.esm  # Don't do this, Oblivion.esm is a master of Oscuro's_Oblivion_Overhaul.esm, so BOSS already knows it's required.
-  - name: example.esp
-    display: "http://www.example.com Example Mod"
-    condition: "version(\"Oscuro's_Oblivion_Overhaul.esm\", \"15.0\", ==)"
+  - 'Oblivion.esm'  # Don't do this, Oblivion.esm is a master of Oscuro's_Oblivion_Overhaul.esm, so BOSS already knows it's required.
+  - name: 'example.esp'
+    display: '"http://www.example.com Example Mod"'
+    condition: 'version("Oscuro''s_Oblivion_Overhaul.esm", "15.0", ==)'
 tag:
-  - Actors.Spells
-  - Graphics
-  - Invent
-  - Relations
-  - Scripts
-  - Stats
-  - name: -Relations
-    condition: "file(\"Mart's Monster Mod for OOO.esm\") or file(\"FCOM_Convergence.esm\")"
+  - 'Actors.Spells'
+  - 'Graphics'
+  - 'Invent'
+  - 'Relations'
+  - 'Scripts'
+  - 'Stats'
+  - name: '-Relations'
+    condition: 'file("Mart''s Monster Mod for OOO.esm") or file("FCOM_Convergence.esm")'
 msg:
-  - type: say
+  - type: 'say'
    content: 'Do not clean. "Dirty" edits are intentional and required for the mod to function.'
 </code>

@@ -332,11 +332,11 @@ msg:
 <p>File <code>display</code> strings and message <code>content</code> strings (including the strings in localised content structures) that contain recognised URLs have them displayed as hyperlinks in the BOSS report. Recognised URLs are those that are enclosed in double quotes and that begin with <code>file:</code>, <code>http:</code> or <code>https:</code>.
 <p>Hyperlinks may be labelled by writing the label after the URL inside the double quotes, with a space separating the label and URL. If a label is not provided, then the hyperlink will use the URL as its own label.
 <p>Examples:
-<code class="box">"This \"https://en.wikipedia.org/wiki/String_(computer_science) string\" contains a labelled hyperlink."</code>
+<code class="box">'This "https://en.wikipedia.org/wiki/String_(computer_science) string" contains a labelled hyperlink.'</code>
 would be displayed as
 <blockquote>This <a href="https://en.wikipedia.org/wiki/String_(computer_science)">string</a> contains a labelled hyperlink.</code></blockquote>
 <p>While
-<code class="box">"This string (see: \"https://en.wikipedia.org/wiki/String_(computer_science)\") contains an unlabelled hyperlink."</code>
+<code class="box">'This string (see: "https://en.wikipedia.org/wiki/String_(computer_science)") contains an unlabelled hyperlink.'</code>
 both get displayed as
 <blockquote>This string (see: <a href="https://en.wikipedia.org/wiki/String_(computer_science)">https://en.wikipedia.org/wiki/String_(computer_science)</a>) contains an unlabelled hyperlink.</code></blockquote>