Introducing ALDoc: a new command line tool for generating reference documentation for AL extensions
With the latest pre-release version of the AL extension, Microsot shipped a tool called ALDoc for generating reference documentation for AL extensions. The ALDo
Microsoft recently introduced a command-line tool for generating reference documentation for AL extensions named ALDoc. Incorporated in the pre-release version of AL extensions, this tool utilizes symbolic, syntactical and structural information from the input .app files to create documentation. It allows the generation of help sites, both public and private, categorized according to application structure. ALDoc, based on DocFx, converts .NET assemblies, XML code comment, REST API Swagger files, and markdown into HTML pages, JSON models, or PDF files.
To use this tool, .NET SDK 6.0 or higher is required along with the installation of the DocFx tool using the command: “dotnet tool update -g docfx”. After successful installation, users can start creating reference documentation for AL extensions. You need to first locate the installation path of the ALDoc tool according to your AL language extension version. Then two folders are needed: One for .app files requiring documentation and another for the generated files.
To start, initialization of the reference repo is necessary by providing the required command. Post initialization, AL support files are unpacked and the input folder for the DocFx tool is created inclusive of the DocFx configuration file. Lastly, reference files must be generated for each .app file.
About the ALDoc tool
The ALDoc is a new-fangled tool by Microsoft, designed to streamline the process of generating reference documentation for AL extensions. As a .NET tool-based approach, it provides assistance through symbolic, syntactical, and structural information garnered from the provided .app files. The means of output for ALDoc varies, ranging from HTML pages and JSON models to even PDF files, catering to varied user preferences. The accessibility to create private or public help sites also makes ALDoc a user-friendly and multi-functional tool, only requiring the installation of relevant .NET files to get starting on generating high-quality documentation.
Read the full article Introducing ALDoc: a new command line tool for generating reference documentation for AL extensions
Learn about Introducing ALDoc: a new command line tool for generating reference documentation for AL extensions
Microsoft's ALDoc is a command line tool to generate reference documentation for AL extensions. It takes symbolic and syntactical information, code comments, and overall application structure based on input .app files to generate documentation and a help site (private or public) with the reference articles.
ALDoc is based on the DocFx tool, a .NET tool that converts .NET assemblies, XML code comment, REST API Swagger files and markdown into rendered HTML pages, JSON model or PDF files. To use ALDoc for generating documentations from AL extensions, one needs to install .NET SDK 6.0 or higher and then install the DocFx tool. To create a reference documantation site for an AL extension, some steps need to be followed. First, one needs to check the installation path of the ALDoc tool. Then, create two folders, one for the .app files for generating documentation and the other for ALDoc generated files. As a first step, initialize the reference repo by providing the command. This will unpack AL support files and create the input folder for the DocFx tool. Finally, generate the reference files for each .app file specified.
More links on about Introducing ALDoc: a new command line tool for generating reference documentation for AL extensions
- Introducing ALDoc: a new command line tool for ...
- Introducing ALDoc: a new command line tool for generating reference documentation for AL extensions · Related stories ...
- Generating help with the ALDoc tool - Business Central
- Aug 10, 2023 — The ALDoc tool generates documentation from symbolic and syntactical information, code comments, and overall application structure based on ...
- YUN ZHU - Dynamics 365 Business Central
- Business Central developer news in AL Home 2023-08-18: Introducing ALDoc: a new command line tool for generating reference documentation for AL extensions ...
- AL XML Documentation
- Mar 16, 2022 — Extension for Visual Studio Code - Generate XML documentation comments for AL source code and create markdown documentation from it.
- AU-1 Air University Style and Author Guide
- Jun 12, 2017 — an important reference tool for all AU writers, and I highly encourage its use. ... Create a new document on your word processor.240 pages
- State of Alabama
- Aug 17, 2005 — Appointing Authority: ADOC Commissioner. C. Counseling Session: An informal corrective tool used to advise, counsel, or coach an employee.
Keywords
ALDoc, AL Extension, Command Line Tool, DocFx, .NET SDK, .app File, JSON Model, HTML Pages, REST API Swagger, Markdown