### Define an example

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

Use the example element to provide a titled example, often containing code.

```xml
<example id="BAZ-CH-14-EX-5">
  <title>Contents of the file 
    <filename>blather.cfg</filename></title>
  <programlisting>CATS	= -c/usr/local/prod/sgml/CATALOG
DSLCAT	= -c/usr/local/sp/dsssl/catalog
DECL	= /usr/local/sp/pubtext/xml.dcl
SRCHURL = xsrch.htm
STYLE	= dbwrap.dsl
VALOPTS	= -sv -wxml</programlisting>
</example>
```

--------------------------------

### Example Directory Listing for O'Reilly Book

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

This is an example of a typical directory listing for an O'Reilly book's XML source files. It shows the naming conventions for different types of book components.

```bash
$> ls /work/java/java.qref/xml

    appa.xml      ch01.xml      ch06.xml      part1.xml
    appb.xml      ch02.xml      ch07.xml      part2.xml
    appc.xml      ch03.xml      ch08.xml
    book.xml      ch04.xml      colo.xml
    ch00.xml      ch05.xml      copy.xml
```

--------------------------------

### Use a word as an example

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

Use <wordasword> to present a word used as an example, distinct from its common meaning.

```xml
<wordasword>snake</wordasword>
```

--------------------------------

### Define a DBI::do database operation refentry

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

Demonstrates documenting a Perl DBI method with synopsis and code examples.

```xml
<refentry>
 <refmeta>
  <refentrytitle>DBI::do</refentrytitle>
 </refmeta>
 <refnamediv>
  <refname>DBI::do</refname>
 </refnamediv>
 <refsynopsisdiv>
  <synopsis>$rows\_affected  = $db-&gt;do($statement);
$rows\_affected  = $db-&gt;do($statement, \%unused);
$rows\_affected  = 
    $db-&gt;do($statement, \%unused, @bind\_values);</synopsis>
  <para><literal>DBI::do</literal> directly performs a
  non-<literal>SELECT</literal> SQL statement and 
  returns the number of rows affected by the statement. This is 
  faster than a <literal>DBI::prepare/DBI::execute 
  </literal>pair which requires two function calls. The 
  first argument is the SQL statement itself. The
  second argument is unused in DBD::mSQL and DBD::mysql, 
  but can hold a reference to a hash of attributes for other 
  DBD modules. The final argument is an array of values used 
  to replace `placeholders,' which are indicated with a
  `?' in the statement. The values of the array are
  substituted for the placeholders from left to right. As an
  additional bonus, <literal>DBI::do</literal> will 
  automatically quote string values before substitution.</para>
 </refsynopsisdiv>
 <refsect1>
  <title>Example</title>
  <programlisting>use DBI;
my $db = DBI-&gt;connect('DBI:mSQL:mydata',undef,undef);

my $rows\_affected = 
  $db-&gt;do("UPDATE mytable SET name='Joe' WHERE name='Bob'");
print "$rows\_affected Joe's were changed to Bob's\n";

my $rows\_affected2 = 
  $db-&gt;do("INSERT INTO mytable (name) VALUES (?)",
				{}, ("Sheldon's Cycle"));
# After quoting and substitution, the statement:
# INSERT INTO mytable (name) VALUES ('Sheldon's Cycle')
# was sent to the database server.</programlisting>
 </refsect1>
</refentry>
```

--------------------------------

### Execute original ls command

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

This example shows how to bypass an alias and execute the original 'ls' command. Precede the command with a backslash.

```shell
\ls
```

--------------------------------

### Example: Tidy Code Snippet

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/src/TortoiseGitSetup/include/snippet.txt

Use this snippet to indicate that the commit involves tidying up source code. Uncomment the line to enable it.

```text
#tidy=Tidy up source code
```

--------------------------------

### Example: Drop Code Snippet

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/src/TortoiseGitSetup/include/snippet.txt

Use this snippet to signify that the commit involves dropping unused code. Uncomment the line to enable it.

```text
#drop=Drop unused code
```

--------------------------------

### DocBook Lite Variable List Example

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

Demonstrates the correct markup for a term-definition list using DocBook Lite's \'variablelist\' element. This structure preserves semantic meaning for production tools.

