[Mono-docs-list] monodoc submission

Mike Morano mmorano@mikeandwan.us
Mon, 5 Jul 2004 12:46:40 -0400


--Boundary-00=_wXY6ALTGFWTvLlu
Content-Type: text/plain;
  charset="us-ascii"
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

Hello,
	I have been trying to add some docs using monodoc, and seem to continue to 
run into errors trying to submit my updates.   I was able to register to 
submit docs, and got my passkey, but I don't recall ever seeing anywhere I 
should set this key (the upload only seems to ask for email), am I missing 
something?

	In the meantime, I am attaching my changeset to this post.  If someone could 
apply, that would be great.

Thanks,
  Mike

--Boundary-00=_wXY6ALTGFWTvLlu
Content-Type: text/xml;
  charset="us-ascii";
  name="changeset.xml"
Content-Transfer-Encoding: 7bit
Content-Disposition: attachment;
	filename="changeset.xml"

<?xml version="1.0" encoding="us-ascii"?>
<GlobalChangeset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <DocSetChangeset DocSet="netdocs">
    <FileChangeset RealFile="./System.Web/en/System.Web.UI.WebControls/Literal.xml">
      <Change XPath="/Type [@FullName = 'System.Web.UI.WebControls.Literal']/Docs/summary" FromVersion="1">
        <NewNode>
          <summary>Reperesents text that will be rendered to the Response exactly as specified in the Text property.</summary>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.WebControls.Literal']/Docs/remarks" FromVersion="1">
        <NewNode>
          <remarks>
            <para>
The Literal control provides for static text to be rendered at a specific location in the response.  This control outputs only the value of the string in the Text property, when visibility is set to true.  This control does not provide for the ability to specify a style.  If you would like to programatically alter the style of the value, refer to the <see cref="T:System.Web.UI.WebControls.Label" /> control.
</para>
            <example>
              <code lang="C#"><![CDATA[
<%@Page Language="C#">
<html>
<body>
    <form runat="server">
        Hello <asp:Literal id="helloLiteral" Text="World" runat="server" />
    </form>
</body>
</html>
  ]]></code>
            </example>
          </remarks>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.WebControls.Literal']/Members/Member [@MemberName = '.ctor'][MemberSignature [@Language='C#']/@Value = 'public Literal ();']/Docs/summary" FromVersion="1">
        <NewNode>
          <summary>Initializes a new Literal instance with default values.</summary>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.WebControls.Literal']/Members/Member [@MemberName = '.ctor'][MemberSignature [@Language='C#']/@Value = 'public Literal ();']/Docs/returns" FromVersion="1">
        <NewNode>
          <returns>A new Literal instance.</returns>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.WebControls.Literal']/Members/Member [@MemberName = '.ctor'][MemberSignature [@Language='C#']/@Value = 'public Literal ();']/Docs/remarks" FromVersion="1">
        <NewNode>
          <remarks>The new Literal instance is initialized with the default value for the Text property, String.Empty.</remarks>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.WebControls.Literal']/Members/Member [@MemberName = 'Text']/Docs/summary" FromVersion="1">
        <NewNode>
          <summary>The text that will be rendered directly in the Response, in the location where the Literal is defined.</summary>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.WebControls.Literal']/Members/Member [@MemberName = 'Text']/Docs/param [@name = 'value']" FromVersion="1">
        <NewNode>
          <param name="value">The text to render for this Literal instance.</param>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.WebControls.Literal']/Members/Member [@MemberName = 'Text']/Docs/returns" FromVersion="1">
        <NewNode>
          <returns>The text that will be rendered in the Response.</returns>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.WebControls.Literal']/Members/Member [@MemberName = 'Text']/Docs/remarks" FromVersion="1">
        <NewNode>
          <remarks>The default value of this property is the empty string.  When the Literal instance is rendered, it will directly inject the value contained in the Text property into the response, without any modification.</remarks>
        </NewNode>
        <Serial>0</Serial>
      </Change>
    </FileChangeset>
    <FileChangeset RealFile="./System.Web/en/System.Web.UI/Control.xml">
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'ClientID']/Docs/summary" FromVersion="1">
        <NewNode>
          <summary>The unique ID for this control in the HTML document.</summary>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'ClientID']/Docs/returns" FromVersion="1">
        <NewNode>
          <returns>A string representing the unique identifier for this control in the rendered HTML document.</returns>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'ClientID']/Docs/remarks" FromVersion="1">
        <NewNode>
          <remarks>
            <para>
