Intellisense problem with <glossary> tag in MAML files

Topics: Conceptual Topics
Aug 12, 2009 at 7:06 AM

I have followed http://docproject.codeplex.com/Thread/View.aspx?ThreadId=29833 guide to enable Intellisense in Visual Studio 2008. Everything is working fine, apart from <glossary> tag - it doesn't show up in intellisense, and int the actual MAML file appears underlined with warning "The element 'developerConceptualDocument' in namespace 'http://ddue.schemas.microsoft.com/authoring/2003/5' has invalid child element 'glossary' in namespace 'http://ddue.schemas.microsoft.com/authoring/2003/5'. List of possible elements expected: 'section, relatedTopics' in namespace 'http://ddue.schemas.microsoft.com/authoring/2003/5'."

Is there any way to have fully enabled intellisense in VS2k8?

Coordinator
Aug 12, 2009 at 5:01 PM

Hi,

The <developerConceptualDocument> element should only be used for the Conceptual document type.

If you add a new MAML topic directly into Topic Explorer, using the tool bar button that adds new topics, and you choose Glossary as the document type, then you should get a document more like the following.

<?xml version="1.0" encoding="utf-8"?>
<topic id="{GUID}" revisionNumber="0">
  <developerGlossaryDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
    <glossary>
      <title>Optional glossary title</title>
     
      <glossaryDiv>
        <title>Optional glossary division</title>
       
        <glossaryEntry>
          <terms>
            <term termClass="unused">A glossary term</term>
          </terms>
          <definition>
            <para>The terms' definition</para>
          </definition>
        </glossaryEntry>
       
      </glossaryDiv>
     
    </glossary>
   
  </developerGlossaryDocument>
</topic>

- Dave

Coordinator
Aug 12, 2009 at 5:06 PM

Hi,

Also be sure to apply the latest Sandcastle Styles patch for Sandcastle since it provides a working XSLT for MAML glossary documents.  And if you haven't already, then you'll also have to create a new DocProject or DocSite after applying the patch for the changes to take affect.  (In that case you can use the Import Topics and Settings step of the New Project Wizard to copy stuff from your old project, if necessary.)

- Dave

Aug 13, 2009 at 6:39 AM
davedev wrote:

Hi,

The <developerConceptualDocument> element should only be used for the Conceptual document type.

If you add a new MAML topic directly into Topic Explorer, using the tool bar button that adds new topics, and you choose Glossary as the document type, then you should get a document more like the following.

<?xml version="1.0" encoding="utf-8"?>
<topic id="{GUID}" revisionNumber="0">
  <developerGlossaryDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
    <glossary>
      <title>Optional glossary title</title>
     
      <glossaryDiv>
        <title>Optional glossary division</title>
       
        <glossaryEntry>
          <terms>
            <term termClass="unused">A glossary term</term>
          </terms>
          <definition>
            <para>The terms' definition</para>
          </definition>
        </glossaryEntry>
       
      </glossaryDiv>
     
    </glossary>
   
  </developerGlossaryDocument>
</topic>

- Dave

Thanks Dave, that solves my problem.

Regards,

Bolek.