```xml
<variablelist>

 <varlistentry>
  <term>monkey</term>
  <listitem><para>A cute, furry mammal that climbs in trees.</para></listitem>
 </varlistentry>

 <varlistentry>
  <term>koala</term>
  <listitem><para>A cute, furry mammal that climbs in trees.</para></listitem>
 </varlistentry>

</variablelist>
```

--------------------------------

### Example: Regression Snippet

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/src/TortoiseGitSetup/include/snippet.txt

Use this snippet to mark a commit as a regression related to a specific previous commit. Uncomment the line to enable it.

```text
#regression=Regression of commit 
```

--------------------------------

### Define CATID_BugTraqProvider GUID

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/contrib/issue-tracker-plugins/issue-tracker-plugins.txt

The component category GUID used to register the plugin so it can be discovered by the settings dialog.

```cpp
// {3494FA92-B139-4730-9591-01135D5E7831}
DEFINE_GUID(CATID_BugTraqProvider,
            0x3494fa92, 0xb139, 0x4730, 0x95, 0x91, 0x1, 0x13, 0x5d, 0x5e, 0x78, 0x31);
```

--------------------------------

### Incorrect List Markup Example

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

Shows an alternative, less semantic way to represent a list using \'itemizedlist\' which might be easier to type but loses information about term-definition mapping.

```xml
<itemizedlist>
 <listitem><para>Monkey - A cute, furry mammal that climbs in trees.</para></listitem>
 <listitem><para>Koala - A cute, furry mammal that climbs in trees.</para></listitem>
</itemizedlist>
```

--------------------------------

### Example: Fixed Issue Snippet

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/src/TortoiseGitSetup/include/snippet.txt

Use this snippet to quickly add a 'Fixed issue' prefix to your commit messages. Uncomment the line to enable it.

```text
#fixed=Fixed issue #:
```

--------------------------------

### Add Implemented Categories to .REG File

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/contrib/issue-tracker-plugins/issue-tracker-plugins.txt

Manually edit the generated .REG file to add the 'Implemented Categories' entry. Replace 'PUT-GUID-HERE' with the actual GUID for your plugin.

```ini
[HKEY_CLASSES_ROOT\CLSID\{PUT-GUID-HERE}\Implemented Categories\{3494FA92-B139-4730-9591-01135D5E7831}]
```

--------------------------------

### XML Chapter ID Attribute Example

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

Illustrates how to assign a unique and readable ID attribute to a chapter element for cross-referencing.

```xml
<chapter id="intro-chapter">

```

--------------------------------

### Register C# DLL with RegAsm

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/contrib/issue-tracker-plugins/issue-tracker-plugins.txt

Use RegAsm from the command line to register your C# DLL. Ensure the path to the DLL is correct and specify the desired output for the registry file.

```bash
RegAsm bin\Debug\MyCsPlugin.dll /codebase /regfile:MyCsPlugin.reg
```

--------------------------------

### Configure Aspell Build Properties

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/Aspell/Readme.txt

Set these properties in doc/doc.build.user to enable spellchecking and define the executable path.

```xml
<property name="spellcheck" value="true"/> 
<property name="path.spellcheck" value="C:\Path\to\your\Aspell.exe"/>
```

```xml
<property name="path.spellcheck" value="C:\Progra~1\Aspell\bin\aspell.exe"/>
```

--------------------------------

### Define a Samba configuration refentry

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

Uses refmeta and refnamediv to define an obsolete configuration option in DocBook Lite.

```xml
<refentry>
 <refmeta>
  <refmiscinfo class="allowable values">YES, NO</refmiscinfo>
  <refmiscinfo class="default">NO</refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname>alternate permissions = boolean</refname>
 </refnamediv>
 <refsynopsisdiv>
  <para>Obsolete. Has no effect in Samba 2. Files will be shown as
   read-only if the owner can't write them. In Samba 1.9 and
   earlier, setting this option would set the DOS filesystem read-only
   attribute on any file the user couldn't read. This in turn
   required the <literal>delete readonly</literal> 
   option.</para>
  </refsynopsisdiv>
</refentry>
```