This property is automatically generated by the ASP.Net framework, as it generates a dynamic page.  This property provides access to the final unique identifier associated with this control, on the rendered page.  This property is similar to <see cref="P:System.Web.UI.Control.UniqueID" />, only formatted differently to support HTML id requirements.
</para>

<para>
This property can be especially useful when you need to perform javascript on the client side, as you can easily pass control references by their HTML id's during page render, and in the javascript, perform a getElementById() in order to get a reference to the HTML element on the page.
</para>
</remarks>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'Controls']/Docs/summary" FromVersion="1">
        <NewNode>
          <summary>The collection of child controls for this control.</summary>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'Controls']/Docs/returns" FromVersion="1">
        <NewNode>
          <returns>A ControlCollection instance, containing all child controls for this control.</returns>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'Controls']/Docs/remarks" FromVersion="1">
        <NewNode>
          <remarks>
            <para>
This property contains an ordered list of child controls for this control.  All pages and controls contain this collection, and provide the mechanism for ASP.Net to maintain the tree of controls to render, ultimately rooted at the page instance.  The render functionality will recursively call render on each control's collection of children, until all controls have been rendered.
</para>

<para>
This ControlCollection provides a mechanism to dynamically add and remove controls from the response.
</para></remarks>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'EnableViewState']/Docs/summary" FromVersion="1">
        <NewNode>
          <summary>Provides a mechanism to specify whether the control's ViewState should be saved as part of the response.</summary>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'EnableViewState']/Docs/param [@name = 'value']" FromVersion="1">
        <NewNode>
          <param name="value">A boolean indicating if ViewState for this control should be saved as part of the response.</param>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'EnableViewState']/Docs/returns" FromVersion="1">
        <NewNode>
          <returns>A boolean indicating if the ViewState will be saved as part of the response.</returns>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'EnableViewState']/Docs/remarks" FromVersion="1">
        <NewNode>
          <remarks>
            <para>
EnableViewState provides a mechanism for the developer to control when ViewState is saved between requests.  It is recommended that if your control does not need to save its ViewState, that you set this property to false.  ViewState can quickly grow and add a lot of bloat to your page.  Be especially careful when you use databound list controls, such as a DataGrid or Repeater.  For the controls that live inside these databound controls, you likely will want to disable ViewState, as this quickly adds to the page size.
</para>

<para>
When you set EnableViewState to false on a control, this will disable ViewState from being saved by all child controls.  Hence, if you set EnableViewState to false at the page level, no ViewState will be saved for the page, or any controls on that page.
</para></remarks>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'ID']/Docs/summary" FromVersion="1">
        <NewNode>
          <summary>The unique identifier in the local naming context, for this control during processing on the server.</summary>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'ID']/Docs/param [@name = 'value']" FromVersion="1">
        <NewNode>
          <param name="value">A string representing the unique identifier for this control on the server, in the current naming context.</param>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'ID']/Docs/returns" FromVersion="1">
        <NewNode>
          <returns>A string representing the unique identifier for this control on the server, in the current naming context.</returns>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'ID']/Docs/remarks" FromVersion="1">
        <NewNode>
          <remarks>
            <para>
This serves as the unique identifier relative to the current naming context.  It is invalid to try and specify the same identifier more than one time in a given naming context.  This id will be used to specify a control in the page or control, and can be referenced in the codebehind.  Review the example below.  
</para>

<block subset="none" type="note">
              <para>
    The Literal that is used in the page is identical to the name of the Literal member defined in the codebehind.  Also note that the page inherits from codebehind class.  ASP.Net will automatically map the controls defined in the page, to the member defined in the class based on this ID.
  </para>
            </block>

ASPX page:
<example>
              <code lang="C#">
  &lt;%@Page Language="C#" Inherits="Test.Index" %&gt;
  &lt;html&gt;
  &lt;body&gt;

  &lt;asp:Literal ID="helloLiteral" runat="server" /&gt;

  &lt;/body&gt;
  &lt;/html&gt;
  </code>
            </example>

<para />

ASPX.cs example:
<example>
              <code lang="C#">
  using System;
  using System.Web.UI;
  using System.Web.UI.WebControls;

  namespace Test
  {
      public class Index : Page
      {
          protected Literal helloLiteral;

          private void Page_Load(object sender, EventArgs e)
          {
              this.helloLiteral.Text = "Hello World";
          }

          protected override void OnInit(EventArgs e)
          {
              this.Load += new EventHandler(this.Page_Load);
          }          
      }
  }
  </code>
            </example>

