Generating help with the ALDoc tool for Business Central Application

I will share with you some of the tips to generate Help document for your business Central custom Application

below are some basic links that you can refer.

Erik hougaard`s Recorderd Session

https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/help/help-aldoc-generate-help

https://dotnet.github.io/docfx/index.html

• Prerequisites.

VScode installed

.App file with path

VS Code extension (AL Language Extension for MSDBC Version 12.0.858079 or above)

• Check .Net Versions installed in machine

dotnet --list-sdks        

You will face below error if you don't have correct version installed

Download and installed correct version from given link https://dotnet.microsoft.com/download

>> install Docfx with below command

dotnet tool install docfx --version 2.70 -g        

Create text file save it in folder as .Bat format

C:\Users\<user>\.vscode\extensions\ms-dynamics-smb.al-12.0.836604\bin\win32\aldoc.exe

Version and User name may differ in your case , Make sure to change it.

rd output /s/q
md output

rem init
C:\Users\Sumit\.vscode\extensions\ms-dynamics-smb.al-12.0.858079\bin\win32\aldoc.exe init -o ./output -t "C:\Users\Sumit\Desktop\Docker\BCin\Textapp\Default publisher_Textapp_1.0.0.0.app"

rem Build
C:\Users\Sumit\.vscode\extensions\ms-dynamics-smb.al-12.0.858079\bin\win32\aldoc.exe build -o ./output -s "C:\Users\Sumit\Desktop\Docker\BCin\Textapp\Default publisher_Textapp_1.0.0.0.app"

rem DocxFx Build
docfx build ./output/docfx.json

rem DocxFx Server
docfx serve ./output/_site -p 8989        

if you not specify -p parameter it will give you 8080 port to your site.

in my case it is 8989 so it will publish with https://localhost:8989 link.

my run.bat file is available in C/buildDocx

So, i will have to use CD command to change the path in command prompt.

use filename as command in cmd my file name run so command name will be run

if your file name is xyz.bat ,you have to use xyz in cmd