--------------------------------

### Define a program listing

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

Use the programlisting element to display code while preserving whitespace.

```xml
<programlisting>public void init(ServletConfig config) 
                                     throws ServletException {
  super.init(config);
  String greeting = getInitParameter("greeting");
}</programlisting>
```

--------------------------------

### Create a simple titled table

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

Defines a basic table with a title, column headers, and data rows using DocBook Lite elements.

```xml
<table id="ABC-CH-1-TABLE-5">
  <title>States and Their Capitals</title>
  <tgroup cols="2">
    <thead>
      <row>
        <entry>State</entry>
        <entry>Capital</entry>
      </row>
    </thead>
    <tbody>
      <row>
        <entry>New York</entry>
        <entry>Albany</entry>
      </row>
      <row>
        <entry>Massachusetts</entry>
        <entry>Boston</entry>
      </row>
      <row>
        <entry>Hawaii</entry>
        <entry>Honalulu</entry>
      </row>
    </tbody>
  </tgroup>
</table>
```

--------------------------------

### Build TortoiseGit with MSBuild (x64)

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/build.txt

Compile the TortoiseGit project for the x64 platform using MSBuild in the Developer Command Prompt for VS20XX. Ensure a Release configuration.

```batch
MSBuild TortoiseGit.sln /p:Configuration=Release;Platform=x64
```

--------------------------------

### Download External Source Code with Git Submodules

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/build.txt

Use this command to download all linked repositories (submodules) required for building TortoiseGit.

```bash
git submodule update --init
```

--------------------------------

### Define an Apache ap_pstrndup refentry

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

Documents a C function signature within a DocBook Lite refentry structure.

```xml
<refentry>
 <refmeta>
  <refentrytitle>ap\_pstrndup</refentrytitle>
 </refmeta>
 <refnamediv>
  <refname>ap\_pstrndup</refname>
  <refpurpose>duplicate a string in a pool with 
    limited length</refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <synopsis>
    char \*ap\_pstrndup(pool \*p, const char \*s, int n)</synopsis>
  <para>Allocates <literal>n</literal>+1 bytes 
  of memory and copies up to <literal>n</literal> 
  characters from <literal>s</literal>,
  <literal>NULL</literal>- terminating the result. 
  The memory is destroyed when the pool is destroyed. Returns 
  a pointer to the new block of memory, or 
  <literal>NULL</literal> if <literal>s</literal>
  is <literal>NULL</literal>.</para>
 </refsynopsisdiv>
</refentry>
```

--------------------------------

### Build TortoiseGit with MSBuild (Win32)

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/build.txt

Compile the TortoiseGit project for the Win32 platform using MSBuild in the Developer Command Prompt for VS20XX. Ensure a Release configuration.

```batch
MSBuild TortoiseGit.sln /p:Configuration=Release;Platform=Win32
```

--------------------------------

### Correct Semantic XML Markup for URL

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

Use semantic markup like <systemitem class="url"> to mark up URLs. This ensures proper interpretation and repurposing of content, such as creating hyperlinks in HTML.

```xml
<para>For more information, you <emphasis>really</emphasis> 
ought to check out the W3C's website at <systemitem
class="url">http://www.w3.org/</systemitem>.</para>
```

--------------------------------

### DataOutputStream Instance Methods

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

This section details the public instance methods available in the DataOutputStream class.

```APIDOC
## DataOutputStream Instance Methods

### Description
Provides methods for writing primitive data types to the output stream.

### Method
GET

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **size** (int) - Returns the number of bytes written to the data output stream so far.

#### Response Example
None
```

--------------------------------

### Implement MyIssuesForm Event Handlers

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/contrib/issue-tracker-plugins/issue-tracker-plugins.txt

Event handlers for loading the ListView and processing user selections on OK click.

