PageRenderTime 30ms CodeModel.GetById 28ms app.highlight 0ms RepoModel.GetById 1ms app.codeStats 0ms

/Main/Source/SandcastleMAMLGuide/Content/KnownIssues.aml

#
Unknown | 73 lines | 67 code | 6 blank | 0 comment | 0 complexity | 31bdf410908744f34f7b34c2450ae7c9 MD5 | raw file
Possible License(s): CC-BY-SA-3.0
 1<?xml version="1.0" encoding="utf-8"?>
 2<topic id="b00070c7-9c5e-4b49-ad5c-f55fa866f062" revisionNumber="1">
 3  <developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
 4    <introduction>
 5      <para>This topic covers known issues and bugs with Sandcastle and conceptual content.  Currently, the
 6VS2005 presentation style is the best choice for conceptual content as it contains no known issues beyond those
 7noted in the <legacyBold>General Issues</legacyBold> section.  The list does not include issues fixed by the
 8noted patch.</para>
 9    </introduction>
10
11    <section address="General">
12      <title>General Issues</title>
13      <content>
14        <para>These are the currently known issues with Sandcastle in general when used to produce conceptual
15content regardless of presentation style.</para>
16        <list class="bullet">
17          <listItem><para>There are a number of issues and bugs in all three presentation styles.  Be sure to
18apply the <token>SandcastleStyles</token> patch to obtain the best results and most consistent look and feel
19between all three styles and their related reference topics.  A list of the fixes and changes is included with
20the patch.</para></listItem>
21          <listItem><para>There does not appear to be any formatting for several of the <legacyBold>Whitepaper</legacyBold>
22topic elements.</para></listItem>
23          <listItem><para>Several elements of the <legacyBold>XML Reference</legacyBold> topic type do not render
24correctly if at all.</para></listItem>
25					<listItem>
26						<para>Sandcastle's XSL transformations remove inter-element whitespace.  As such, if you place two
27MAML elements one after the other and require a separating space between them, use a non-breaking space entity
28(<codeInline>&amp;#160;</codeInline>).  See the <link xlink:href="382fc569-33e4-489a-b0c2-94c11e56ab4a" /> topic
29for an example.</para>
30					</listItem>
31        </list>
32      </content>
33    </section>
34
35    <section address="Hana">
36      <title>Hana Presentation Style Issues</title>
37      <content>
38        <para>These are the currently known issues with the Hana presentation style.</para>
39        <list class="bullet">
40          <listItem><para>MS Help Viewer output is not supported as this style has been deprecated.</para></listItem>
41          <listItem><para>The language filter is present but only toggles syntax and code snippet visibility.  It
42will not toggle the visiblity on code examples.</para></listItem>
43        </list>
44
45				<alert class="note">
46					<para>This presentation style has been deprecated and is no longer supported by Microsoft.</para>
47				</alert>
48      </content>
49    </section>
50
51    <section address="Prototype">
52      <title>Prototype Presentation Style Issues</title>
53      <content>
54        <para>These are the currently known issues with the Prototype presentation style.</para>
55        <list class="bullet">
56          <listItem><para>MS Help Viewer output is not supported as this style has been deprecated.</para></listItem>
57          <listItem><para>The language filter is present but only toggles syntax and code snippet visibility.  It
58will not toggle the visiblity on code examples.</para></listItem>
59          <listItem><para>Most section headers are not rendered as collapsible sections like they are in the Hana
60and VS2005 styles.</para></listItem>
61        </list>
62
63				<alert class="note">
64					<para>This presentation style has been deprecated and is no longer supported by Microsoft.</para>
65				</alert>
66			</content>
67    </section>
68
69    <relatedTopics>
70      <link xlink:href="303c996a-2911-4c08-b492-6496c82b3edb" />
71    </relatedTopics>
72  </developerConceptualDocument>
73</topic>