~halega/+junk/sharpdevelop

« back to all changes in this revision

Viewing changes to src/Libraries/AvalonEdit/Documentation/Sample Application.aml

  • Committer: sk
  • Date: 2011-09-10 05:17:57 UTC
  • Revision ID: halega@halega.com-20110910051757-qfouz1llya9m6boy
4.1.0.7915 Release Candidate 1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="utf-8"?>
 
2
<topic id="70c4df51-5ecb-4e24-a574-8c5a84306bd1" revisionNumber="1">
 
3
  <developerSampleDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
 
4
    <!--
 
5
    <summary>
 
6
      <para>Optional summary abstract</para>
 
7
    </summary>
 
8
    -->
 
9
    <introduction>
 
10
      <!-- Uncomment this to generate an outline of the section and sub-section
 
11
           titles.  Specify a numeric value as the inner text to limit it to
 
12
           a specific number of sub-topics when creating the outline.  Specify
 
13
           zero (0) to limit it to top-level sections only.  -->
 
14
      <!-- <autoOutline /> -->
 
15
      <para>In the SharpDevelop source code download, you will find a small sample
 
16
            application in SharpDevelop\samples\AvalonEdit.Sample.</para>
 
17
    </introduction>
 
18
    
 
19
        <mediaLink><image xlink:href="WelcomeScreenshot" placement="center"/></mediaLink>
 
20
    <!-- <procedure>Optional procedures.  See How To document for procedure layout example.</procedure> -->
 
21
    <!-- <requirements>Optional requirements section</requirements> -->
 
22
    <!-- <demonstrates>Optional info about what is demonstrated</demonstrates> -->
 
23
    <!-- <codeExample>Optional code example</codeExample> -->
 
24
    <!-- Add one or more top-level section elements.  These are collapsible.
 
25
         If using <autoOutline />, add an address attribute to identify it
 
26
         and specify a title so that it can be jumped to with a hyperlink. -->
 
27
        <section>
 
28
          <title>The Code Project article</title>
 
29
          <content>
 
30
            <para>
 
31
             There is a Code Project article based on the sample application:
 
32
             <externalLink>
 
33
                <linkText>http://www.codeproject.com/KB/edit/AvalonEdit.aspx</linkText>
 
34
                <linkUri>http://www.codeproject.com/KB/edit/AvalonEdit.aspx</linkUri>
 
35
                        <linkTarget>_blank</linkTarget>
 
36
                </externalLink>
 
37
            </para>
 
38
            <para>
 
39
            However, most of the material from that article has been included in this help file.
 
40
            </para>
 
41
         </content>
 
42
        </section>
 
43
        
 
44
    <relatedTopics>
 
45
      <!-- One or more of the following:
 
46
           - A local link
 
47
           - An external link
 
48
           - A code entity reference
 
49
 
 
50
      <link xlink:href="Other Topic's ID">Link text</link>
 
51
      <externalLink>
 
52
          <linkText>Link text</linkText>
 
53
          <linkAlternateText>Optional alternate link text</linkAlternateText>
 
54
          <linkUri>URI</linkUri>
 
55
      </externalLink>
 
56
      <codeEntityReference>API member ID</codeEntityReference>
 
57
 
 
58
      Examples:
 
59
 
 
60
      <link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8278">Some other topic</link>
 
61
 
 
62
      <externalLink>
 
63
          <linkText>SHFB on CodePlex</linkText>
 
64
          <linkAlternateText>Go to CodePlex</linkAlternateText>
 
65
          <linkUri>http://shfb.codeplex.com</linkUri>
 
66
      </externalLink>
 
67
 
 
68
      <codeEntityReference>T:TestDoc.TestClass</codeEntityReference>
 
69
      <codeEntityReference>P:TestDoc.TestClass.SomeProperty</codeEntityReference>
 
70
      <codeEntityReference>M:TestDoc.TestClass.#ctor</codeEntityReference>
 
71
      <codeEntityReference>M:TestDoc.TestClass.#ctor(System.String,System.Int32)</codeEntityReference>
 
72
      <codeEntityReference>M:TestDoc.TestClass.ToString</codeEntityReference>
 
73
      <codeEntityReference>M:TestDoc.TestClass.FirstMethod</codeEntityReference>
 
74
      <codeEntityReference>M:TestDoc.TestClass.SecondMethod(System.Int32,System.String)</codeEntityReference>
 
75
      -->
 
76
    </relatedTopics>
 
77
  </developerSampleDocument>
 
78
</topic>
 
 
b'\\ No newline at end of file'