```csharp
        private void MyIssuesForm_Load(object sender, EventArgs e)
        {
            listView1.Columns.Add("");
            listView1.Columns.Add("#");
            listView1.Columns.Add("Summary");

            foreach(TicketItem ticketItem in _tickets)
            {
                ListViewItem lvi = new ListViewItem();
                lvi.Text = "";
                lvi.SubItems.Add(ticketItem.Number.ToString());
                lvi.SubItems.Add(ticketItem.Summary);
                lvi.Tag = ticketItem;

                listView1.Items.Add(lvi);
            }

            listView1.Columns[0].Width = -1;
            listView1.Columns[1].Width = -1;
            listView1.Columns[2].Width = -1;
        }

        private void okButton_Click(object sender, EventArgs e)
        {
            foreach (ListViewItem lvi in listView1.Items)
            {
                TicketItem ticketItem = lvi.Tag as TicketItem;
                if (ticketItem != null && lvi.Checked)
                    _ticketsAffected.Add(ticketItem);
            }
        }
```

--------------------------------

### Create a table with a column span

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

Demonstrates how to span a column across multiple cells using the 'colspan' attribute within an <entry> element.

```xml
<informaltable>
  <tgroup cols="3">
    <colspec colnum="1" colname="c1">
    <colspec colnum="3" colname="c3">
    <spanspec spanname="span13" namest="c1" nameend="c3">
    <tbody>
      <row>
        <entry>A</entry>
        <entry>B</entry>
        <entry>C</entry>
      </row>
      <row>
        <entry colspan="span13" >D</entry>
      </row>
      <row>
        <entry>E</entry>
        <entry>F</entry>
        <entry>G</entry>
      </row>
    </tbody>
  </tgroup>
</table>
```

--------------------------------

### Methods Implementing DataOutput Interface

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

This section covers the methods that implement the DataOutput interface for writing various primitive types.

```APIDOC
## Methods Implementing DataOutput Interface

### Description
These methods are part of the DataOutput interface and are used to write primitive data types in a portable binary format.

### Method
POST

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **b** (int) - Required - The byte value to write.
- **b** (byte[]) - Required - The array of bytes to write.
- **off** (int) - Required - The starting offset in the data.
- **len** (int) - Required - The number of bytes to write.
- **v** (boolean) - Required - The boolean value to write.
- **v** (int) - Required - The integer value to write.

### Request Example
```json
{
  "b": 10,
  "off": 0,
  "len": 5
}
```
```json
{
  "v": true
}
```
```json
{
  "v": 123
}
```

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### Implement ValidateParameters and GetLinkText

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/contrib/issue-tracker-plugins/issue-tracker-plugins.txt

Basic implementation of the required interface methods for parameter validation and link text retrieval.

```csharp
    public bool ValidateParameters(IntPtr hParentWnd, string parameters)
    {
        return true;
    }
```

```csharp
    public string GetLinkText(IntPtr hParentWnd, string parameters)
    {
        return "Choose Issue";
    }
```

--------------------------------

### DataOutputStream Constructor

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

This section describes the constructor for the DataOutputStream class.

```APIDOC
## DataOutputStream Constructor

### Description
Initializes a new DataOutputStream with the specified OutputStream to be filtered.

### Method
CONSTRUCTOR

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### Clone TortoiseGit Repository with Submodules

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/build.txt

Clone the main TortoiseGit repository and automatically download all submodules in a single command.

```bash
git clone --recursive https://gitlab.com/tortoisegit/tortoisegit.git
```

--------------------------------

### Alias for copying a file with backup

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

Defines an alias to copy a file to a new file with a '.old' extension. Useful for creating quick backups before modification.

```shell
alias back 'cp \!^ \!^.old'
```

--------------------------------

### Alias for nroff on all arguments

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

Creates an alias to run 'nroff -ms' on all command-line arguments passed to it. Use for batch processing of documents with nroff.

```shell
alias ms 'nroff -ms \!*'
```

--------------------------------

### Apply Translations to Resource DLLs with ResText

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/Languages/README.txt

Use the ResText utility to apply translations from a PO file to TortoiseGit resource DLLs. Replace NNNN with the four-digit country code and CC with the two-letter country code.

```bash
restext apply TortoiseProcLang.dll TortoiseProcNNNN.dll Tortoise_CC.po
```

```bash
restext apply TortoiseMergeLang.dll TortoiseMergeNNNN.dll Tortoise_CC.po
```

```bash
restext apply TortoiseIDiffLang.dll TortoiseIDiffNNNN.dll Tortoise_CC.po
```

