SGlibHelpTutorials

by Tim C. Lueth, SG-Lib Toolbox: SolidGeometry 5.6 - CODING/DEVELOP
Introduced first in SolidGeometry 5.5, Creation date: 2025-08-05, Last change: 2025-08-21

A feature for tutorial authors that provides hyperlinks to display and open existing tutorials.

Description

The mfiles can be converted using
mfile2mlxfile4markup force
mfile2mlxfile4markup help
into html in the "SGLIB_HELP_Structures/html/" folder[spchk]

See Also: mfile2mlxfile4markup

Example Illustration

missing image of SGlibHelpTutorials

Syntax

llc=SGlibHelpTutorials

Output Parameter

llc:

Examples


SGlibHelpTutorials % shows the files and opens it by clicking on the link



Copyright 2025 Tim C. Lueth. All rights reserved. The code is the property of Tim C. Lueth and may not be redistributed or modified without explicit written permission. This software may be used free of charge for academic research and teaching purposes only. Commercial use, redistribution, modification, or reverse engineering is strictly prohibited. Access to source code is restricted and granted only under specific agreements. For licensing inquiries or commercial use, please contact: Tim C. Lueth

Algorithm (Workflow)

This function, SGlibHelpTutorials, is designed to generate a list of hyperlinks to MATLAB files that match a specific naming pattern. The function does not take any input parameters and outputs a cell array of hyperlinks.

Input Parameters

There are no input parameters for this function.

Output

The function returns llc, a cell array where each element is a hyperlink to a MATLAB file.

Algorithm Steps

  1. The function uses the dir function to search for files in the current directory that match the pattern 'HELP_SGLIB_*.m'. This pattern indicates that the function is looking for MATLAB files that start with HELP_SGLIB_.
  2. An empty cell array llc is initialized with the same number of elements as the number of files found by dir.
  3. A for loop iterates over each file found by dir:
    • For each file, the full file path is constructed by concatenating the folder path and the file name using filesep to ensure the correct file separator is used.
    • The function strhyperlinkmatlab is called with the file name, full file path, and the string 'edit' to create a hyperlink. This function is assumed to generate a hyperlink that, when clicked, opens the file in MATLAB's editor.
    • The generated hyperlink is stored in the corresponding position in the llc cell array.
  4. After the loop completes, the cell array llc containing all the hyperlinks is returned as the output.
Algorithm explaination created using ChatGPT on 2025-08-18 23:26. (Please note: No guarantee for the correctness of this explanation)

Last html export of this page out of FM database by TL: 2025-09-21