SGlibedithtmlhelptext
by Tim C. Lueth, SG-Lib Toolbox: SolidGeometry 5.6 - CODING/DEVELOP
Introduced first in SolidGeometry 4.8, Creation date: 2019-10-22, Last change: 2025-09-14
open the html help text in the 'SGLIB_HELP_Structures/html' folder
Description
Most of the html files are created by the FM database. Sometimes it makes sense to edit them and to save them as UTF8 !!!!
See Also: editTL
Example Illustration
Syntax
SGlibedithtmlhelptext(Fname)
Input Parameter
Examples
SGedithtmlhelptext PLcircle
Copyright 2019-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, SGlibedithtmlhelptext, is designed to open and edit HTML help text files associated with the SolidGeometry library. The function takes a single input parameter:
Input Parameter
- Fname: This is the name of the function for which the HTML help text file needs to be edited. It is a string representing the function's name.
Algorithm Steps
- The function begins by determining the current working directory using the
workdir function, which is stored in the variable wd.
- It constructs the file path for the HTML file associated with the function name provided in
Fname. This is done by concatenating the working directory path with the subdirectory 'SGLIB_HELP_Structures/html' and appending the function name with an '.html' extension.
- The constructed file path is stored in the variable
fname.
- The function then calls
editTL(fname), which is assumed to be a function that opens the specified HTML file for editing.
- Finally, the function uses
web(fname) to open the HTML file in a web browser, allowing the user to view the help text.
This function is part of the SolidGeometry library and was introduced in version 4.8. It is intended to facilitate the editing and viewing of HTML help files, which are typically generated by the FM database but may require manual editing and saving in UTF-8 format.
Algorithm explaination created using ChatGPT on 2025-08-18 22:51. (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