```bash
restext apply TortoiseGitUDiffLang.dll TortoiseGitUDiffNNNN.dll Tortoise_CC.po
```

```bash
restext apply TortoiseGitBlameLang.dll TortoiseGitBlameNNNN.dll Tortoise_CC.po
```

--------------------------------

### Apply TortoiseGit Patches to libgit2

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/build.txt

Navigate to the libgit2 directory and apply TortoiseGit specific patches using git am. This ensures compatibility with TortoiseGit's requirements.

```batch
cd ext/libgit2
for %%G in (..\libgit2-*.patch) do (
    type %%G | git am --3way
)
```

--------------------------------

### Define a screen representation

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

Use the screen element to represent terminal or console output.

```xml
<screen>&gt; ls -l
total 6860
-r--r--r-- 1 eray   ora  2570 Mar 27 19:38 BOOKFILES
-rw-rw-r-- 1 eray   ora 13283 Mar 27 19:38 BOOKIDS
-rw-rw-r-- 1 sierra ora  2692 Mar 28 14:43 Makefile
drwxrwxr-x 2 jwizda ora   512 Aug 10 14:22 RCS/
-rw-rw-r-- 1 jwizda ora    39 Jul 26 17:39 README</screen>
```

--------------------------------

### Configure WinDbg Symbol Path

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/src/Debug-Hints.txt

Set the symbol path in WinDbg to resolve symbols using the TortoiseGit symbol server or the Microsoft symbol server.

```text
.sympath+ srv*c:\tmp*http://drdump.com:8080/public/TortoiseGit/7fbde3fc-94e9-408b-b5c8-62bd4e203570/symsrv/
```

```text
srv*c:\tmp*http://msdl.microsoft.com/download/symbols
```

--------------------------------

### Implement GetCommitMessage

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/contrib/issue-tracker-plugins/issue-tracker-plugins.txt

Logic to display the issue selection form and append selected ticket information to the commit message.

```csharp
    public string GetCommitMessage(IntPtr hParentWnd, string parameters, string commonRoot, string[] pathList, string originalMessage)
    {
        List<TicketItem> tickets = new List<TicketItem>();
        tickets.Add(new TicketItem(12, "Service doesn't start on Windows Vista"));
        tickets.Add(new TicketItem(19, "About box doesn't render correctly in large fonts mode"));

        MyIssuesForm form = new MyIssuesForm(tickets);
        if (form.ShowDialog() != DialogResult.OK)
            return originalMessage;

        StringBuilder result = new StringBuilder(originalMessage);
        if (originalMessage.Length != 0 && !originalMessage.EndsWith("\n"))
            result.AppendLine();

        foreach (TicketItem ticket in form.TicketsFixed)
        {
            result.AppendFormat("Fixed #{0}: {1}", ticket.Number, ticket.Summary);
            result.AppendLine();
        }

        return result.ToString();
    }
```

--------------------------------

### Define a title

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

Use the title element to provide a heading for a section or object.

```xml
<title>The Benefits of Laughter</title>
```

--------------------------------

### Define Provider Class Attributes

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/contrib/issue-tracker-plugins/issue-tracker-plugins.txt

Required COM attributes for the Provider class implementation.

```csharp
    [ComVisible(true),
     Guid("PUT-GUID-HERE"),
     ClassInterface(ClassInterfaceType.None)]
    public class Provider : IBugTraqProvider
    {
        // etc.
```

--------------------------------

### Specify a data type

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

Use <type> to indicate a variable or constant data type.

```xml
<type>boolean</type>
```

--------------------------------

### Encode a URL as a special system item

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

Use <systemitem class="url"> to designate a URL as a special computer or network-related item.

```xml
<systemitem class="url">http://www.oreilly.com</systemitem>
```

--------------------------------

### Create a cross-reference

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

Use <xref> with a linkend attribute to create a cross-reference to another element in the document.

```xml
<xref linkend="XYZ-CH-4"/>
```

--------------------------------

### Master Book File (_book.xml_) Structure

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

Defines the structure of the master book file, including XML declaration, DTD directive, entity declarations for external files and text, and the book's content.