</remarks>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'NamingContainer']/Docs/summary" FromVersion="1">
        <NewNode>
          <summary>A control higher up in the control tree for this control, which provides this control with an initial naming context.</summary>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'NamingContainer']/Docs/returns" FromVersion="1">
        <NewNode>
          <returns>An instance of <see cref="T:System.Web.UI.Control" /> which serves as this control's base naming context.  This NamingContainer will implement the <see cref="T:System.Web.UI.INamingContainer" /> interface.</returns>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'NamingContainer']/Docs/remarks" FromVersion="1">
        <NewNode>
          <remarks>
            <para>
The NamingContainer control provides a reference to the control that establishes the base naming context for this control, and it's children.  The NamingContainer is useful for ASP.Net to generate the unique IDs for each control that lives in a page.
</para>

<para>
When two different controls are added to a page, it would be possible for their child controls to have the same id.  However, as long as these two controls have a different NamingContainer, their effective IDs will be different, as they are in different naming contexts.
</para>
</remarks>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'Page']/Docs/summary" FromVersion="1">
        <NewNode>
          <summary>A reference to the <see cref="T:System.Web.UI.Page" /> instance this control is on.</summary>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'Page']/Docs/param [@name = 'value']" FromVersion="1">
        <NewNode>
          <param name="value">The <see cref="T:System.Web.UI.Page" /> this control is on.</param>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'Page']/Docs/remarks" FromVersion="1">
        <NewNode>
          <remarks>Provides easy access to the <see cref="T:System.Web.UI.Page" /> this control is on, regardless of where the control is in the control hierarchy.</remarks>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'Page']/Docs/returns" FromVersion="1">
        <NewNode>
          <returns>The <see cref="T:System.Web.UI.Page" /> this control is on.</returns>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'Parent']/Docs/summary" FromVersion="1">
        <NewNode>
          <summary>The <see cref="T:System.Web.UI.Control" /> that is the direct parent of this control.</summary>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'Parent']/Docs/returns" FromVersion="1">
        <NewNode>
          <returns>A reference to the <see cref="T:System.Web.UI.Control" /> that is the direct parent of this control.</returns>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'Parent']/Docs/remarks" FromVersion="1">
        <NewNode>
          <remarks>Provides access to the <see cref="T:System.Web.UI.Control" /> that is the direct parent of this control.  If this control instance is a <see cref="T:System.Web.UI.Page" />, the parent will be null, as the Page is the root of the control hierarchy.</remarks>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'UniqueID']/Docs/summary" FromVersion="1">
        <NewNode>
          <summary>The fully qualified unique identifier for this control, in the context of the entire page.</summary>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'UniqueID']/Docs/returns" FromVersion="1">
        <NewNode>
          <returns>A <see cref="T:System.String" /> representing the fully qualified unique identifier for this control.</returns>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'UniqueID']/Docs/remarks" FromVersion="1">
        <NewNode>
          <remarks>
            <para>
This property provides access to the unique identifier for this control on the fully rendered page.  This identifier is determined by prefixing the ID with the collection of naming contexts above this control.  The UniqueID property shares the same concept as <see cref="P:System.Web.UI.Control.ClientID" />, however, it is only available on the server.
</para>


<block subset="none" type="note">
              <para>
  The value of the UniqueID will typically not be equal to the ClientID, as the ClientID must be formatted differently, in order to conform to HTML specifications for the ID property on HTML elements.
  </para>
            </block></remarks>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'Visible']/Docs/summary" FromVersion="1">
        <NewNode>
          <summary>Provides for the ability to enable or disable the display of the control from the response.</summary>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'Visible']/Docs/param [@name = 'value']" FromVersion="1">
        <NewNode>
          <param name="value">A <see cref="T:System.bool" /> that specifies if the control should be rendered in the resulting page.  If true, the control will be rendered.  If false, this control will not be rendered.</param>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'Visible']/Docs/returns" FromVersion="1">
        <NewNode>
          <returns>A <see cref="T:System.bool" /> indicating if this control will be rendered.</returns>
        </NewNode>
        <Serial>0</Serial>
      </Change>
      <Change XPath="/Type [@FullName = 'System.Web.UI.Control']/Members/Member [@MemberName = 'Visible']/Docs/remarks" FromVersion="1">
        <NewNode>
          <remarks>
            <para>
This property provides for a mechanism to specify if a control should be rendered to a page.  This property is true by default, meaning that controls will render by default.  Setting this to false will result in the control not rendering in the response.
</para>

<para>
If you set the visibility to false, then any child controls contained in this control, will not be rendered as well.
</para>
</remarks>
        </NewNode>
        <Serial>0</Serial>
      </Change>
    </FileChangeset>
  </DocSetChangeset>
</GlobalChangeset>
--Boundary-00=_wXY6ALTGFWTvLlu--