UTF8 functions review

Author: FileEX

functions/UTF8_Library/examples/utf8.byte-1.lua

@@ -2,5 +2,5 @@ local input = "Ницца!"
 local codepoints = { utf8.byte( input, 1, utf8.len(input) ) }
 
 for index, codepoint in ipairs( codepoints ) do
-    print( "Codepoint @ ".. index .." = ".. codepoint )
+    outputConsole( "Codepoint @ ".. index .." = ".. codepoint )
 end

functions/UTF8_Library/examples/utf8.insert-1.lua

@@ -1,11 +1,6 @@
-addCommandHandler("insert", 
-    function (player, command, word)
-        if word then
-            local output = utf8.insert( "hello ", word )
-            outputChatBox( output, player )
-            
-            local output = utf8.insert( "hello ", utf8.len( "hello " ) + 1, word )
-            outputChatBox( output, player )
-        end
-    end
-)
+local word = 'world'
+local output = utf8.insert('hello ', word)
+print(output) -- hello world
+
+local output2 = utf8.insert('hello ', utf8.len('hello ') + 1, word)
+print(output2) -- hello world

functions/UTF8_Library/examples/utf8.lower-1.lua

@@ -1,7 +1,7 @@
-for position, codepoint in utf8.next, "utf8-string" do
+for position, codepoint in utf8.next("utf8-string") do
     print( "Codepoint @ ".. position .." = ".. codepoint )
 end
 
-for position, codepoint in utf8.next, "Как" do
+for position, codepoint in utf8.next("Как") do
     print( "Codepoint @ ".. position .." = ".. codepoint )
 end

functions/UTF8_Library/examples/utf8.next-1.lua

@@ -1,10 +1,10 @@
 local input = "Happy Now"
 
 local output = utf8.sub( input, 1, 5 )
-outputChatBox( output, root, 255,255,255,true ) -- Happy
+outputChatBox( output ) -- Happy
 
 local output = utf8.sub( input, -3 )
-outputChatBox( output, root, 255,255,255,true ) -- Now
+outputChatBox( output ) -- Now
 
 local output = utf8.sub( input, -3, -1 )
-outputChatBox( output, root, 255,255,255,true ) -- Now
+outputChatBox( output ) -- Now

functions/UTF8_Library/examples/utf8.sub-2.lua

@@ -1,12 +1,11 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/Utf8.byte
 shared:
   name: utf8.byte
   description: Returns the codepoints for the i\-th through j\-th character of the
     string passed.
   parameters:
   - name: input
     type: string
-    description: A string character sequence
+    description: A string character sequence.
   - name: i
     type: int
     description: An integer representing the beginning position.
@@ -17,19 +16,27 @@ shared:
     default: '1'
   examples:
   - path: examples/utf8.byte-1.lua
-    description: This example will print every codepoint in the input string to the
-      server console.
-    side: server
+    description: |
+      This example will print every codepoint in the input string to the
+      console.
+
+      Output: 
+      <code>
+      Codepoint @ 1 = 1053
+      Codepoint @ 2 = 1080
+      Codepoint @ 3 = 1094
+      Codepoint @ 4 = 1094
+      Codepoint @ 5 = 1072
+      Codepoint @ 6 = 33
+      </code>
   - path: examples/utf8.byte-2.lua
     description: 'This example will print the codepoint of the first character (read:
       ''M'') in the string literal.'
-    side: client
   returns:
     values:
     - type: int
       name: value1
-    - type: '... utf8.byte'
-      name: value2
+    - type: '...'
+      name: values
     description: Returns a sequence of integer values from the original string if
       successful, nil otherwise.
-  requires_review: true

functions/UTF8_Library/examples/utf8.upper-1.lua

@@ -1,26 +1,21 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/Utf8.char
 shared:
   name: utf8.char
   description: Generates a string representing the character codepoints as arguments.
   parameters:
   - name: codepoints...
     type: int
-    description: MISSING_PARAM_DESC
+    description: An variable argument sequence of code points representing the desired unicode characters.
   examples:
   - path: examples/utf8.char-1.lua
     description: This example separates an input string into single codepoints and
       then joins these back together, representing the original input string.
-    side: server
   - path: examples/utf8.char-2.lua
     description: This example takes three code points to generate the string "MTA".
-    side: server
   - path: examples/utf8.char-3.lua
     description: This example takes the first five code points from the input string
       and then joins them back together.
-    side: client
   returns:
     values:
-    - type: string utf8.char
+    - type: string
       name: value
     description: Returns a string representation of the codepoints passed.
-  requires_review: true

functions/UTF8_Library/utf8.byte.yaml

@@ -1,15 +1,14 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/Utf8.charpos
 shared:
   name: utf8.charpos
   description: Converts the UTF\-8 codepoint position to byte\-string position.
   parameters:
   - name: input
     type: string
-    description: A string character sequence
-  - name: int charpos
-    type: '[,'
-    description: MISSING_PARAM_DESC
-    default: 0 ]
+    description: A string character sequence.
+  - name: charpos
+    type: int
+    description: An integer representing the beginning position (offset will be added/subtracted).
+    default: '0'
   - name: offset
     type: int
     description: An integer representing the offset to charpos.
@@ -18,22 +17,19 @@ shared:
   - path: examples/utf8.charpos-1.lua
     description: This example takes the second codepoint character and shows the byte-string
       position and the codepoint character code.
-    side: server
   - path: examples/utf8.charpos-2.lua
     description: This example extracts the first character by calculating the character
       length with the UTF8 functions and the inbuilt Lua function string.sub, which
       processes byte strings.
-    side: client
   returns:
     values:
     - type: int
       name: value1
-    - type: int utf8.charpos
+    - type: int
       name: value2
     description: Returns the integer position as in a byte string and the integer
       codepoint at this position, nil otherwise.
   notes:
   - type: info
     content: Code point characters beyond the byte value range (0-127) require at
-      least 2 bytes to represent the character
-  requires_review: true
+      least 2 bytes to represent the character.

functions/UTF8_Library/utf8.char.yaml

@@ -1,28 +1,19 @@
-# Scraped from: https://wiki.multitheftauto.com/wiki/Utf8.escape
 shared:
   name: utf8.escape
   description: Escapes a string to a UTF\-8 format string. It supports several escape
     formats, see the formatting table.
   parameters:
   - name: input
     type: string
-    description: A string character sequence
+    templateList: 'utf8Formatting'
+    description: A string character sequence.
   examples:
   - path: examples/utf8.escape-1.lua
     description: This example escapes two byte-string literals to UTF-8 format by
       using the utf8.escape function.
-    side: server
   returns:
     values:
-    - type: string utf8.escape
+    - type: string
       name: value
     description: Returns a string containing the escaped UTF-8 characters from the
-      original string.
-  meta:
-  - needs_checking: 'This function was partially migrated from the old wiki. Please
-      review manually:
-
-      - Missing section: Formatting
-
-      '
-  requires_review: true
+      original string.