search

MicrosoftDocs / nav-content

Source for application Help for Microsoft Dynamics NAV
Creative Commons Attribution 4.0 International
39 stars 81 forks source link

Building the HTML files does not work #11

Closed mitrov closed 6 years ago

mitrov commented 6 years ago

Hi When I try generating the help files with docfx I get a lot of warnings and I don't see any html files in my C:\output folder. 

C:\Temp\docfx>docfx "C:\Users\dzmi\Documents\GitHub\nav-content\dynamics-nav-app\NAVdocfx.json"
[17-09-21 01:20:37.236]Info:[BuildCommand]5 plug-in(s) loaded.
[17-09-21 01:20:37.364]Info:[BuildCommand]Markdown engine is dfm
[17-09-21 01:20:37.472]Info:[BuildCommand.BuildCore.Build Document]Max parallelism is 8.
[17-09-21 01:20:38.596]Info:[BuildCommand.BuildCore.Build Document.CompilePhaseHandlerWithIncremental.TocDocumentProcessor]Building 1 file(s) in TocDocumentProcessor(BuildTocDocument)...
[17-09-21 01:20:38.597]Info:[BuildCommand.BuildCore.Build Document.CompilePhaseHandlerWithIncremental.ConceptualDocumentProcessor]Building 0 file(s) in ConceptualDocumentProcessor(BuildConceptualDocument=>CountWord=>ValidateConceptualDocumentMetadata)...
[17-09-21 01:20:38.597]Info:[BuildCommand.BuildCore.Build Document.CompilePhaseHandlerWithIncremental.RestApiDocumentProcessor]Building 0 file(s) in RestApiDocumentProcessor(BuildRestApiDocument=>ValidateRestApiDocumentMetadata=>ApplyOverwriteDocumentForRestApi)...
[17-09-21 01:20:38.598]Info:[BuildCommand.BuildCore.Build Document.CompilePhaseHandlerWithIncremental.ManagedReferenceDocumentProcessor]Building 0 file(s) in ManagedReferenceDocumentProcessor(BuildManagedReferenceDocument=>ValidateManagedReferenceDocumentMetadata=>ApplyOverwriteDocumentForMref=>FillReferenceInformation)...
[17-09-21 01:20:38.598]Info:[BuildCommand.BuildCore.Build Document.CompilePhaseHandlerWithIncremental.ResourceDocumentProcessor]Building 3 file(s) in ResourceDocumentProcessor(ValidateResourceMetadata)...
[17-09-21 01:20:38.784]Info:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.Apply Templates]Applying templates to 4 model(s)...
[17-09-21 01:20:38.786]Warning:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.Apply Templates]There is no template processing document type(s): Toc
[17-09-21 01:20:38.827]Warning:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save](ca-finance-tax.md#L15)Invalid file link:(~/us-finance-setup-sales-tax.md).
[17-09-21 01:20:38.828]Warning:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save](ca-finance-tax.md#L23)Invalid file link:(~/us-finance-setup-sales-tax.md).
[17-09-21 01:20:38.829]Warning:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save](us-finance-sales-tax.md#L34)Invalid file link:(~/ca-finance-setup-tax.md).
[17-09-21 01:20:38.829]Warning:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save](finance-account-schedule.md#L25)Invalid file link:(~/finance-setup-general-ledger.md).
[17-09-21 01:20:38.829]Warning:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save](finance-account-schedule.md#L29)Invalid file link:(~/finance-setup-general-ledger.md).
[17-09-21 01:20:38.829]Warning:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save](finance-setup-chart-accounts.md#L31)Invalid file link:(~/ca-finance-setup-work-GiFI-codes.md).
[17-09-21 01:20:38.829]Warning:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save](finance-setup-chart-accounts.md#L28)Invalid file link:(~/finance-setup-general-ledger.md).
[17-09-21 01:20:38.830]Warning:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save](finance-how-defer-revenue-expenses.md#L21)Invalid file link:(~/finance-setup-general-ledger.md).
[17-09-21 01:20:38.830]Warning:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save](finance.md#L27)Invalid file link:(~/finance-setup-general-ledger.md).
[17-09-21 01:20:38.875]Info:[BuildCommand.BuildCore.Build Document]XRef map exported.
[17-09-21 01:20:38.964]Info:[BuildCommand.Postprocess]Manifest file saved to manifest.json.
[17-09-21 01:20:39.024]Info:[BuildCommand]Completed building documents in 1780.7331 milliseconds.
[17-09-21 01:20:39.026]Info:[BuildCommand]Completed Scope:BuildCommand in 1868.5505 milliseconds.
[17-09-21 01:20:39.027]Info:Completed in 1871.6327 milliseconds

Build succeeded with warning.
[17-09-21 01:20:39.033]Warning:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.Apply Templates]There is no template processing document type(s): Toc
[17-09-21 01:20:39.033]Warning:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save](ca-finance-tax.md#L15)Invalid file link:(~/us-finance-setup-sales-tax.md).
[17-09-21 01:20:39.034]Warning:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save](ca-finance-tax.md#L23)Invalid file link:(~/us-finance-setup-sales-tax.md).
[17-09-21 01:20:39.034]Warning:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save](us-finance-sales-tax.md#L34)Invalid file link:(~/ca-finance-setup-tax.md).
[17-09-21 01:20:39.034]Warning:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save](finance-account-schedule.md#L25)Invalid file link:(~/finance-setup-general-ledger.md).
[17-09-21 01:20:39.034]Warning:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save](finance-account-schedule.md#L29)Invalid file link:(~/finance-setup-general-ledger.md).
[17-09-21 01:20:39.034]Warning:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save](finance-setup-chart-accounts.md#L31)Invalid file link:(~/ca-finance-setup-work-GiFI-codes.md).
[17-09-21 01:20:39.035]Warning:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save](finance-setup-chart-accounts.md#L28)Invalid file link:(~/finance-setup-general-ledger.md).
[17-09-21 01:20:39.035]Warning:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save](finance-how-defer-revenue-expenses.md#L21)Invalid file link:(~/finance-setup-general-ledger.md).
[17-09-21 01:20:39.035]Warning:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.ConceptualDocumentProcessor.Save](finance.md#L27)Invalid file link:(~/finance-setup-general-ledger.md).
        10 Warning(s)
        0 Error(s)

What I did:

edupont04 commented 6 years ago

Hi Mitrov, It looks like the latest version of DocFx.exe is less forgiving than the previous. I've made some changes in the source to fix broken links, and I made some changes in the NAVDocFx.json config file. It "works on my box" now, so can you pull the changes and verify on your box?

thanks!

mitrov commented 6 years ago

Thanks a lot! It looks better now. The output folder now has the HTML files.

However there is one more warning concerning the TOC: "There is no template processing document type(s): Toc" I cannot find the TOC in the output folder.

C:\Temp\docfx>docfx "C:\Users\dzmi\Documents\GitHub\nav-content\dynamics-nav-app\NAVdocfx.json"
[17-09-26 08:55:36.224]Info:[BuildCommand]5 plug-in(s) loaded.
[17-09-26 08:55:36.375]Info:[BuildCommand]Markdown engine is dfm
[17-09-26 08:55:36.476]Info:[BuildCommand.BuildCore.Build Document]Max parallelism is 8.
[17-09-26 08:55:37.534]Info:[BuildCommand.BuildCore.Build Document.CompilePhaseHandlerWithIncremental.ConceptualDocumentProcessor]Building 0 file(s) in ConceptualDocumentProcessor(BuildConceptualDocument=>CountWord=>ValidateConceptualDocumentMetadata)...
[17-09-26 08:55:37.534]Info:[BuildCommand.BuildCore.Build Document.CompilePhaseHandlerWithIncremental.ResourceDocumentProcessor]Building 3 file(s) in ResourceDocumentProcessor(ValidateResourceMetadata)...
[17-09-26 08:55:37.535]Info:[BuildCommand.BuildCore.Build Document.CompilePhaseHandlerWithIncremental.TocDocumentProcessor]Building 1 file(s) in TocDocumentProcessor(BuildTocDocument)...
[17-09-26 08:55:37.535]Info:[BuildCommand.BuildCore.Build Document.CompilePhaseHandlerWithIncremental.ManagedReferenceDocumentProcessor]Building 0 file(s) in ManagedReferenceDocumentProcessor(BuildManagedReferenceDocument=>ValidateManagedReferenceDocumentMetadata=>ApplyOverwriteDocumentForMref=>FillReferenceInformation)...
[17-09-26 08:55:37.535]Info:[BuildCommand.BuildCore.Build Document.CompilePhaseHandlerWithIncremental.RestApiDocumentProcessor]Building 0 file(s) in RestApiDocumentProcessor(BuildRestApiDocument=>ValidateRestApiDocumentMetadata=>ApplyOverwriteDocumentForRestApi)...
[17-09-26 08:55:37.723]Info:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.Apply Templates]Applying templates to 4 model(s)...
[17-09-26 08:55:37.725]Warning:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.Apply Templates]There is no template processing document type(s): Toc
[17-09-26 08:55:37.818]Info:[BuildCommand.BuildCore.Build Document]XRef map exported.
[17-09-26 08:55:37.976]Info:[BuildCommand.Postprocess]Manifest file saved to manifest.json.
[17-09-26 08:55:38.033]Info:[BuildCommand]Completed building documents in 1800.7799 milliseconds.
[17-09-26 08:55:38.035]Info:[BuildCommand]Completed Scope:BuildCommand in 1888.8566 milliseconds.
[17-09-26 08:55:38.035]Info:Completed in 1891.754 milliseconds

Build succeeded with warning.
[17-09-26 08:55:38.042]Warning:[BuildCommand.BuildCore.Build Document.LinkPhaseHandlerWithIncremental.Apply Templates]There is no template processing document type(s): Toc
        1 Warning(s)
        0 Error(s)
edupont04 commented 6 years ago

Hi again, Thanks for confirming the fix! You can ignore the remaining warning - it applies to the TOC.md file which we do not use for Help Server. Instead, we use the ToC.xml file, where you can add links to your customized Help. The ToC.xml file is in the source folder, \nav-content\dynamics-nav-app.