Stack Overflow
Stack Overflow

Questions tagged [maml]

MAML is an XML markup language used to write Windows help files.

Microsoft Assistance Markup Language (MAML) is an XML markup language used to write online-help guides used in Windows. The Sandcastle Help File Builder suite of tools is popular way of building these guides.

22 questions
14
votes
3 answers

Does anyone know of a good MAML editor

At work we use Sandcastle for creation of help files. I have been using SandCastleGUI for some time and I'm looking for a way to create additional pages in the help file. These pages are written in XML format called MAML. The only problem is that…
Dror Helper
  • 30,292
  • 15
  • 80
  • 129
6
votes
5 answers

PowerShell MAML Help Generator

Does anyone know of a utility for generating PowerShell cmdlet help files? Doing it by hand seems a bit tedious... I located: http://blogs.msdn.com/powershell/archive/2007/09/01/new-and-improved-cmdlet-help-editor-tool.aspx Any updated versions? I…
Adam Driscoll
  • 9,395
  • 9
  • 61
  • 104
5
votes
0 answers

Which XML comment tags Microsoft ASP.NET Web API Help Page should I use on a controller methods?

I am trying to build API documentation for a RESTful web service using Microsoft ASP.NET Web API 2.2 Help Page 5.2.3. It looks like the contents of the and elements get included in the documentation, but the section is…
Alek Davis
  • 10,628
  • 2
  • 41
  • 53
3
votes
3 answers

How to add a colorized HTML code snippet in Sandcastle documentation?

I am using the Sandcastle Help File Builder and would like to include colorized HTML code snippets in the "Conceptual Content". Is this possible and if so, how? I have tried , , and . The best…
jedatu
  • 4,053
  • 6
  • 48
  • 60
3
votes
1 answer

MAML (Powershell Help) XSD

I am generating MAML files for use with Powershell's Get-Help cmdlet. I would like to validate them. Can anybody tell me if there's a schema file somewhere that I can validate against?
Justin R.
  • 23,435
  • 23
  • 108
  • 157
3
votes
2 answers

codeEntityReference to method on a Sandcastle developerHowToDocument

I'm trying to create a link to a custom extension method using MAML element and once I build the documentation I'm getting the whole tag content instead of a link to the whole method. A sample of the…
Matías Fidemraizer
  • 63,804
  • 18
  • 124
  • 206
2
votes
1 answer

Get-Help is not seeing the MAML help files when used against commands in my module

I've been trying to improve our PS documentation and started playing with PlatyPS. So far, it's been great, I have nice markdown docs now. I'm also able to generate MAML for use with CLI documentation from it and have been able to remove the…
codewario
  • 19,553
  • 20
  • 90
  • 159
2
votes
1 answer

Heisenberg was here: Aliases for PowerShell parameters only appear in cmdlet help when you do NOT document the cmdlet

In the process of trying to make the documentation for my PowerShell cmdlets (written in C#, not scripted) as complete as possible, I made an interesting discovery. If I include a proper MAML help file (e.g. MyModule.dll-Help.xml) then displaying…
Michael Sorens
  • 35,361
  • 26
  • 116
  • 172
2
votes
2 answers

Azure Active Directory Authentication Error in Azure Management Library

I'm developing a windows phone app by using Azure Management Libraries in order to manage my Azure Websites. I used Azure Active Directory for authentication as mentioned here and everthing works great for me. But I'm getting "AuthenticationFailed:…
Abdurrahman Alp Köken
  • 1,236
  • 1
  • 13
  • 12
2
votes
1 answer

Is it possible to create MAML only documentation

I'm trying to create a help system that doesn't (necessarily) include any reflected code sections. Using the latest Sandcastle Help File Builder, is it possible to only include MAML XML files, and is so what setting needs to be changed, because…
erict
  • 1,394
  • 2
  • 14
  • 28
1
vote
1 answer

Sandcastle Authoring for Conceptual Topics

I'm working on writing some conceptual documentation to our otherwise technical documentation that is being produced in Sandcastle. There aren't a whole lot of good examples/links out there, but I'm starting to get the hang of MAML. If anyone has…
Locke
  • 1,133
  • 11
  • 32
1
vote
1 answer

.Xml help doesn't display parameter placeholders in SYNTAX section

I have a PowerShell function in a .ps1 file. The function has two parameter sets with one parameter each. The param() block in the function declaration is: Function Restore-ExplorerWindow { param( [Parameter(ParameterSetName = 'ByPath', …
Keith Miller
  • 702
  • 5
  • 13
1
vote
0 answers

How to group methods by region or some other grouping method for documentation?

I have a large class that exposes many commands. When I create documentation for the class the methods are sorted alphabetically, but I would like to have them grouped by functionality. Is there a way (using Sand Castle Helpfile builder of DocFx) to…
Dabblernl
  • 15,831
  • 18
  • 96
  • 148
1
vote
0 answers

Links to other terms within a term definition in Sandcastle

I'm composing a glossary using MAML. For example: BasicCommercialPack It's a set of
Matías Fidemraizer
  • 63,804
  • 18
  • 124
  • 206
1
vote
0 answers

codeEntityReference linkText not working

I'm following Sandcastle's MAML guide to link to documentation pages within my help file (exact page I'm referencing). The problem I am having is that the linkText attribute does not seem to be taken into account even though I'm using it in an…
Broots Waymb
  • 4,713
  • 3
  • 28
  • 51
1
2