Merge pull request 'hotfix/v8.3.2' (#63) from hotfix/v8.3.2 into release/v9.0.0

Reviewed-on: https://git.onlyoffice.com/ONLYOFFICE/build_tools/pulls/63

scripts/base.py

@@ -428,6 +428,13 @@ def cmd_in_dir(directory, prog, args=[], is_no_errors=False):
   os.chdir(cur_dir)
   return ret
 
+def cmd_in_dir_qemu(platform, directory, prog, args=[], is_no_errors=False):
+  if (platform == "linux_arm64"):
+    return cmd_in_dir(directory, "qemu-aarch64", ["-L", "/usr/aarch64-linux-gnu", prog] + args, is_no_errors)
+  if (platform == "linux_arm32"):
+    return cmd_in_dir(directory, "qemu-arm", ["-L", "/usr/arm-linux-gnueabi", prog] + args, is_no_errors)
+  return 0
+
 def cmd_and_return_cwd(prog, args=[], is_no_errors=False):
   cur_dir = os.getcwd()
   ret = cmd(prog, args, is_no_errors)
@@ -1831,10 +1838,14 @@ def get_autobuild_version(product, platform="", branch="", build=""):
   download_addon = download_branch + "/" + download_build + "/" + product + "-" + download_platform + ".7z"
   return "http://repo-doc-onlyoffice-com.s3.amazonaws.com/archive/" + download_addon
 
-def create_x2t_js_cache(dir, product):
+def create_x2t_js_cache(dir, product, platform):
   if is_file(dir + "/libdoctrenderer.dylib") and (os.path.getsize(dir + "/libdoctrenderer.dylib") < 5*1024*1024):
     return
 
+  if ((platform == "linux_arm64") and not is_os_arm()):
+    cmd_in_dir_qemu(platform, dir, "./x2t", ["-create-js-snapshots"], True)
+    return
+
   cmd_in_dir(dir, "./x2t", ["-create-js-snapshots"], True)
   return
 

scripts/core_common/modules/v8_89.py

@@ -23,6 +23,9 @@ def change_bootstrap():
 
   base.replaceInFile("./depot_tools/bootstrap/bootstrap.py", 
     "raise subprocess.CalledProcessError(proc.returncode, argv, None)", "return")
+
+  base.replaceInFile("./depot_tools/bootstrap/bootstrap.py", 
+    "    _win_git_bootstrap_config()", "    #_win_git_bootstrap_config()")
   
   base.writeFile("./depot_tools/bootstrap/manifest.txt", content)
   return

scripts/deploy_builder.py

@@ -125,7 +125,7 @@ def make():
       base.mac_correct_rpath_x2t(root_dir)
       base.mac_correct_rpath_docbuilder(root_dir)
 
-    base.create_x2t_js_cache(root_dir, "builder")
+    base.create_x2t_js_cache(root_dir, "builder", platform)
   
     # delete unnecessary builder files
     def delete_files(files):
@@ -138,6 +138,11 @@ def make():
     if 0 != platform.find("mac"):
       delete_files(base.find_files(root_dir, "sdk-all.js"))
       delete_files(base.find_files(root_dir, "sdk-all-min.js"))
+    base.delete_dir(root_dir + "/sdkjs/slide/themes")
+    base.delete_dir(root_dir + "/sdkjs/cell/css")
+    base.delete_file(root_dir + "/sdkjs/pdf/src/engine/viewer.js")
+    base.delete_file(root_dir + "/sdkjs/common/spell/spell/spell.js.mem")
+    base.delete_dir(root_dir + "/sdkjs/common/Images")   
 
   return
 

scripts/deploy_core.py

@@ -67,7 +67,7 @@ def make():
 
     # js cache
     base.generate_doctrenderer_config(archive_dir + "/DoctRenderer.config", "./", "builder", "", "./dictionaries")
-    base.create_x2t_js_cache(archive_dir, "core")
+    base.create_x2t_js_cache(archive_dir, "core", platform)
     base.delete_file(archive_dir + "/DoctRenderer.config")
 
     # dictionaries

scripts/deploy_desktop.py

@@ -184,6 +184,7 @@ def make():
         base.copy_file(git_dir + "/desktop-apps/win-linux/extras/projicons/" + apps_postfix + "/projicons.exe", root_dir + "/DesktopEditors.exe")
         if not isWindowsXP:
           base.copy_file(git_dir + "/desktop-apps/win-linux/extras/update-daemon/" + apps_postfix + "/updatesvc.exe", root_dir + "/updatesvc.exe")
+        else:
           base.copy_file(git_dir + "/desktop-apps/win-linux/extras/online-installer/" + apps_postfix + "/online-installer.exe", root_dir + "/online-installer.exe")
         base.copy_file(git_dir + "/desktop-apps/win-linux/" + apps_postfix + "/DesktopEditors.exe", root_dir + "/editors.exe")
         base.copy_file(git_dir + "/desktop-apps/win-linux/res/icons/desktopeditors.ico", root_dir + "/app.ico")
@@ -261,7 +262,7 @@ def make():
     if isUseJSC:
       base.delete_file(root_dir + "/converter/icudtl.dat")
 
-    base.create_x2t_js_cache(root_dir + "/converter", "desktop")
+    base.create_x2t_js_cache(root_dir + "/converter", "desktop", platform)
 
     if (0 == platform.find("win")):
       base.delete_file(root_dir + "/cef_sandbox.lib")

scripts/deploy_server.py

@@ -119,7 +119,7 @@ def make():
               + glob.glob(js_dir + "/web-apps/apps/*/mobile/dist/js/*.js.map"):
       base.delete_file(file)
 
-    base.create_x2t_js_cache(converter_dir, "server")
+    base.create_x2t_js_cache(converter_dir, "server", platform)
 
     # add embed worker code
     base.cmd_in_dir(git_dir + "/sdkjs/common/embed", "python", ["make.py", js_dir + "/web-apps/apps/api/documents/api.js"])

scripts/package_desktop.py

@@ -178,7 +178,7 @@ def make_advinst():
   return
 
 def make_online():
-  if not common.platform in ["windows_x64", "windows_x86"]:
+  if not common.platform in ["windows_x86_xp"]:
     return
   online_file = "%s-%s-%s.exe" % ("OnlineInstaller", package_version, suffix)
   ret = utils.is_file(online_file)

scripts/sdkjs_common/jsdoc/generate_docs_md.py

@@ -6,14 +6,17 @@ import argparse
 import generate_docs_json
 
 # Configuration files
-editors = [
-    "word",
-    "cell",
-    "slide",
-    "forms"
-]
+editors = {
+    "word": "text-document-api",
+    "cell": "spreadsheet-api",
+    "slide": "presentation-api",
+    "forms": "form-api"
+}
 
 missing_examples = []
+used_enumerations = set()
+
+cur_editor_name = None
 
 def load_json(file_path):
     with open(file_path, 'r', encoding='utf-8') as f:
@@ -28,31 +31,84 @@ def remove_js_comments(text):
     text = re.sub(r'/\*.*?\*/', '', text, flags=re.DOTALL)     # multi-line
     return text.strip()
 
-def correct_description(string):
+def process_link_tags(text, root=''):
     """
-    Cleans up or transforms certain tags in a doclet description:
-      - <b> => **
+    Finds patterns like {@link ...} and replaces them with Markdown links.
+    If the prefix 'global#' is found, a link to a typedef is generated,
+    otherwise, a link to a class method is created.
+    For a method, if an alias is not specified, the name is left in the format 'Class#Method'.
+    """
+    reserved_links = {
+        '/docbuilder/global#ShapeType': f"{'../../../' if root == '' else '../../' if root == '../' else root}text-document-api/Enumeration/ShapeType.md",
+        '/plugin/config': 'https://api.onlyoffice.com/docs/plugin-and-macros/structure/manifest/',
+        '/docbuilder/basic': 'https://api.onlyoffice.com/docs/office-api/usage-api/text-document-api/'
+    }
+
+    def replace_link(match):
+        content = match.group(1).strip()  # Example: "/docbuilder/global#ShapeType shape type" or "global#ErrorValue ErrorValue"
+        parts = content.split()
+        ref = parts[0]
+        label = parts[1] if len(parts) > 1 else None
+
+        if ref.startswith('/'):
+            # Handle reserved links using mapping
+            if ref in reserved_links:
+                url = reserved_links[ref]
+                display_text = label if label else ref
+                return f"[{display_text}]({url})"
+            else:
+                # If the link is not in the mapping, return the original construction
+                return match.group(0)
+        elif ref.startswith("global#"):
+            # Handle links to typedef (similar logic as before)
+            typedef_name = ref.split("#")[1]
+            used_enumerations.add(typedef_name)
+            display_text = label if label else typedef_name
+            return f"[{display_text}]({root}Enumeration/{typedef_name}.md)"
+        else:
+            # Handle links to class methods like ClassName#MethodName
+            try:
+                class_name, method_name = ref.split("#")
+            except ValueError:
+                return match.group(0)
+            display_text = label if label else ref  # Keep the full notation, e.g., "Api#CreateSlide"
+            return f"[{display_text}]({root}{class_name}/Methods/{method_name}.md)"
+
+    return re.sub(r'{@link\s+([^}]+)}', replace_link, text)
+
+def correct_description(string, root=''):
+    """
+    Cleans or transforms specific tags in the doclet description:
+      - <b> => ** (bold text)
       - <note>...</note> => 💡 ...
-      - Provide a default if None.
+      - {@link ...} is replaced with a Markdown link
+      - If the description is missing, returns a default value.
+      - All '\r' characters are replaced with '\n'.
     """
     if string is None:
         return 'No description provided.'
+
+    # Line breaks
+    string = string.replace('\r', '\\\n')
     
-    # Replace <b> tags with markdown bold
-    string = re.sub(r'<b>', '**', string)
+    # Replace <b> tags with Markdown bold formatting
+    string = re.sub(r'<b>', '-**', string)
     string = re.sub(r'</b>', '**', string)
-    # Convert <note>...</note> to a little icon + text
+    
+    # Replace <note> tags with an icon and text
     string = re.sub(r'<note>(.*?)</note>', r'💡 \1', string, flags=re.DOTALL)
+    
+    # Process {@link ...} constructions
+    string = process_link_tags(string, root)
+    
     return string
 
 def correct_default_value(value, enumerations, classes):
-    if value is None:
+    if value is None or value == '':
         return ''
     
-    if value == True:
-        value = "true"
-    elif value == False:
-        value = "false"
+    if isinstance(value, bool):
+        value = "true" if value else "false"
     else:
         value = str(value)
     
@@ -120,68 +176,152 @@ def get_base_type(ts_type: str) -> str:
 
 def generate_data_types_markdown(types, enumerations, classes, root='../../'):
     """
-    1) Convert each raw JSDoc type from Array.<T> to T[].
-    2) Split union types if needed (usually they're provided as separate
-       elements in 'types' already, but let's be safe).
-    3) For each type, extract the base type (e.g. "Drawing" from "Drawing[]").
-    4) If the base type matches an enumeration or class, link the entire
-       T[]-based string.
-    5) Join with " | ".
+    1) Converts each type from JSDoc (e.g., Array.<T>) to T[].
+    2) Processes union types by splitting them using '|'.
+    3) Supports multidimensional arrays, e.g., (string|ApiRange|number)[].
+    4) If the base type matches the name of an enumeration or class, generates a link.
+    5) The final types are joined using " | ".
     """
+    # Convert each type from JSDoc format to TypeScript format (e.g., T[])
+    converted = [convert_jsdoc_array_to_ts(t) for t in types]
 
-    # Convert each raw type from JSDoc to TS
-    converted = [convert_jsdoc_array_to_ts(t) for t in types]  # e.g. ["Drawing[]", "Foo[]", ...]
+    # Set of primitive types
+    primitive_types = {"string", "number", "boolean", "null", "undefined", "any", "object", "false", "true", "json", "function", "{}"}
+
+    def is_primitive(type):
+        if (type.lower() in primitive_types or
+            (type.startswith('"') and type.endswith('"')) or
+            (type.startswith("'") and type.endswith("'")) or
+            type.replace('.', '', 1).isdigit() or
+            (type.startswith('-') and type[1:].replace('.', '', 1).isdigit())):
+            return True
+        return False
 
-    # For each converted type (like "Drawing[]"), see if the base is in enumerations or classes
     def link_if_known(ts_type):
-        base = get_base_type(ts_type)  # e.g. "Drawing" from "Drawing[]"
+        ts_type = ts_type.strip()
+        # Count the number of array dimensions, e.g., "[][]" has 2 dimensions
+        array_dims = 0
+        while ts_type.endswith("[]"):
+            array_dims += 1
+            ts_type = ts_type[:-2].strip()
 
-        # Check enumerations first
-        for enum in enumerations:
-            if enum['name'] == base:
-                # Replace the entire token with a link
-                return f"[{ts_type}]({root}Enumeration/{base}.md)"
+        # Process generic types, e.g., Object.<string, editorType>
+        if ".<" in ts_type and ts_type.endswith(">"):
+            import re
+            m = re.match(r'^(.*?)\.<(.*)>$', ts_type)
+            if m:
+                base_part = m.group(1).strip()
+                generic_args_str = m.group(2).strip()
+                # Process the base part of the type
+                found = False
+                for enum in enumerations:
+                    if enum['name'] == base_part:
+                        used_enumerations.add(base_part)
+                        base_result = f"[{base_part}]({root}Enumeration/{base_part}.md)"
+                        found = True
+                        break
+                if not found:
+                    if base_part in classes:
+                        base_result = f"[{base_part}]({root}{base_part}/{base_part}.md)"
+                    elif is_primitive(base_part):
+                        base_result = base_part
+                    elif cur_editor_name == "forms":
+                        base_result = f"[{base_part}]({root}../text-document-api/{base_part}/{base_part}.md)"
+                    else:
+                        print(f"Unknown type encountered: {base_part}")
+                        base_result = base_part
+                # Split the generic parameters by commas and process each recursively
+                generic_args = [link_if_known(x) for x in generic_args_str.split(",")]
+                result = base_result + ".&lt;" + ", ".join(generic_args) + "&gt;"
+                result += "[]" * array_dims
+                return result
 
-        # Check classes
-        if base in classes:
-            return f"[{ts_type}]({root}{base}/{base}.md)"
+        # Process union types: if the type is enclosed in parentheses
+        if ts_type.startswith("(") and ts_type.endswith(")"):
+            inner = ts_type[1:-1].strip()
+            subtypes = [sub.strip() for sub in inner.split("|")]
+            if len(subtypes) == 1:
+                result = link_if_known(subtypes[0])
+            else:
+                processed = [link_if_known(subtype) for subtype in subtypes]
+                result = "(" + " | ".join(processed) + ")"
+            result += "[]" * array_dims
+            return result
 
-        # Otherwise just return as-is
-        return ts_type
+        # If not a generic or union type – process the base type
+        else:
+            base = ts_type
+            found = False
+            for enum in enumerations:
+                if enum['name'] == base:
+                    used_enumerations.add(base)
+                    result = f"[{base}]({root}Enumeration/{base}.md)"
+                    found = True
+                    break
+            if not found:
+                if base in classes:
+                    result = f"[{base}]({root}{base}/{base}.md)"
+                elif is_primitive(base):
+                    result = base
+                elif cur_editor_name == "forms":
+                    result = f"[{base}]({root}../text-document-api/{base}/{base}.md)"
+                else:
+                    print(f"Unknown type encountered: {base}")
+                    result = base
+            result += "[]" * array_dims
+            return result
 
-    # Build final list of possibly-linked types
+    # Apply link_if_known to each converted type
     linked = [link_if_known(ts_t) for ts_t in converted]
 
-    # Join them with " | "
-    param_types_md = ' | '.join(linked)
+    # Join results using " | "
+    param_types_md = r' | '.join(linked)
+    param_types_md = param_types_md.replace("|", r"\|")
 
-    # If there's still leftover angle brackets for generics, gently escape or link them
-    # e.g. "Object.<string, number>" => "Object.&lt;string, number&gt;"
-    # or do more specialized linking if you want to handle them deeper.
+    # Escape remaining angle brackets for generics
     def replace_leftover_generics(match):
         element = match.group(1).strip()
         return f"&lt;{element}&gt;"
-    
+
     param_types_md = re.sub(r'<([^<>]+)>', replace_leftover_generics, param_types_md)
 
     return param_types_md
 
+
 def generate_class_markdown(class_name, methods, properties, enumerations, classes):
     content = f"# {class_name}\n\nRepresents the {class_name} class.\n\n"
+    
     content += generate_properties_markdown(properties, enumerations, classes)
 
-    content += "## Methods\n\n"
-    for method in methods:
+    content += "\n## Methods\n\n"
+    content += "| Method | Returns | Description |\n"
+    content += "| ------ | ------- | ----------- |\n"
+    
+    for method in sorted(methods, key=lambda m: m['name']):
         method_name = method['name']
-        content += f"- [{method_name}](./Methods/{method_name}.md)\n"
-
-    # Escape just before returning
+        
+        # Get the type of return values
+        returns = method.get('returns', [])
+        if returns:
+            return_type_list = returns[0].get('type', {}).get('names', [])
+            returns_markdown = generate_data_types_markdown(return_type_list, enumerations, classes, '../')
+        else:
+            returns_markdown = "None"
+        
+        # Processing the method description
+        description = remove_line_breaks(correct_description(method.get('description', 'No description provided.'), '../'))
+        
+        # Form a link to the method document
+        method_link = f"[{method_name}](./Methods/{method_name}.md)"
+        
+        content += f"| {method_link} | {returns_markdown} | {description} |\n"
+    
     return escape_text_outside_code_blocks(content)
 
-def generate_method_markdown(method, enumerations, classes):
+def generate_method_markdown(method, enumerations, classes, example_editor_name):
     method_name = method['name']
     description = method.get('description', 'No description provided.')
-    description = correct_description(description)
+    description = correct_description(description, '../../')
     params = method.get('params', [])
     returns = method.get('returns', [])
     example = method.get('example', '')
@@ -190,7 +330,7 @@ def generate_method_markdown(method, enumerations, classes):
     content = f"# {method_name}\n\n{description}\n\n"
     
     # Syntax
-    param_list = ', '.join([param['name'] for param in params]) if params else ''
+    param_list = ', '.join([param['name'] for param in params if '.' not in param['name']]) if params else ''
     content += f"## Syntax\n\n```javascript\nexpression.{method_name}({param_list});\n```\n\n"
     if memberof:
         content += f"`expression` - A variable that represents a [{memberof}](../{memberof}.md) class.\n\n"
@@ -204,7 +344,7 @@ def generate_method_markdown(method, enumerations, classes):
             param_name = param.get('name', 'Unnamed')
             param_types = param.get('type', {}).get('names', []) if param.get('type') else []
             param_types_md = generate_data_types_markdown(param_types, enumerations, classes)
-            param_desc = remove_line_breaks(correct_description(param.get('description', 'No description provided.')))
+            param_desc = remove_line_breaks(correct_description(param.get('description', 'No description provided.'), '../../'))
             param_required = "Required" if not param.get('optional') else "Optional"
             param_default = correct_default_value(param.get('defaultvalue', ''), enumerations, classes)
 
@@ -227,11 +367,11 @@ def generate_method_markdown(method, enumerations, classes):
         if '```js' in example:
             comment, code = example.split('```js', 1)
             comment = remove_js_comments(comment)
-            content += f"\n\n## Example\n\n{comment}\n\n```javascript\n{code.strip()}\n"
+            content += f"\n\n## Example\n\n{comment}\n\n```javascript {example_editor_name}\n{code.strip()}\n"
         else:
             # If there's no triple-backtick structure, just show it as code
             cleaned_example = remove_js_comments(example)
-            content += f"\n\n## Example\n\n```javascript\n{cleaned_example}\n```\n"
+            content += f"\n\n## Example\n\n```javascript {example_editor_name}\n{cleaned_example}\n```\n"
 
     return escape_text_outside_code_blocks(content)
 
@@ -243,10 +383,10 @@ def generate_properties_markdown(properties, enumerations, classes, root='../'):
     content += "| Name | Type | Description |\n"
     content += "| ---- | ---- | ----------- |\n"
 
-    for prop in properties:
+    for prop in sorted(properties, key=lambda m: m['name']):
         prop_name = prop['name']
         prop_description = prop.get('description', 'No description provided.')
-        prop_description = remove_line_breaks(correct_description(prop_description))
+        prop_description = remove_line_breaks(correct_description(prop_description, root))
         prop_types = prop['type']['names'] if prop.get('type') else []
         param_types_md = generate_data_types_markdown(prop_types, enumerations, classes, root)
         content += f"| {prop_name} | {param_types_md} | {prop_description} |\n"
@@ -254,10 +394,14 @@ def generate_properties_markdown(properties, enumerations, classes, root='../'):
     # Escape outside code blocks
     return escape_text_outside_code_blocks(content)
 
-def generate_enumeration_markdown(enumeration, enumerations, classes):
+def generate_enumeration_markdown(enumeration, enumerations, classes, example_editor_name):
     enum_name = enumeration['name']
+    
+    if enum_name not in used_enumerations:
+            return None
+    
     description = enumeration.get('description', 'No description provided.')
-    description = correct_description(description)
+    description = correct_description(description, '../')
     example = enumeration.get('example', '')
 
     content = f"# {enum_name}\n\n{description}\n\n"
@@ -274,6 +418,7 @@ def generate_enumeration_markdown(enumeration, enumerations, classes):
 
             # Attempt linking: we compare the raw type to enumerations/classes
             if any(enum['name'] == raw_t for enum in enumerations):
+                used_enumerations.add(raw_t)
                 content += f"- [{ts_t}](../Enumeration/{raw_t}.md)\n"
                 enum_empty = False
             elif raw_t in classes:
@@ -300,25 +445,40 @@ def generate_enumeration_markdown(enumeration, enumerations, classes):
         if '```js' in example:
             comment, code = example.split('```js', 1)
             comment = remove_js_comments(comment)
-            content += f"\n\n## Example\n\n{comment}\n\n```javascript\n{code.strip()}\n"
+            content += f"\n\n## Example\n\n{comment}\n\n```javascript {example_editor_name}\n{code.strip()}\n"
         else:
             # If there's no triple-backtick structure
             cleaned_example = remove_js_comments(example)
-            content += f"\n\n## Example\n\n```javascript\n{cleaned_example}\n```\n"
+            content += f"\n\n## Example\n\n```javascript {example_editor_name}\n{cleaned_example}\n```\n"
 
     return escape_text_outside_code_blocks(content)
 
 def process_doclets(data, output_dir, editor_name):
+    global cur_editor_name
+    cur_editor_name = editor_name
+
     classes = {}
     classes_props = {}
     enumerations = []
-    editor_dir =  os.path.join(output_dir, editor_name)
+    editor_dir = os.path.join(output_dir, editors[editor_name])
+    example_editor_name = 'editor-'
+    
+    if editor_name == 'word':
+        example_editor_name += 'docx'
+    elif editor_name == 'forms':
+        example_editor_name += 'pdf'
+    elif editor_name == 'slide':
+        example_editor_name += 'pptx'
+    elif editor_name == 'cell':
+        example_editor_name += 'xlsx'
 
     for doclet in data:
         if doclet['kind'] == 'class':
             class_name = doclet['name']
-            classes[class_name] = []
-            classes_props[class_name] = doclet.get('properties', None)
+            if class_name:
+                if class_name not in classes:
+                    classes[class_name] = []
+                classes_props[class_name] = doclet.get('properties', None)
         elif doclet['kind'] == 'function':
             class_name = doclet.get('memberof')
             if class_name:
@@ -330,6 +490,9 @@ def process_doclets(data, output_dir, editor_name):
 
     # Process classes
     for class_name, methods in classes.items():
+        if (len(methods) == 0):
+            continue
+
         class_dir = os.path.join(editor_dir, class_name)
         methods_dir = os.path.join(class_dir, 'Methods')
         os.makedirs(methods_dir, exist_ok=True)
@@ -347,7 +510,7 @@ def process_doclets(data, output_dir, editor_name):
         # Write method files
         for method in methods:
             method_file_path = os.path.join(methods_dir, f"{method['name']}.md")
-            method_content = generate_method_markdown(method, enumerations, classes)
+            method_content = generate_method_markdown(method, enumerations, classes, example_editor_name)
             write_markdown_file(method_file_path, method_content)
 
             if not method.get('example', ''):
@@ -357,9 +520,16 @@ def process_doclets(data, output_dir, editor_name):
     enum_dir = os.path.join(editor_dir, 'Enumeration')
     os.makedirs(enum_dir, exist_ok=True)
 
+    # idle run
+    prev_used_count = -1
+    while len(used_enumerations) != prev_used_count:
+        prev_used_count = len(used_enumerations)
+        for enum in [e for e in enumerations if e['name'] in used_enumerations]:
+            enum_content = generate_enumeration_markdown(enum, enumerations, classes, example_editor_name)
+
     for enum in enumerations:
         enum_file_path = os.path.join(enum_dir, f"{enum['name']}.md")
-        enum_content = generate_enumeration_markdown(enum, enumerations, classes)
+        enum_content = generate_enumeration_markdown(enum, enumerations, classes, example_editor_name)
         if enum_content is None:
             continue
 
@@ -371,14 +541,15 @@ def generate(output_dir):
     print('Generating Markdown documentation...')
     
     generate_docs_json.generate(output_dir + 'tmp_json', md=True)
-    for editor_name in editors:
-        input_file = os.path.join(output_dir + 'tmp_json', editor_name + ".json")
+    for editor_name, folder_name in editors.items():
+        input_file = os.path.join(output_dir + '/tmp_json', editor_name + ".json")
 
-        shutil.rmtree(output_dir + f'/{editor_name.title()}')
-        os.makedirs(output_dir + f'/{editor_name.title()}')
+        shutil.rmtree(output_dir + f'/{folder_name}', ignore_errors=True)
+        os.makedirs(output_dir + f'/{folder_name}')
 
         data = load_json(input_file)
-        process_doclets(data, output_dir, editor_name.title())
+        used_enumerations.clear()
+        process_doclets(data, output_dir, editor_name)
     
     shutil.rmtree(output_dir + 'tmp_json')
     print('Done')

scripts/sdkjs_common/jsdoc/generate_docs_md_site.py

@@ -0,0 +1,573 @@
+import os
+import json
+import re
+import shutil
+import argparse
+import generate_docs_json
+
+# Configuration files
+editors = {
+    "word": "text-document-api",
+    "cell": "spreadsheet-api",
+    "slide": "presentation-api",
+    "forms": "form-api"
+}
+
+missing_examples = []
+used_enumerations = set()
+
+cur_editor_name = None
+
+def load_json(file_path):
+    with open(file_path, 'r', encoding='utf-8') as f:
+        return json.load(f)
+
+def write_markdown_file(file_path, content):
+    with open(file_path, 'w', encoding='utf-8') as md_file:
+        md_file.write(content)
+
+def remove_js_comments(text):
+    text = re.sub(r'^\s*//.*$', '', text, flags=re.MULTILINE)  # single-line
+    text = re.sub(r'/\*.*?\*/', '', text, flags=re.DOTALL)     # multi-line
+    return text.strip()
+
+def process_link_tags(text, root=''):
+    """
+    Finds patterns like {@link ...} and replaces them with Markdown links.
+    If the prefix 'global#' is found, a link to a typedef is generated,
+    otherwise, a link to a class method is created.
+    For a method, if an alias is not specified, the name is left in the format 'Class#Method'.
+    """
+    reserved_links = {
+        '/docbuilder/global#ShapeType': f"{'../../../../../../' if root == '' else '../../../../../' if root == '../' else root}docs/office-api/usage-api/text-document-api/Enumeration/ShapeType.md",
+        '/plugin/config': 'https://api.onlyoffice.com/docs/plugin-and-macros/structure/manifest/',
+        '/docbuilder/basic': 'https://api.onlyoffice.com/docs/office-api/usage-api/text-document-api/'
+    }
+
+    def replace_link(match):
+        content = match.group(1).strip()  # Example: "/docbuilder/global#ShapeType shape type" or "global#ErrorValue ErrorValue"
+        parts = content.split()
+        ref = parts[0]
+        label = parts[1] if len(parts) > 1 else None
+
+        if ref.startswith('/'):
+            # Handle reserved links using mapping
+            if ref in reserved_links:
+                url = reserved_links[ref]
+                display_text = label if label else ref
+                return f"[{display_text}]({url})"
+            else:
+                # If the link is not in the mapping, return the original construction
+                return match.group(0)
+        elif ref.startswith("global#"):
+            # Handle links to typedef (similar logic as before)
+            typedef_name = ref.split("#")[1]
+            used_enumerations.add(typedef_name)
+            display_text = label if label else typedef_name
+            return f"[{display_text}]({root}Enumeration/{typedef_name}.md)"
+        else:
+            # Handle links to class methods like ClassName#MethodName
+            try:
+                class_name, method_name = ref.split("#")
+            except ValueError:
+                return match.group(0)
+            display_text = label if label else ref  # Keep the full notation, e.g., "Api#CreateSlide"
+            return f"[{display_text}]({root}{class_name}/Methods/{method_name}.md)"
+
+    return re.sub(r'{@link\s+([^}]+)}', replace_link, text)
+
+def correct_description(string, root=''):
+    """
+    Cleans or transforms specific tags in the doclet description:
+      - <b> => ** (bold text)
+      - <note>...</note> => 💡 ...
+      - {@link ...} is replaced with a Markdown link
+      - If the description is missing, returns a default value.
+      - All '\r' characters are replaced with '\n'.
+    """
+    if string is None:
+        return 'No description provided.'
+
+    # Line breaks
+    string = string.replace('\r', '\\\n')
+    
+    # Replace <b> tags with Markdown bold formatting
+    string = re.sub(r'<b>', '-**', string)
+    string = re.sub(r'</b>', '**', string)
+    
+    # Replace <note> tags with an icon and text
+    string = re.sub(r'<note>(.*?)</note>', r'💡 \1', string, flags=re.DOTALL)
+    
+    # Process {@link ...} constructions
+    string = process_link_tags(string, root)
+    
+    return string
+
+def correct_default_value(value, enumerations, classes):
+    if value is None or value == '':
+        return ''
+    
+    if isinstance(value, bool):
+        value = "true" if value else "false"
+    else:
+        value = str(value)
+    
+    return generate_data_types_markdown([value], enumerations, classes)
+
+def remove_line_breaks(string):
+    return re.sub(r'[\r\n]+', ' ', string)
+
+# Convert Array.<T> => T[] (including nested arrays).
+def convert_jsdoc_array_to_ts(type_str: str) -> str:
+    """
+    Recursively replaces 'Array.<T>' with 'T[]',
+    handling nested arrays like 'Array.<Array.<string>>' => 'string[][]'.
+    """
+    pattern = re.compile(r'Array\.<([^>]+)>')
+    
+    while True:
+        match = pattern.search(type_str)
+        if not match:
+            break
+        
+        inner_type = match.group(1).strip()
+        # Recursively convert inner parts
+        inner_type = convert_jsdoc_array_to_ts(inner_type)
+        
+        # Replace the outer Array.<...> with ...[]
+        type_str = (
+            type_str[:match.start()] 
+            + f"{inner_type}[]" 
+            + type_str[match.end():]
+        )
+    
+    return type_str
+
+def escape_text_outside_code_blocks(markdown: str) -> str:
+    """
+    Splits content by fenced code blocks, escapes MDX-unsafe characters
+    (<, >, {, }) only in the text outside those code blocks.
+    """
+    # A regex to capture fenced code blocks with ```
+    parts = re.split(r'(```.*?```)', markdown, flags=re.DOTALL)
+    
+    # Even indices (0, 2, 4, ...) are outside code blocks,
+    # odd indices (1, 3, 5, ...) are actual code blocks.
+    for i in range(0, len(parts), 2):
+        # Only escape in parts outside code blocks
+        parts[i] = (parts[i]
+                    .replace('<', '&lt;')
+                    .replace('>', '&gt;')
+                    .replace('{', '&#123;')
+                    .replace('}', '&#125;')
+                   )
+    return "".join(parts)
+
+def get_base_type(ts_type: str) -> str:
+    """
+    Given a TypeScript-like type (e.g. "Drawing[][]"), return the
+    'base' portion by stripping trailing "[]". For "Drawing[][]",
+    returns "Drawing". For "Array.<Drawing>", you'd convert it first
+    to "Drawing[]" then return "Drawing".
+    """
+    while ts_type.endswith('[]'):
+        ts_type = ts_type[:-2]
+    return ts_type
+
+def generate_data_types_markdown(types, enumerations, classes, root='../../'):
+    """
+    1) Converts each type from JSDoc (e.g., Array.<T>) to T[].
+    2) Processes union types by splitting them using '|'.
+    3) Supports multidimensional arrays, e.g., (string|ApiRange|number)[].
+    4) If the base type matches the name of an enumeration or class, generates a link.
+    5) The final types are joined using " | ".
+    """
+    # Convert each type from JSDoc format to TypeScript format (e.g., T[])
+    converted = [convert_jsdoc_array_to_ts(t) for t in types]
+
+    # Set of primitive types
+    primitive_types = {"string", "number", "boolean", "null", "undefined", "any", "object", "false", "true", "json", "function", "{}"}
+
+    def is_primitive(type):
+        if (type.lower() in primitive_types or
+            (type.startswith('"') and type.endswith('"')) or
+            (type.startswith("'") and type.endswith("'")) or
+            type.replace('.', '', 1).isdigit() or
+            (type.startswith('-') and type[1:].replace('.', '', 1).isdigit())):
+            return True
+        return False
+
+    def link_if_known(ts_type):
+        ts_type = ts_type.strip()
+        # Count the number of array dimensions, e.g., "[][]" has 2 dimensions
+        array_dims = 0
+        while ts_type.endswith("[]"):
+            array_dims += 1
+            ts_type = ts_type[:-2].strip()
+
+        # Process generic types, e.g., Object.<string, editorType>
+        if ".<" in ts_type and ts_type.endswith(">"):
+            import re
+            m = re.match(r'^(.*?)\.<(.*)>$', ts_type)
+            if m:
+                base_part = m.group(1).strip()
+                generic_args_str = m.group(2).strip()
+                # Process the base part of the type
+                found = False
+                for enum in enumerations:
+                    if enum['name'] == base_part:
+                        used_enumerations.add(base_part)
+                        base_result = f"[{base_part}]({root}Enumeration/{base_part}.md)"
+                        found = True
+                        break
+                if not found:
+                    if base_part in classes:
+                        base_result = f"[{base_part}]({root}{base_part}/{base_part}.md)"
+                    elif is_primitive(base_part):
+                        base_result = base_part
+                    elif cur_editor_name == "forms":
+                        base_result = f"[{base_part}]({root}../text-document-api/{base_part}/{base_part}.md)"
+                    else:
+                        print(f"Unknown type encountered: {base_part}")
+                        base_result = base_part
+                # Split the generic parameters by commas and process each recursively
+                generic_args = [link_if_known(x) for x in generic_args_str.split(",")]
+                result = base_result + ".&lt;" + ", ".join(generic_args) + "&gt;"
+                result += "[]" * array_dims
+                return result
+
+        # Process union types: if the type is enclosed in parentheses
+        if ts_type.startswith("(") and ts_type.endswith(")"):
+            inner = ts_type[1:-1].strip()
+            subtypes = [sub.strip() for sub in inner.split("|")]
+            if len(subtypes) == 1:
+                result = link_if_known(subtypes[0])
+            else:
+                processed = [link_if_known(subtype) for subtype in subtypes]
+                result = "(" + " | ".join(processed) + ")"
+            result += "[]" * array_dims
+            return result
+
+        # If not a generic or union type – process the base type
+        else:
+            base = ts_type
+            found = False
+            for enum in enumerations:
+                if enum['name'] == base:
+                    used_enumerations.add(base)
+                    result = f"[{base}]({root}Enumeration/{base}.md)"
+                    found = True
+                    break
+            if not found:
+                if base in classes:
+                    result = f"[{base}]({root}{base}/{base}.md)"
+                elif is_primitive(base):
+                    result = base
+                elif cur_editor_name == "forms":
+                    result = f"[{base}]({root}../text-document-api/{base}/{base}.md)"
+                else:
+                    print(f"Unknown type encountered: {base}")
+                    result = base
+            result += "[]" * array_dims
+            return result
+
+    # Apply link_if_known to each converted type
+    linked = [link_if_known(ts_t) for ts_t in converted]
+
+    # Join results using " | "
+    param_types_md = r' | '.join(linked)
+    param_types_md = param_types_md.replace("|", r"\|")
+
+    # Escape remaining angle brackets for generics
+    def replace_leftover_generics(match):
+        element = match.group(1).strip()
+        return f"&lt;{element}&gt;"
+
+    param_types_md = re.sub(r'<([^<>]+)>', replace_leftover_generics, param_types_md)
+
+    return param_types_md
+
+
+def generate_class_markdown(class_name, methods, properties, enumerations, classes):
+    content = f"# {class_name}\n\nRepresents the {class_name} class.\n\n"
+    
+    content += generate_properties_markdown(properties, enumerations, classes)
+
+    content += "\n## Methods\n\n"
+    content += "| Method | Returns | Description |\n"
+    content += "| ------ | ------- | ----------- |\n"
+    
+    for method in sorted(methods, key=lambda m: m['name']):
+        method_name = method['name']
+        
+        # Get the type of return values
+        returns = method.get('returns', [])
+        if returns:
+            return_type_list = returns[0].get('type', {}).get('names', [])
+            returns_markdown = generate_data_types_markdown(return_type_list, enumerations, classes, '../')
+        else:
+            returns_markdown = "None"
+        
+        # Processing the method description
+        description = remove_line_breaks(correct_description(method.get('description', 'No description provided.'), '../'))
+        
+        # Form a link to the method document
+        method_link = f"[{method_name}](./Methods/{method_name}.md)"
+        
+        content += f"| {method_link} | {returns_markdown} | {description} |\n"
+    
+    return escape_text_outside_code_blocks(content)
+
+def generate_method_markdown(method, enumerations, classes, example_editor_name):
+    method_name = method['name']
+    description = method.get('description', 'No description provided.')
+    description = correct_description(description, '../../')
+    params = method.get('params', [])
+    returns = method.get('returns', [])
+    example = method.get('example', '')
+    memberof = method.get('memberof', '')
+
+    content = f"# {method_name}\n\n{description}\n\n"
+    
+    # Syntax
+    param_list = ', '.join([param['name'] for param in params if '.' not in param['name']]) if params else ''
+    content += f"## Syntax\n\n```javascript\nexpression.{method_name}({param_list});\n```\n\n"
+    if memberof:
+        content += f"`expression` - A variable that represents a [{memberof}](../{memberof}.md) class.\n\n"
+
+    # Parameters
+    content += "## Parameters\n\n"
+    if params:
+        content += "| **Name** | **Required/Optional** | **Data type** | **Default** | **Description** |\n"
+        content += "| ------------- | ------------- | ------------- | ------------- | ------------- |\n"
+        for param in params:
+            param_name = param.get('name', 'Unnamed')
+            param_types = param.get('type', {}).get('names', []) if param.get('type') else []
+            param_types_md = generate_data_types_markdown(param_types, enumerations, classes)
+            param_desc = remove_line_breaks(correct_description(param.get('description', 'No description provided.'), '../../'))
+            param_required = "Required" if not param.get('optional') else "Optional"
+            param_default = correct_default_value(param.get('defaultvalue', ''), enumerations, classes)
+
+            content += f"| {param_name} | {param_required} | {param_types_md} | {param_default} | {param_desc} |\n"
+    else:
+        content += "This method doesn't have any parameters.\n"
+
+    # Returns
+    content += "\n## Returns\n\n"
+    if returns:
+        return_type_list = returns[0].get('type', {}).get('names', [])
+        return_type_md = generate_data_types_markdown(return_type_list, enumerations, classes)
+        content += return_type_md
+    else:
+        content += "This method doesn't return any data."
+    
+    # Example
+    if example:
+        # Separate comment and code, remove JS comments
+        if '```js' in example:
+            comment, code = example.split('```js', 1)
+            comment = remove_js_comments(comment)
+            content += f"\n\n## Example\n\n{comment}\n\n```javascript {example_editor_name}\n{code.strip()}\n"
+        else:
+            # If there's no triple-backtick structure, just show it as code
+            cleaned_example = remove_js_comments(example)
+            content += f"\n\n## Example\n\n```javascript {example_editor_name}\n{cleaned_example}\n```\n"
+
+    return escape_text_outside_code_blocks(content)
+
+def generate_properties_markdown(properties, enumerations, classes, root='../'):
+    if properties is None:
+        return ''
+    
+    content = "## Properties\n\n"
+    content += "| Name | Type | Description |\n"
+    content += "| ---- | ---- | ----------- |\n"
+
+    for prop in sorted(properties, key=lambda m: m['name']):
+        prop_name = prop['name']
+        prop_description = prop.get('description', 'No description provided.')
+        prop_description = remove_line_breaks(correct_description(prop_description, root))
+        prop_types = prop['type']['names'] if prop.get('type') else []
+        param_types_md = generate_data_types_markdown(prop_types, enumerations, classes, root)
+        content += f"| {prop_name} | {param_types_md} | {prop_description} |\n"
+
+    # Escape outside code blocks
+    return escape_text_outside_code_blocks(content)
+
+def generate_enumeration_markdown(enumeration, enumerations, classes, example_editor_name):
+    enum_name = enumeration['name']
+    
+    if enum_name not in used_enumerations:
+            return None
+    
+    description = enumeration.get('description', 'No description provided.')
+    description = correct_description(description, '../')
+    example = enumeration.get('example', '')
+
+    content = f"# {enum_name}\n\n{description}\n\n"
+    
+    ptype = enumeration['type']['parsedType']
+    if ptype['type'] == 'TypeUnion':
+        enum_empty = True # is empty enum
+
+        content += "## Type\n\nEnumeration\n\n"
+        content += "## Values\n\n"
+        # Each top-level name in the union
+        for raw_t in enumeration['type']['names']:
+            ts_t = convert_jsdoc_array_to_ts(raw_t)
+
+            # Attempt linking: we compare the raw type to enumerations/classes
+            if any(enum['name'] == raw_t for enum in enumerations):
+                used_enumerations.add(raw_t)
+                content += f"- [{ts_t}](../Enumeration/{raw_t}.md)\n"
+                enum_empty = False
+            elif raw_t in classes:
+                content += f"- [{ts_t}](../{raw_t}/{raw_t}.md)\n"
+                enum_empty = False
+            elif ts_t.find('Api') == -1:
+                content += f"- {ts_t}\n"
+                enum_empty = False
+        
+        if enum_empty == True:
+            return None
+    elif enumeration['properties'] is not None:
+        content += "## Type\n\nObject\n\n"
+        content += generate_properties_markdown(enumeration['properties'], enumerations, classes)
+    else:
+        content += "## Type\n\n"
+        # If it's not a union and has no properties, simply print the type(s).
+        types = enumeration['type']['names']
+        t_md = generate_data_types_markdown(types, enumerations, classes)
+        content += t_md + "\n\n"
+
+    # Example
+    if example:
+        if '```js' in example:
+            comment, code = example.split('```js', 1)
+            comment = remove_js_comments(comment)
+            content += f"\n\n## Example\n\n{comment}\n\n```javascript {example_editor_name}\n{code.strip()}\n"
+        else:
+            # If there's no triple-backtick structure
+            cleaned_example = remove_js_comments(example)
+            content += f"\n\n## Example\n\n```javascript {example_editor_name}\n{cleaned_example}\n```\n"
+
+    return escape_text_outside_code_blocks(content)
+
+def process_doclets(data, output_dir, editor_name):
+    global cur_editor_name
+    cur_editor_name = editor_name
+
+    classes = {}
+    classes_props = {}
+    enumerations = []
+    editor_dir = os.path.join(output_dir, editors[editor_name])
+    example_editor_name = 'editor-'
+    
+    if editor_name == 'word':
+        example_editor_name += 'docx'
+    elif editor_name == 'forms':
+        example_editor_name += 'pdf'
+    elif editor_name == 'slide':
+        example_editor_name += 'pptx'
+    elif editor_name == 'cell':
+        example_editor_name += 'xlsx'
+
+    for doclet in data:
+        if doclet['kind'] == 'class':
+            class_name = doclet['name']
+            if class_name:
+                if class_name not in classes:
+                    classes[class_name] = []
+                classes_props[class_name] = doclet.get('properties', None)
+        elif doclet['kind'] == 'function':
+            class_name = doclet.get('memberof')
+            if class_name:
+                if class_name not in classes:
+                    classes[class_name] = []
+                classes[class_name].append(doclet)
+        elif doclet['kind'] == 'typedef':
+            enumerations.append(doclet)
+
+    # Process classes
+    for class_name, methods in classes.items():
+        if (len(methods) == 0):
+            continue
+
+        class_dir = os.path.join(editor_dir, class_name)
+        methods_dir = os.path.join(class_dir, 'Methods')
+        os.makedirs(methods_dir, exist_ok=True)
+
+        # Write class file
+        class_content = generate_class_markdown(
+            class_name, 
+            methods, 
+            classes_props[class_name], 
+            enumerations, 
+            classes
+        )
+        write_markdown_file(os.path.join(class_dir, f"{class_name}.md"), class_content)
+
+        # Write method files
+        for method in methods:
+            method_file_path = os.path.join(methods_dir, f"{method['name']}.md")
+            method_content = generate_method_markdown(method, enumerations, classes, example_editor_name)
+            write_markdown_file(method_file_path, method_content)
+
+            if not method.get('example', ''):
+                missing_examples.append(os.path.relpath(method_file_path, output_dir))
+
+    # Process enumerations
+    enum_dir = os.path.join(editor_dir, 'Enumeration')
+    os.makedirs(enum_dir, exist_ok=True)
+
+    # idle run
+    prev_used_count = -1
+    while len(used_enumerations) != prev_used_count:
+        prev_used_count = len(used_enumerations)
+        for enum in [e for e in enumerations if e['name'] in used_enumerations]:
+            enum_content = generate_enumeration_markdown(enum, enumerations, classes, example_editor_name)
+
+    for enum in enumerations:
+        enum_file_path = os.path.join(enum_dir, f"{enum['name']}.md")
+        enum_content = generate_enumeration_markdown(enum, enumerations, classes, example_editor_name)
+        if enum_content is None:
+            continue
+
+        write_markdown_file(enum_file_path, enum_content)
+        if not enum.get('example', ''):
+            missing_examples.append(os.path.relpath(enum_file_path, output_dir))
+
+def generate(output_dir):
+    print('Generating Markdown documentation...')
+    
+    generate_docs_json.generate(output_dir + 'tmp_json', md=True)
+    for editor_name, folder_name in editors.items():
+        input_file = os.path.join(output_dir + '/tmp_json', editor_name + ".json")
+
+        editor_folder_path = os.path.join(output_dir, folder_name)
+        for folder_name in os.listdir(editor_folder_path):
+            folder_path_to_del = os.path.join(editor_folder_path, folder_name)
+            if os.path.isdir(folder_path_to_del):
+                shutil.rmtree(folder_path_to_del, ignore_errors=True)
+
+        data = load_json(input_file)
+        used_enumerations.clear()
+        process_doclets(data, output_dir, editor_name)
+    
+    shutil.rmtree(output_dir + 'tmp_json')
+    print('Done')
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Generate documentation")
+    parser.add_argument(
+        "destination", 
+        type=str, 
+        help="Destination directory for the generated documentation",
+        nargs='?',  # Indicates the argument is optional
+        default="../../../../api.onlyoffice.com/site/docs/office-api/usage-api/"  # Default value
+    )
+    args = parser.parse_args()
+    generate(args.destination)
+    print("START_MISSING_EXAMPLES")
+    print(",".join(missing_examples))
+    print("END_MISSING_EXAMPLES")

scripts/sdkjs_common/jsdoc/generate_docs_plugins_md.py

@@ -6,14 +6,17 @@ import argparse
 import generate_docs_plugins_json
 
 # Configuration files
-editors = [
-    "word",
-    "cell",
-    "slide",
-    "forms"
-]
+editors = {
+    "word": "text-document-api",
+    "cell": "spreadsheet-api",
+    "slide": "presentation-api",
+    "forms": "form-api"
+}
 
 missing_examples = []
+used_enumerations = set()
+
+cur_editor_name = None
 
 def load_json(file_path):
     with open(file_path, 'r', encoding='utf-8') as f:
@@ -28,25 +31,80 @@ def remove_js_comments(text):
     text = re.sub(r'/\*.*?\*/', '', text, flags=re.DOTALL)     # multi-line
     return text.strip()
 
-def correct_description(string):
+def process_link_tags(text, root=''):
     """
-    Cleans up or transforms certain tags in a doclet description:
-      - <b> => **
+    Finds patterns like {@link ...} and replaces them with Markdown links.
+    If the prefix 'global#' is found, a link to a typedef is generated,
+    otherwise, a link to a class method is created.
+    For a method, if an alias is not specified, the name is left in the format 'Class#Method'.
+    """
+    reserved_links = {
+        '/docbuilder/global#ShapeType': f"{'../../../' if root == '' else '../../' if root == '../' else root}text-document-api/Enumeration/ShapeType.md",
+        '/plugin/config': 'https://api.onlyoffice.com/docs/plugin-and-macros/structure/manifest/',
+        '/docbuilder/basic': 'https://api.onlyoffice.com/docs/office-api/usage-api/text-document-api/'
+    }
+
+    def replace_link(match):
+        content = match.group(1).strip()  # Example: "/docbuilder/global#ShapeType shape type" or "global#ErrorValue ErrorValue"
+        parts = content.split()
+        ref = parts[0]
+        label = parts[1] if len(parts) > 1 else None
+
+        if ref.startswith('/'):
+            # Handle reserved links using mapping
+            if ref in reserved_links:
+                url = reserved_links[ref]
+                display_text = label if label else ref
+                return f"[{display_text}]({url})"
+            else:
+                # If the link is not in the mapping, return the original construction
+                return match.group(0)
+        elif ref.startswith("global#"):
+            # Handle links to typedef (similar logic as before)
+            typedef_name = ref.split("#")[1]
+            used_enumerations.add(typedef_name)
+            display_text = label if label else typedef_name
+            return f"[{display_text}]({root}Enumeration/{typedef_name}.md)"
+        else:
+            # Handle links to class methods like ClassName#MethodName
+            try:
+                class_name, method_name = ref.split("#")
+            except ValueError:
+                return match.group(0)
+            display_text = label if label else ref  # Keep the full notation, e.g., "Api#CreateSlide"
+            return f"[{display_text}]({root}{class_name}/Methods/{method_name}.md)"
+
+    return re.sub(r'{@link\s+([^}]+)}', replace_link, text)
+
+def correct_description(string, root=''):
+    """
+    Cleans or transforms specific tags in the doclet description:
+      - <b> => ** (bold text)
       - <note>...</note> => 💡 ...
-      - Provide a default if None.
+      - {@link ...} is replaced with a Markdown link
+      - If the description is missing, returns a default value.
+      - All '\r' characters are replaced with '\n'.
     """
     if string is None:
         return 'No description provided.'
+
+    # Line breaks
+    string = string.replace('\r', '\\\n')
     
-    # Replace <b> tags with markdown bold
-    string = re.sub(r'<b>', '**', string)
+    # Replace <b> tags with Markdown bold formatting
+    string = re.sub(r'<b>', '-**', string)
     string = re.sub(r'</b>', '**', string)
-    # Convert <note>...</note> to a little icon + text
+    
+    # Replace <note> tags with an icon and text
     string = re.sub(r'<note>(.*?)</note>', r'💡 \1', string, flags=re.DOTALL)
+    
+    # Process {@link ...} constructions
+    string = process_link_tags(string, root)
+    
     return string
 
 def correct_default_value(value, enumerations, classes):
-    if value is None:
+    if value is None or value == '':
         return ''
     
     if value == True:
@@ -120,62 +178,145 @@ def get_base_type(ts_type: str) -> str:
 
 def generate_data_types_markdown(types, enumerations, classes, root='../../'):
     """
-    1) Convert each raw JSDoc type from Array.<T> to T[].
-    2) Split union types if needed (usually they're provided as separate
-       elements in 'types' already, but let's be safe).
-    3) For each type, extract the base type (e.g. "Drawing" from "Drawing[]").
-    4) If the base type matches an enumeration or class, link the entire
-       T[]-based string.
-    5) Join with " | ".
+    1) Converts each type from JSDoc (e.g., Array.<T>) to T[].
+    2) Processes union types by splitting them using '|'.
+    3) Supports multidimensional arrays, e.g., (string|ApiRange|number)[].
+    4) If the base type matches the name of an enumeration or class, generates a link.
+    5) The final types are joined using " | ".
     """
+    # Convert each type from JSDoc format to TypeScript format (e.g., T[])
+    converted = [convert_jsdoc_array_to_ts(t) for t in types]
 
-    # Convert each raw type from JSDoc to TS
-    converted = [convert_jsdoc_array_to_ts(t) for t in types]  # e.g. ["Drawing[]", "Foo[]", ...]
+    # Set of primitive types
+    primitive_types = {"string", "number", "boolean", "null", "undefined", "any", "object", "false", "true", "json", "function", "{}"}
+
+    def is_primitive(type):
+        if (type.lower() in primitive_types or
+            (type.startswith('"') and type.endswith('"')) or
+            (type.startswith("'") and type.endswith("'")) or
+            type.replace('.', '', 1).isdigit() or
+            (type.startswith('-') and type[1:].replace('.', '', 1).isdigit())):
+            return True
+        return False
 
-    # For each converted type (like "Drawing[]"), see if the base is in enumerations or classes
     def link_if_known(ts_type):
-        base = get_base_type(ts_type)  # e.g. "Drawing" from "Drawing[]"
+        ts_type = ts_type.strip()
+        # Count the number of array dimensions, e.g., "[][]" has 2 dimensions
+        array_dims = 0
+        while ts_type.endswith("[]"):
+            array_dims += 1
+            ts_type = ts_type[:-2].strip()
 
-        # Check enumerations first
-        for enum in enumerations:
-            if enum['name'] == base:
-                # Replace the entire token with a link
-                return f"[{ts_type}]({root}Enumeration/{base}.md)"
+        # Process generic types, e.g., Object.<string, editorType>
+        if ".<" in ts_type and ts_type.endswith(">"):
+            import re
+            m = re.match(r'^(.*?)\.<(.*)>$', ts_type)
+            if m:
+                base_part = m.group(1).strip()
+                generic_args_str = m.group(2).strip()
+                # Process the base part of the type
+                found = False
+                for enum in enumerations:
+                    if enum['name'] == base_part:
+                        used_enumerations.add(base_part)
+                        base_result = f"[{base_part}]({root}Enumeration/{base_part}.md)"
+                        found = True
+                        break
+                if not found:
+                    if base_part in classes:
+                        base_result = f"[{base_part}]({root}{base_part}/{base_part}.md)"
+                    elif is_primitive(base_part):
+                        base_result = base_part
+                    elif cur_editor_name == "forms":
+                        base_result = f"[{base_part}]({root}../text-document-api/{base_part}/{base_part}.md)"
+                    else:
+                        print(f"Unknown type encountered: {base_part}")
+                        base_result = base_part
+                # Split the generic parameters by commas and process each recursively
+                generic_args = [link_if_known(x) for x in generic_args_str.split(",")]
+                result = base_result + ".&lt;" + ", ".join(generic_args) + "&gt;"
+                result += "[]" * array_dims
+                return result
 
-        # Check classes
-        if base in classes:
-            return f"[{ts_type}]({root}{base}/{base}.md)"
+        # Process union types: if the type is enclosed in parentheses
+        if ts_type.startswith("(") and ts_type.endswith(")"):
+            inner = ts_type[1:-1].strip()
+            subtypes = [sub.strip() for sub in inner.split("|")]
+            if len(subtypes) == 1:
+                result = link_if_known(subtypes[0])
+            else:
+                processed = [link_if_known(subtype) for subtype in subtypes]
+                result = "(" + " | ".join(processed) + ")"
+            result += "[]" * array_dims
+            return result
 
-        # Otherwise just return as-is
-        return ts_type
+        # If not a generic or union type – process the base type
+        else:
+            base = ts_type
+            found = False
+            for enum in enumerations:
+                if enum['name'] == base:
+                    used_enumerations.add(base)
+                    result = f"[{base}]({root}Enumeration/{base}.md)"
+                    found = True
+                    break
+            if not found:
+                if base in classes:
+                    result = f"[{base}]({root}{base}/{base}.md)"
+                elif is_primitive(base):
+                    result = base
+                elif cur_editor_name == "forms":
+                    result = f"[{base}]({root}../text-document-api/{base}/{base}.md)"
+                else:
+                    print(f"Unknown type encountered: {base}")
+                    result = base
+            result += "[]" * array_dims
+            return result
 
-    # Build final list of possibly-linked types
+    # Apply link_if_known to each converted type
     linked = [link_if_known(ts_t) for ts_t in converted]
 
-    # Join them with " | "
-    param_types_md = ' | '.join(linked)
+    # Join results using " | "
+    param_types_md = r' | '.join(linked)
+    param_types_md = param_types_md.replace("|", r"\|")
 
-    # If there's still leftover angle brackets for generics, gently escape or link them
-    # e.g. "Object.<string, number>" => "Object.&lt;string, number&gt;"
-    # or do more specialized linking if you want to handle them deeper.
+    # Escape remaining angle brackets for generics
     def replace_leftover_generics(match):
         element = match.group(1).strip()
         return f"&lt;{element}&gt;"
-    
+
     param_types_md = re.sub(r'<([^<>]+)>', replace_leftover_generics, param_types_md)
 
     return param_types_md
 
 def generate_class_markdown(class_name, methods, properties, enumerations, classes):
     content = f"# {class_name}\n\nRepresents the {class_name} class.\n\n"
+    
     content += generate_properties_markdown(properties, enumerations, classes)
 
-    content += "## Methods\n\n"
-    for method in methods:
+    content += "\n## Methods\n\n"
+    content += "| Method | Returns | Description |\n"
+    content += "| ------ | ------- | ----------- |\n"
+    
+    for method in sorted(methods, key=lambda m: m['name']):
         method_name = method['name']
-        content += f"- [{method_name}](./Methods/{method_name}.md)\n"
-
-    # Escape just before returning
+        
+        # Get the type of return values
+        returns = method.get('returns', [])
+        if returns:
+            return_type_list = returns[0].get('type', {}).get('names', [])
+            returns_markdown = generate_data_types_markdown(return_type_list, enumerations, classes, '../')
+        else:
+            returns_markdown = "None"
+        
+        # Processing the method description
+        description = remove_line_breaks(correct_description(method.get('description', 'No description provided.'), '../'))
+        
+        # Form a link to the method document
+        method_link = f"[{method_name}](./Methods/{method_name}.md)"
+        
+        content += f"| {method_link} | {returns_markdown} | {description} |\n"
+    
     return escape_text_outside_code_blocks(content)
 
 def generate_method_markdown(method, enumerations, classes):
@@ -186,7 +327,7 @@ def generate_method_markdown(method, enumerations, classes):
 
     method_name = method['name']
     description = method.get('description', 'No description provided.')
-    description = correct_description(description)
+    description = correct_description(description, '../../')
     params = method.get('params', [])
     returns = method.get('returns', [])
     memberof = method.get('memberof', '')
@@ -197,7 +338,7 @@ def generate_method_markdown(method, enumerations, classes):
     content = f"# {method_name}\n\n{description}\n\n"
     
     # Syntax
-    param_list = ', '.join([param['name'] for param in params]) if params else ''
+    param_list = ', '.join([param['name'] for param in params if '.' not in param['name']]) if params else ''
     content += f"## Syntax\n\n```javascript\nexpression.{method_name}({param_list});\n```\n\n"
     if memberof:
         content += f"`expression` - A variable that represents a [{memberof}](../{memberof}.md) class.\n\n"
@@ -211,7 +352,7 @@ def generate_method_markdown(method, enumerations, classes):
             param_name = param.get('name', 'Unnamed')
             param_types = param.get('type', {}).get('names', []) if param.get('type') else []
             param_types_md = generate_data_types_markdown(param_types, enumerations, classes)
-            param_desc = remove_line_breaks(correct_description(param.get('description', 'No description provided.')))
+            param_desc = remove_line_breaks(correct_description(param.get('description', 'No description provided.'), '../../'))
             param_required = "Required" if not param.get('optional') else "Optional"
             param_default = correct_default_value(param.get('defaultvalue', ''), enumerations, classes)
 
@@ -264,7 +405,7 @@ def generate_properties_markdown(properties, enumerations, classes, root='../'):
     content += "| Name | Type | Description |\n"
     content += "| ---- | ---- | ----------- |\n"
 
-    for prop in properties:
+    for prop in sorted(properties, key=lambda m: m['name']):
         prop_name = prop['name']
         prop_description = prop.get('description', 'No description provided.')
         prop_description = remove_line_breaks(correct_description(prop_description))
@@ -281,10 +422,13 @@ def generate_enumeration_markdown(enumeration, enumerations, classes):
     This version only works with `enumeration['examples']` (an array of strings),
     ignoring any single `enumeration['examples']` field.
     """
-
     enum_name = enumeration['name']
+
+    if enum_name not in used_enumerations:
+        return None
+    
     description = enumeration.get('description', 'No description provided.')
-    description = correct_description(description)
+    description = correct_description(description, '../')
 
     # Only use the 'examples' array
     examples = enumeration.get('examples', [])
@@ -309,6 +453,7 @@ def generate_enumeration_markdown(enumeration, enumerations, classes):
             for raw_t in enumeration['type']['names']:
                 # Attempt linking
                 if any(enum['name'] == raw_t for enum in enumerations):
+                    used_enumerations.add(raw_t)
                     content += f"- [{raw_t}](../Enumeration/{raw_t}.md)\n"
                 elif raw_t in classes:
                     content += f"- [{raw_t}](../{raw_t}/{raw_t}.md)\n"
@@ -364,27 +509,35 @@ def generate_enumeration_markdown(enumeration, enumerations, classes):
     return escape_text_outside_code_blocks(content)
 
 def process_doclets(data, output_dir, editor_name):
+    global cur_editor_name
+    cur_editor_name = editor_name
+
     classes = {}
     classes_props = {}
     enumerations = []
-    editor_dir =  os.path.join(output_dir, editor_name)
+    editor_dir = os.path.join(output_dir, editors[editor_name])
 
     for doclet in data:
         if doclet['kind'] == 'class':
             class_name = doclet['name']
-            classes[class_name] = []
-            classes_props[class_name] = doclet.get('properties', None)
+            if class_name:
+                if class_name not in classes:
+                    classes[class_name] = []
+                classes_props[class_name] = doclet.get('properties', None)
         elif doclet['kind'] == 'function':
             class_name = doclet.get('memberof')
             if class_name:
                 if class_name not in classes:
-                    classes[class_name] = []
+                        classes[class_name] = []
                 classes[class_name].append(doclet)
         elif doclet['kind'] == 'typedef':
             enumerations.append(doclet)
 
     # Process classes
     for class_name, methods in classes.items():
+        if (len(methods) == 0):
+            continue
+
         class_dir = os.path.join(editor_dir, class_name)
         methods_dir = os.path.join(class_dir, 'Methods')
         os.makedirs(methods_dir, exist_ok=True)
@@ -412,6 +565,13 @@ def process_doclets(data, output_dir, editor_name):
     enum_dir = os.path.join(editor_dir, 'Enumeration')
     os.makedirs(enum_dir, exist_ok=True)
 
+    # idle run
+    prev_used_count = -1
+    while len(used_enumerations) != prev_used_count:
+        prev_used_count = len(used_enumerations)
+        for enum in [e for e in enumerations if e['name'] in used_enumerations]:
+            enum_content = generate_enumeration_markdown(enum, enumerations, classes)
+
     for enum in enumerations:
         enum_file_path = os.path.join(enum_dir, f"{enum['name']}.md")
         enum_content = generate_enumeration_markdown(enum, enumerations, classes)
@@ -429,14 +589,15 @@ def generate(output_dir):
         output_dir = output_dir[:-1]
     
     generate_docs_plugins_json.generate(output_dir + '/tmp_json', md=True)
-    for editor_name in editors:
+    for editor_name, folder_name in editors.items():
         input_file = os.path.join(output_dir + '/tmp_json', editor_name + ".json")
 
-        shutil.rmtree(output_dir + f'/{editor_name.title()}', ignore_errors=True)
-        os.makedirs(output_dir + f'/{editor_name.title()}')
+        shutil.rmtree(output_dir + f'/{folder_name}', ignore_errors=True)
+        os.makedirs(output_dir + f'/{folder_name}')
 
         data = load_json(input_file)
-        process_doclets(data, output_dir, editor_name.title())
+        used_enumerations.clear()
+        process_doclets(data, output_dir, editor_name)
     
     shutil.rmtree(output_dir + '/tmp_json')
     print('Done')
@@ -448,7 +609,7 @@ if __name__ == "__main__":
         type=str, 
         help="Destination directory for the generated documentation",
         nargs='?',  # Indicates the argument is optional
-        default="../../../../office-js-api/Plugins/"  # Default value
+        default="../../../../office-js-api/plugins/"  # Default value
     )
     args = parser.parse_args()
     generate(args.destination)

scripts/sdkjs_common/jsdoc/generate_docs_plugins_md_site.py

@@ -0,0 +1,621 @@
+import os
+import json
+import re
+import shutil
+import argparse
+import generate_docs_plugins_json
+
+# Configuration files
+editors = {
+    "word": "text-document-api",
+    "cell": "spreadsheet-api",
+    "slide": "presentation-api",
+    "forms": "form-api"
+}
+
+missing_examples = []
+used_enumerations = set()
+
+cur_editor_name = None
+
+def load_json(file_path):
+    with open(file_path, 'r', encoding='utf-8') as f:
+        return json.load(f)
+
+def write_markdown_file(file_path, content):
+    with open(file_path, 'w', encoding='utf-8') as md_file:
+        md_file.write(content)
+
+def remove_js_comments(text):
+    text = re.sub(r'^\s*//.*$', '', text, flags=re.MULTILINE)  # single-line
+    text = re.sub(r'/\*.*?\*/', '', text, flags=re.DOTALL)     # multi-line
+    return text.strip()
+
+def process_link_tags(text, root=''):
+    """
+    Finds patterns like {@link ...} and replaces them with Markdown links.
+    If the prefix 'global#' is found, a link to a typedef is generated,
+    otherwise, a link to a class method is created.
+    For a method, if an alias is not specified, the name is left in the format 'Class#Method'.
+    """
+    reserved_links = {
+        '/docbuilder/global#ShapeType': f"{'../../../../../../' if root == '' else '../../../../../' if root == '../' else root}docs/office-api/usage-api/text-document-api/Enumeration/ShapeType.md",
+        '/plugin/config': 'https://api.onlyoffice.com/docs/plugin-and-macros/structure/manifest/',
+        '/docbuilder/basic': 'https://api.onlyoffice.com/docs/office-api/usage-api/text-document-api/'
+    }
+
+    def replace_link(match):
+        content = match.group(1).strip()  # Example: "/docbuilder/global#ShapeType shape type" or "global#ErrorValue ErrorValue"
+        parts = content.split()
+        ref = parts[0]
+        label = parts[1] if len(parts) > 1 else None
+
+        if ref.startswith('/'):
+            # Handle reserved links using mapping
+            if ref in reserved_links:
+                url = reserved_links[ref]
+                display_text = label if label else ref
+                return f"[{display_text}]({url})"
+            else:
+                # If the link is not in the mapping, return the original construction
+                return match.group(0)
+        elif ref.startswith("global#"):
+            # Handle links to typedef (similar logic as before)
+            typedef_name = ref.split("#")[1]
+            used_enumerations.add(typedef_name)
+            display_text = label if label else typedef_name
+            return f"[{display_text}]({root}Enumeration/{typedef_name}.md)"
+        else:
+            # Handle links to class methods like ClassName#MethodName
+            try:
+                class_name, method_name = ref.split("#")
+            except ValueError:
+                return match.group(0)
+            display_text = label if label else ref  # Keep the full notation, e.g., "Api#CreateSlide"
+            return f"[{display_text}]({root}{class_name}/Methods/{method_name}.md)"
+
+    return re.sub(r'{@link\s+([^}]+)}', replace_link, text)
+
+def correct_description(string, root=''):
+    """
+    Cleans or transforms specific tags in the doclet description:
+      - <b> => ** (bold text)
+      - <note>...</note> => 💡 ...
+      - {@link ...} is replaced with a Markdown link
+      - If the description is missing, returns a default value.
+      - All '\r' characters are replaced with '\n'.
+    """
+    if string is None:
+        return 'No description provided.'
+
+    # Line breaks
+    string = string.replace('\r', '\\\n')
+    
+    # Replace <b> tags with Markdown bold formatting
+    string = re.sub(r'<b>', '-**', string)
+    string = re.sub(r'</b>', '**', string)
+    
+    # Replace <note> tags with an icon and text
+    string = re.sub(r'<note>(.*?)</note>', r'💡 \1', string, flags=re.DOTALL)
+    
+    # Process {@link ...} constructions
+    string = process_link_tags(string, root)
+    
+    return string
+
+def correct_default_value(value, enumerations, classes):
+    if value is None or value == '':
+        return ''
+    
+    if value == True:
+        value = "true"
+    elif value == False:
+        value = "false"
+    else:
+        value = str(value)
+    
+    return generate_data_types_markdown([value], enumerations, classes)
+
+def remove_line_breaks(string):
+    return re.sub(r'[\r\n]+', ' ', string)
+
+# Convert Array.<T> => T[] (including nested arrays).
+def convert_jsdoc_array_to_ts(type_str: str) -> str:
+    """
+    Recursively replaces 'Array.<T>' with 'T[]',
+    handling nested arrays like 'Array.<Array.<string>>' => 'string[][]'.
+    """
+    pattern = re.compile(r'Array\.<([^>]+)>')
+    
+    while True:
+        match = pattern.search(type_str)
+        if not match:
+            break
+        
+        inner_type = match.group(1).strip()
+        # Recursively convert inner parts
+        inner_type = convert_jsdoc_array_to_ts(inner_type)
+        
+        # Replace the outer Array.<...> with ...[]
+        type_str = (
+            type_str[:match.start()] 
+            + f"{inner_type}[]" 
+            + type_str[match.end():]
+        )
+    
+    return type_str
+
+def escape_text_outside_code_blocks(markdown: str) -> str:
+    """
+    Splits content by fenced code blocks, escapes MDX-unsafe characters
+    (<, >, {, }) only in the text outside those code blocks.
+    """
+    # A regex to capture fenced code blocks with ```
+    parts = re.split(r'(```.*?```)', markdown, flags=re.DOTALL)
+    
+    # Even indices (0, 2, 4, ...) are outside code blocks,
+    # odd indices (1, 3, 5, ...) are actual code blocks.
+    for i in range(0, len(parts), 2):
+        # Only escape in parts outside code blocks
+        parts[i] = (parts[i]
+                    .replace('<', '&lt;')
+                    .replace('>', '&gt;')
+                    .replace('{', '&#123;')
+                    .replace('}', '&#125;')
+                   )
+    return "".join(parts)
+
+def get_base_type(ts_type: str) -> str:
+    """
+    Given a TypeScript-like type (e.g. "Drawing[][]"), return the
+    'base' portion by stripping trailing "[]". For "Drawing[][]",
+    returns "Drawing". For "Array.<Drawing>", you'd convert it first
+    to "Drawing[]" then return "Drawing".
+    """
+    while ts_type.endswith('[]'):
+        ts_type = ts_type[:-2]
+    return ts_type
+
+def generate_data_types_markdown(types, enumerations, classes, root='../../'):
+    """
+    1) Converts each type from JSDoc (e.g., Array.<T>) to T[].
+    2) Processes union types by splitting them using '|'.
+    3) Supports multidimensional arrays, e.g., (string|ApiRange|number)[].
+    4) If the base type matches the name of an enumeration or class, generates a link.
+    5) The final types are joined using " | ".
+    """
+    # Convert each type from JSDoc format to TypeScript format (e.g., T[])
+    converted = [convert_jsdoc_array_to_ts(t) for t in types]
+
+    # Set of primitive types
+    primitive_types = {"string", "number", "boolean", "null", "undefined", "any", "object", "false", "true", "json", "function", "{}"}
+
+    def is_primitive(type):
+        if (type.lower() in primitive_types or
+            (type.startswith('"') and type.endswith('"')) or
+            (type.startswith("'") and type.endswith("'")) or
+            type.replace('.', '', 1).isdigit() or
+            (type.startswith('-') and type[1:].replace('.', '', 1).isdigit())):
+            return True
+        return False
+
+    def link_if_known(ts_type):
+        ts_type = ts_type.strip()
+        # Count the number of array dimensions, e.g., "[][]" has 2 dimensions
+        array_dims = 0
+        while ts_type.endswith("[]"):
+            array_dims += 1
+            ts_type = ts_type[:-2].strip()
+
+        # Process generic types, e.g., Object.<string, editorType>
+        if ".<" in ts_type and ts_type.endswith(">"):
+            import re
+            m = re.match(r'^(.*?)\.<(.*)>$', ts_type)
+            if m:
+                base_part = m.group(1).strip()
+                generic_args_str = m.group(2).strip()
+                # Process the base part of the type
+                found = False
+                for enum in enumerations:
+                    if enum['name'] == base_part:
+                        used_enumerations.add(base_part)
+                        base_result = f"[{base_part}]({root}Enumeration/{base_part}.md)"
+                        found = True
+                        break
+                if not found:
+                    if base_part in classes:
+                        base_result = f"[{base_part}]({root}{base_part}/{base_part}.md)"
+                    elif is_primitive(base_part):
+                        base_result = base_part
+                    elif cur_editor_name == "forms":
+                        base_result = f"[{base_part}]({root}../text-document-api/{base_part}/{base_part}.md)"
+                    else:
+                        print(f"Unknown type encountered: {base_part}")
+                        base_result = base_part
+                # Split the generic parameters by commas and process each recursively
+                generic_args = [link_if_known(x) for x in generic_args_str.split(",")]
+                result = base_result + ".&lt;" + ", ".join(generic_args) + "&gt;"
+                result += "[]" * array_dims
+                return result
+
+        # Process union types: if the type is enclosed in parentheses
+        if ts_type.startswith("(") and ts_type.endswith(")"):
+            inner = ts_type[1:-1].strip()
+            subtypes = [sub.strip() for sub in inner.split("|")]
+            if len(subtypes) == 1:
+                result = link_if_known(subtypes[0])
+            else:
+                processed = [link_if_known(subtype) for subtype in subtypes]
+                result = "(" + " | ".join(processed) + ")"
+            result += "[]" * array_dims
+            return result
+
+        # If not a generic or union type – process the base type
+        else:
+            base = ts_type
+            found = False
+            for enum in enumerations:
+                if enum['name'] == base:
+                    used_enumerations.add(base)
+                    result = f"[{base}]({root}Enumeration/{base}.md)"
+                    found = True
+                    break
+            if not found:
+                if base in classes:
+                    result = f"[{base}]({root}{base}/{base}.md)"
+                elif is_primitive(base):
+                    result = base
+                elif cur_editor_name == "forms":
+                    result = f"[{base}]({root}../text-document-api/{base}/{base}.md)"
+                else:
+                    print(f"Unknown type encountered: {base}")
+                    result = base
+            result += "[]" * array_dims
+            return result
+
+    # Apply link_if_known to each converted type
+    linked = [link_if_known(ts_t) for ts_t in converted]
+
+    # Join results using " | "
+    param_types_md = r' | '.join(linked)
+    param_types_md = param_types_md.replace("|", r"\|")
+
+    # Escape remaining angle brackets for generics
+    def replace_leftover_generics(match):
+        element = match.group(1).strip()
+        return f"&lt;{element}&gt;"
+
+    param_types_md = re.sub(r'<([^<>]+)>', replace_leftover_generics, param_types_md)
+
+    return param_types_md
+
+def generate_class_markdown(class_name, methods, properties, enumerations, classes):
+    content = f"# {class_name}\n\nRepresents the {class_name} class.\n\n"
+    
+    content += generate_properties_markdown(properties, enumerations, classes)
+
+    content += "\n## Methods\n\n"
+    content += "| Method | Returns | Description |\n"
+    content += "| ------ | ------- | ----------- |\n"
+    
+    for method in sorted(methods, key=lambda m: m['name']):
+        method_name = method['name']
+        
+        # Get the type of return values
+        returns = method.get('returns', [])
+        if returns:
+            return_type_list = returns[0].get('type', {}).get('names', [])
+            returns_markdown = generate_data_types_markdown(return_type_list, enumerations, classes, '../')
+        else:
+            returns_markdown = "None"
+        
+        # Processing the method description
+        description = remove_line_breaks(correct_description(method.get('description', 'No description provided.'), '../'))
+        
+        # Form a link to the method document
+        method_link = f"[{method_name}](./Methods/{method_name}.md)"
+        
+        content += f"| {method_link} | {returns_markdown} | {description} |\n"
+    
+    return escape_text_outside_code_blocks(content)
+
+def generate_method_markdown(method, enumerations, classes):
+    """
+    Generates Markdown for a method doclet, relying only on `method['examples']`
+    (array of strings). Ignores any single `method['example']` field.
+    """
+
+    method_name = method['name']
+    description = method.get('description', 'No description provided.')
+    description = correct_description(description, '../../')
+    params = method.get('params', [])
+    returns = method.get('returns', [])
+    memberof = method.get('memberof', '')
+
+    # Use the 'examples' array only
+    examples = method.get('examples', [])
+
+    content = f"# {method_name}\n\n{description}\n\n"
+    
+    # Syntax
+    param_list = ', '.join([param['name'] for param in params if '.' not in param['name']]) if params else ''
+    content += f"## Syntax\n\n```javascript\nexpression.{method_name}({param_list});\n```\n\n"
+    if memberof:
+        content += f"`expression` - A variable that represents a [{memberof}](../{memberof}.md) class.\n\n"
+
+    # Parameters
+    content += "## Parameters\n\n"
+    if params:
+        content += "| **Name** | **Required/Optional** | **Data type** | **Default** | **Description** |\n"
+        content += "| ------------- | ------------- | ------------- | ------------- | ------------- |\n"
+        for param in params:
+            param_name = param.get('name', 'Unnamed')
+            param_types = param.get('type', {}).get('names', []) if param.get('type') else []
+            param_types_md = generate_data_types_markdown(param_types, enumerations, classes)
+            param_desc = remove_line_breaks(correct_description(param.get('description', 'No description provided.'), '../../'))
+            param_required = "Required" if not param.get('optional') else "Optional"
+            param_default = correct_default_value(param.get('defaultvalue', ''), enumerations, classes)
+
+            content += f"| {param_name} | {param_required} | {param_types_md} | {param_default} | {param_desc} |\n"
+    else:
+        content += "This method doesn't have any parameters.\n"
+
+    # Returns
+    content += "\n## Returns\n\n"
+    if returns:
+        return_type_list = returns[0].get('type', {}).get('names', [])
+        return_type_md = generate_data_types_markdown(return_type_list, enumerations, classes)
+        content += return_type_md
+    else:
+        content += "This method doesn't return any data."
+
+    # Process examples array
+    if examples:
+        if len(examples) > 1:
+            content += "\n\n## Examples\n\n"
+        else:
+            content += "\n\n## Example\n\n"
+
+        for i, ex_line in enumerate(examples, start=1):
+            # Remove JS comments
+            cleaned_example = remove_js_comments(ex_line).strip()
+
+            # Attempt splitting if the user used ```js
+            if '```js' in cleaned_example:
+                comment, code = cleaned_example.split('```js', 1)
+                comment = comment.strip()
+                code = code.strip()
+                if len(examples) > 1:
+                    content += f"**Example {i}:**\n\n{comment}\n\n"
+                
+                content += f"```javascript\n{code}\n```\n"
+            else:
+                if len(examples) > 1:
+                    content += f"**Example {i}:**\n\n{comment}\n\n"
+                # No special fences, just show as code
+                content += f"```javascript\n{cleaned_example}\n```\n"
+
+    return escape_text_outside_code_blocks(content)
+
+def generate_properties_markdown(properties, enumerations, classes, root='../'):
+    if properties is None:
+        return ''
+    
+    content = "## Properties\n\n"
+    content += "| Name | Type | Description |\n"
+    content += "| ---- | ---- | ----------- |\n"
+
+    for prop in sorted(properties, key=lambda m: m['name']):
+        prop_name = prop['name']
+        prop_description = prop.get('description', 'No description provided.')
+        prop_description = remove_line_breaks(correct_description(prop_description))
+        prop_types = prop['type']['names'] if prop.get('type') else []
+        param_types_md = generate_data_types_markdown(prop_types, enumerations, classes, root)
+        content += f"| {prop_name} | {param_types_md} | {prop_description} |\n"
+
+    # Escape outside code blocks
+    return escape_text_outside_code_blocks(content)
+
+def generate_enumeration_markdown(enumeration, enumerations, classes):
+    """
+    Generates Markdown documentation for a 'typedef' doclet.
+    This version only works with `enumeration['examples']` (an array of strings),
+    ignoring any single `enumeration['examples']` field.
+    """
+    enum_name = enumeration['name']
+
+    if enum_name not in used_enumerations:
+        return None
+    
+    description = enumeration.get('description', 'No description provided.')
+    description = correct_description(description, '../')
+
+    # Only use the 'examples' array
+    examples = enumeration.get('examples', [])
+
+    content = f"# {enum_name}\n\n{description}\n\n"
+
+    parsed_type = enumeration['type'].get('parsedType')
+    if not parsed_type:
+        # If parsedType is missing, just list 'type.names' if available
+        type_names = enumeration['type'].get('names', [])
+        if type_names:
+            content += "## Type\n\n"
+            t_md = generate_data_types_markdown(type_names, enumerations, classes)
+            content += t_md + "\n\n"
+    else:
+        ptype = parsed_type['type']
+
+        # 1) Handle TypeUnion
+        if ptype == 'TypeUnion':
+            content += "## Type\n\nEnumeration\n\n"
+            content += "## Values\n\n"
+            for raw_t in enumeration['type']['names']:
+                # Attempt linking
+                if any(enum['name'] == raw_t for enum in enumerations):
+                    used_enumerations.add(raw_t)
+                    content += f"- [{raw_t}](../Enumeration/{raw_t}.md)\n"
+                elif raw_t in classes:
+                    content += f"- [{raw_t}](../{raw_t}/{raw_t}.md)\n"
+                else:
+                    content += f"- {raw_t}\n"
+
+        # 2) Handle TypeApplication (e.g. Object.<string, string>)
+        elif ptype == 'TypeApplication':
+            content += "## Type\n\nObject\n\n"
+            type_names = enumeration['type'].get('names', [])
+            if type_names:
+                t_md = generate_data_types_markdown(type_names, enumerations, classes)
+                content += f"**Type:** {t_md}\n\n"
+
+        # 3) If properties are present, treat it like an object
+        if enumeration.get('properties') is not None:
+            content += generate_properties_markdown(enumeration['properties'], enumerations, classes)
+
+        # 4) If it's neither TypeUnion nor TypeApplication, just output the type names
+        if ptype not in ('TypeUnion', 'TypeApplication'):
+            type_names = enumeration['type'].get('names', [])
+            if type_names:
+                content += "## Type\n\n"
+                t_md = generate_data_types_markdown(type_names, enumerations, classes)
+                content += t_md + "\n\n"
+
+    # Process examples array
+    if examples:
+        if len(examples) > 1:
+            content += "\n\n## Examples\n\n"
+        else:
+            content += "\n\n## Example\n\n"
+
+        for i, ex_line in enumerate(examples, start=1):
+            # Remove JS comments
+            cleaned_example = remove_js_comments(ex_line).strip()
+
+            # Attempt splitting if the user used ```js
+            if '```js' in cleaned_example:
+                comment, code = cleaned_example.split('```js', 1)
+                comment = comment.strip()
+                code = code.strip()
+                if len(examples) > 1:
+                    content += f"**Example {i}:**\n\n{comment}\n\n"
+                
+                content += f"```javascript\n{code}\n```\n"
+            else:
+                if len(examples) > 1:
+                    content += f"**Example {i}:**\n\n{comment}\n\n"
+                # No special fences, just show as code
+                content += f"```javascript\n{cleaned_example}\n```\n"
+
+    return escape_text_outside_code_blocks(content)
+
+def process_doclets(data, output_dir, editor_name):
+    global cur_editor_name
+    cur_editor_name = editor_name
+
+    classes = {}
+    classes_props = {}
+    enumerations = []
+    editor_dir = os.path.join(output_dir, editors[editor_name])
+
+    for doclet in data:
+        if doclet['kind'] == 'class':
+            class_name = doclet['name']
+            if class_name:
+                if class_name not in classes:
+                    classes[class_name] = []
+                classes_props[class_name] = doclet.get('properties', None)
+        elif doclet['kind'] == 'function':
+            class_name = doclet.get('memberof')
+            if class_name:
+                if class_name not in classes:
+                        classes[class_name] = []
+                classes[class_name].append(doclet)
+        elif doclet['kind'] == 'typedef':
+            enumerations.append(doclet)
+
+    # Process classes
+    for class_name, methods in classes.items():
+        if (len(methods) == 0):
+            continue
+
+        class_dir = os.path.join(editor_dir, class_name)
+        methods_dir = os.path.join(class_dir, 'Methods')
+        os.makedirs(methods_dir, exist_ok=True)
+
+        # Write class file
+        class_content = generate_class_markdown(
+            class_name, 
+            methods, 
+            classes_props[class_name], 
+            enumerations, 
+            classes
+        )
+        write_markdown_file(os.path.join(class_dir, f"{class_name}.md"), class_content)
+
+        # Write method files
+        for method in methods:
+            method_file_path = os.path.join(methods_dir, f"{method['name']}.md")
+            method_content = generate_method_markdown(method, enumerations, classes)
+            write_markdown_file(method_file_path, method_content)
+
+            if not method.get('examples', ''):
+                missing_examples.append(os.path.relpath(method_file_path, output_dir))
+
+    # Process enumerations
+    enum_dir = os.path.join(editor_dir, 'Enumeration')
+    os.makedirs(enum_dir, exist_ok=True)
+
+    # idle run
+    prev_used_count = -1
+    while len(used_enumerations) != prev_used_count:
+        prev_used_count = len(used_enumerations)
+        for enum in [e for e in enumerations if e['name'] in used_enumerations]:
+            enum_content = generate_enumeration_markdown(enum, enumerations, classes)
+
+    for enum in enumerations:
+        enum_file_path = os.path.join(enum_dir, f"{enum['name']}.md")
+        enum_content = generate_enumeration_markdown(enum, enumerations, classes)
+        if enum_content is None:
+            continue
+
+        write_markdown_file(enum_file_path, enum_content)
+        if not enum.get('examples', ''):
+            missing_examples.append(os.path.relpath(enum_file_path, output_dir))
+
+def generate(output_dir):
+    print('Generating Markdown documentation...')
+    
+    if output_dir[-1] == '/':
+        output_dir = output_dir[:-1]
+    
+    generate_docs_plugins_json.generate(output_dir + '/tmp_json', md=True)
+    for editor_name, folder_name in editors.items():
+        input_file = os.path.join(output_dir + '/tmp_json', editor_name + ".json")
+
+        editor_folder_path = os.path.join(output_dir, folder_name)
+        for folder_name in os.listdir(editor_folder_path):
+            folder_path_to_del = os.path.join(editor_folder_path, folder_name)
+            if os.path.isdir(folder_path_to_del):
+                shutil.rmtree(folder_path_to_del, ignore_errors=True)
+
+        data = load_json(input_file)
+        used_enumerations.clear()
+        process_doclets(data, output_dir, editor_name)
+    
+    shutil.rmtree(output_dir + '/tmp_json')
+    print('Done')
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Generate documentation")
+    parser.add_argument(
+        "destination", 
+        type=str, 
+        help="Destination directory for the generated documentation",
+        nargs='?',  # Indicates the argument is optional
+        default="../../../../api.onlyoffice.com/site/docs/plugin-and-macros/interacting-with-editors/methods/"  # Default value
+    )
+    args = parser.parse_args()
+    generate(args.destination)
+    print("START_MISSING_EXAMPLES")
+    print(",".join(missing_examples))
+    print("END_MISSING_EXAMPLES")

scripts/sdkjs_common/jsdoc/generate_jsonl_dataset.py

@@ -0,0 +1,248 @@
+import os
+import json
+import re
+import shutil
+import argparse
+import generate_docs_json
+from datetime import datetime
+
+# Configuration files
+editors = [
+    "word",
+    "cell",
+    "slide",
+    "forms"
+]
+
+root = '../../../..'
+missing_examples = []
+
+def load_json(file_path):
+    with open(file_path, 'r', encoding='utf-8') as f:
+        return json.load(f)
+
+def read_file_content(file_path):
+    try:
+        with open(file_path, encoding='utf-8') as f:
+            return f.read()
+    except Exception as e:
+        missing_examples.append(file_path)
+        # print(f"Failed to open file {file_path}: {e}")
+        return ""
+
+def extract_js_comments_as_text(text):
+    # Extract single-line comments (after //)
+    single_line_comments = re.findall(r'^\s*//(.*)$', text, flags=re.MULTILINE)
+    # Extract multi-line comments (between /* and */)
+    multi_line_comments = re.findall(r'/\*(.*?)\*/', text, flags=re.DOTALL)
+    # Combine all found comments into a single list
+    all_comments = single_line_comments + multi_line_comments
+    # Join comments into a single text, separated by a space
+    return " ".join(comment.strip() for comment in all_comments if comment.strip())
+
+def extract_examples_blocks(content: str):
+    blocks = []
+    current_block = {"comments": [], "code": []}
+    in_comment_section = True  # Collect comments until code appears
+    current_comment_group = []  # Accumulate lines of the current comment
+
+    for line in content.splitlines():
+        stripped = line.strip()
+        if not stripped:
+            # Empty line
+            if in_comment_section and current_comment_group:
+                # Finish the current comment group
+                comment_text = " ".join(current_comment_group)
+                current_block["comments"].append(comment_text)
+                current_comment_group = []
+            elif not in_comment_section:
+                # Empty line in the code – keep it as is
+                current_block["code"].append(line)
+            continue
+
+        if stripped.startswith("//"):
+            if in_comment_section:
+                # Remove comment marker and extra spaces
+                current_comment_group.append(extract_js_comments_as_text(stripped))
+            else:
+                # Comment after code starts – finish the current block and start a new one
+                blocks.append({
+                    "comments": current_block["comments"],
+                    "code": "\n".join(current_block["code"]).rstrip()
+                })
+                current_block = {"comments": [], "code": []}
+                in_comment_section = True
+                # Start a new comment group with the current line
+                current_comment_group = [stripped[2:].strip()]
+        else:
+            # Code line
+            if in_comment_section:
+                if current_comment_group:
+                    comment_text = " ".join(current_comment_group)
+                    current_block["comments"].append(comment_text)
+                    current_comment_group = []
+                in_comment_section = False
+            current_block["code"].append(line)
+
+    # Finalize any remaining comment group
+    if in_comment_section and current_comment_group:
+        comment_text = " ".join(current_comment_group)
+        current_block["comments"].append(comment_text)
+    # Save the last block if it's not empty
+    if current_block["comments"] or current_block["code"]:
+        blocks.append({
+            "comments": current_block["comments"],
+            "code": "\n".join(current_block["code"]).rstrip()
+        })
+
+    return blocks
+
+def extract_examples_blocks_temp(content: str):
+    lines = content.splitlines()
+    comment_blocks = []
+    current_group = []
+    first_code_index = None
+
+    for i, line in enumerate(lines):
+        stripped = line.strip()
+        if not stripped:
+            if current_group:
+                comment_blocks.append(" ".join(current_group))
+                current_group = []
+            continue
+        if stripped.startswith("//"):
+            current_group.append(stripped[2:].strip())
+        else:
+            if current_group:
+                comment_blocks.append(" ".join(current_group))
+                current_group = []
+            first_code_index = i
+            break
+
+    code_part = ""
+    if first_code_index is not None:
+        code_part = "\n".join(lines[first_code_index:]).rstrip()
+
+    return [{"comments": comment_blocks, "code": code_part}]
+
+def create_entry(system_message, user_message, assistant_message, model):
+    entry = {
+        "created_at": datetime.now().isoformat(" "),
+        "messages": [
+            {"role": "system", "content": system_message},
+            {"role": "user", "content": user_message},
+            {"role": "assistant", "content": assistant_message}
+        ],
+        "recommended": False,
+        "upvoted": True
+    }
+
+    if model is not "":
+        entry["model"] = model
+
+    return entry 
+
+def process_doclets(doclets, output_entries, editor_name, model):
+    for doclet in doclets:
+        kind = doclet.get("kind", "").lower()
+        see = doclet.get("see", [])
+        
+        # The "see" field must always be present
+        if not see:
+            continue
+        
+        # Processing based on the "kind" value
+        if kind == "function":
+            method_name = doclet.get("name", "")
+            memberof = doclet.get("memberof", "")
+            # Functions must have both "name" (method_name) and "memberof" fields filled
+            if not (method_name and memberof):
+                continue
+            system_message = (
+                f"You act as an API expert for Onlyoffice {editor_name.title()} editor. "
+                f"This task is an example for the function {method_name} in the class {memberof}."
+            )
+            default_user_message = f"How do I use the method {method_name} of {memberof} class?"
+            
+        elif kind == "class":
+            class_name = doclet.get("name", "")
+            system_message = (
+                f"You act as an API expert for Onlyoffice {editor_name.title()} editor. "
+                f"This task is an example for the class {class_name}."
+            )
+            default_user_message = f"How do I instantiate or work with the class {class_name}?"
+            
+        elif kind == "typedef":
+            typedef_name = doclet.get("name", "")
+            system_message = (
+                f"You act as an API expert for Onlyoffice {editor_name.title()} editor. "
+                f"This task is an example for the typedef {typedef_name}"
+            )
+            default_user_message = f"How do I use the typedef {typedef_name}?"
+            
+        else:
+            continue
+        
+        # Read the content of the first file listed in the "see" field
+        content = read_file_content(f'{root}/{see[0]}')
+        if content == "":
+            continue
+        
+        # now use only first block cause there is bad comments in examples
+        blocks = extract_examples_blocks_temp(content)
+        
+        for block in blocks:
+            assistant_message = block['code']
+
+            # default entry
+            output_entries.append(create_entry(system_message, default_user_message, assistant_message, model))
+
+            # If the file content contains comments, create a separate entry for each one
+            for comment in block['comments']:
+                output_entries.append(create_entry(system_message, comment, assistant_message, model))
+            
+def generate(output_dir, model):
+    print('Generating documentation JSONL dataset...')
+    
+    shutil.rmtree(output_dir, ignore_errors=True)
+    os.makedirs(output_dir)
+
+    generate_docs_json.generate(f'{output_dir}/tmp_json')
+    
+    output_entries = []
+    output_filename = "dataset.jsonl"
+
+    for editor_name in editors:
+        input_file = os.path.join(f'{output_dir}/tmp_json', editor_name + ".json")
+        doclets = load_json(input_file)
+        process_doclets(doclets, output_entries, editor_name, model)
+    
+    with open(f'{output_dir}/{output_filename}', "w", encoding="utf-8") as out_file:
+        for entry in output_entries:
+            out_file.write(json.dumps(entry, ensure_ascii=False) + "\n")
+
+    shutil.rmtree(f'{output_dir}/tmp_json')
+    print('Done')
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Generate documentation JSONL dataset")
+    parser.add_argument(
+        "destination", 
+        type=str, 
+        help="Destination directory for the generated documentation",
+        nargs='?',  # Indicates the argument is optional
+        default="../../../../office-js-api/dataset"  # Default value
+    )
+    parser.add_argument(
+        "model", 
+        type=str, 
+        help="Type of model",
+        nargs='?',  # Indicates the argument is optional
+        default=""  # Default value
+    )
+    args = parser.parse_args()
+
+    generate(args.destination, args.model)
+    print("START_MISSING_EXAMPLES")
+    print(",".join(missing_examples))
+    print("END_MISSING_EXAMPLES")

sln.json

@@ -93,7 +93,7 @@
     
     "[win]desktop-apps/win-linux/extras/projicons/ProjIcons.pro",
     "[win,!win_xp]desktop-apps/win-linux/extras/update-daemon/UpdateDaemon.pro",
-    "[win,!win_xp]desktop-apps/win-linux/extras/online-installer/OnlineInstaller.pro"
+    "[win_xp]desktop-apps/win-linux/extras/online-installer/OnlineInstaller.pro"
   ],
 
   "mobile" : [

version

@@ -1 +1 @@
-8.2.2
+8.3.1