```xml
<!DOCTYPE book PUBLIC 
    "-//ORA//DBLITE 1.1//EN" "/usr/local/prod/sgml/dblite/new.dtd"
[

<!-- Declare external entities -->

<!ENTITY ch00     SYSTEM "ch00.xml">
<!ENTITY ch01     SYSTEM "ch01.xml">
<!ENTITY ch02     SYSTEM "ch02.xml">
<!ENTITY ch03     SYSTEM "ch03.xml">
<!ENTITY ch04     SYSTEM "ch04.xml">
<!ENTITY ch05     SYSTEM "ch05.xml">
<!ENTITY ch06     SYSTEM "ch06.xml">
<!ENTITY ch07     SYSTEM "ch07.xml">
<!ENTITY ch08     SYSTEM "ch08.xml">
<!ENTITY ch09     SYSTEM "ch09.xml">
<!ENTITY part1    SYSTEM "part1.xml">
<!ENTITY part2    SYSTEM "part2.xml">
<!ENTITY appa     SYSTEM "appa.xml">
<!ENTITY appb     SYSTEM "appb.xml">
<!ENTITY appc     SYSTEM "appc.xml">
<!ENTITY copy     SYSTEM "copy.xml">
<!ENTITY colo     SYSTEM "colo.xml">

<!-- Declare text entities -->

<!ENTITY ascii    "<acronym>ASCII</acronym>">
<!ENTITY html     "<acronym>HTML</acronym>">
<!ENTITY sgml     "<acronym>SGML</acronym>">
<!ENTITY xml      "<acronym>XML</acronym>">
<!ENTITY w3url    "http://www.w3.org/">

]>

<book>
  <title>Learning &xml;</title>

  <bookinfo>

      <!-- Marketing information and metadata, 
              to be filled out in production. -->

  </bookinfo>

  <!-- External entity refs -->

  &ch00;
  &copy;
  &part1;
  &part2;
  &colo;

</book>

```

--------------------------------

### Incorrect Presentational XML Markup for URL

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

Avoid using presentational markup like <emphasis> for elements that are not semantically emphasized. This can lead to incorrect rendering and prevent content repurposing, such as failing to create hyperlinks.

```xml
For more information, you <emphasis>really</emphasis>
ought to check out the W3C's website at
<emphasis>http://www.w3.org/</emphasis>.
```

--------------------------------

### Define MyIssuesForm Class

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/contrib/issue-tracker-plugins/issue-tracker-plugins.txt

Partial class definition for the issue selection dialog.

```csharp
    partial class MyIssuesForm : Form
    {
        private readonly IEnumerable<TicketItem> _tickets;
        private readonly List<TicketItem> _ticketsAffected = new List<TicketItem>();

        public MyIssuesForm(IEnumerable<TicketItem> tickets)
        {
            InitializeComponent();
            _tickets = tickets;
        }

        public IEnumerable<TicketItem> TicketsFixed
        {
            get { return _ticketsAffected; }
        }

        // etc.
```

--------------------------------

### Render text in subscript

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

Use <subscript> to render text in a smaller font size below the baseline, commonly used for chemical formulas.

```xml
H<subscript>2</subscript>O
```

--------------------------------

### Render text in superscript

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

Use <superscript> to render text in a smaller font size above the midline, often used in scientific equations.

```xml
E=MC<superscript>2</superscript>
```

--------------------------------

### Define a variable list

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

Use the variablelist element to define terms and their corresponding definitions.

```xml
<variablelist>
  <varlistentry><term>Snickers</term>
  <listitem><para>Peanuts in nougat
    covered in chocolate.</para></listitem></varlistentry> 
  <varlistentry><term>Payday</term>
  <listitem><para>A peanut cluster cemented with caramel and 
    delicious sticky stuff.</para></listitem></varlistentry> 
</variablelist>
```

--------------------------------

### Indicate user input

Source: https://gitlab.com/tortoisegit/tortoisegit/-/blob/master/doc/source/dtd/readme-dblite.html

Use <userinput> to denote text entered by a human into a computer terminal.

```xml
<userinput>telnet bubba.beerguzzlin.org</userinput>
```