TABLE OF CONTENTS

EDK II Template Specification

1 First Chapter

1.1 Heading 2

1.1.1 Heading 3

1.1.1.1 Heading 4

2 Second Chapter

2.1 List Items

2.2 Tables

2.3 Code Examples

2.4 Figures

2.5 Tips, Notes, Cautions, Warnings

Tables

Table 10 - Small Table

Table 11 - Small Table With Alignment

Figures

Figure 7 - Tianocore Logo

Figure 8 - Simple DOT Diagram

Figure 9 - UML Diagram

Figure 10 - DOT Diagram

Figure 11 - DITAA Diagram

Examples

Example 27 - Hello world

Example 28 - C code example

Example 29 - INI file example

EDK II Template Specification

Revision 0.20

11/30/2020 08:06:10

Acknowledgements

Redistribution and use in source (original document form) and 'compiled' forms (converted to PDF, epub, HTML and other formats) with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code (original document form) must retain the above copyright notice, this list of conditions and the following disclaimer as the first lines of this file unmodified.

2. Redistributions in compiled form (transformed to other DTDs, converted to PDF, epub, HTML and other formats) must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS DOCUMENTATION IS PROVIDED BY TIANOCORE PROJECT "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL TIANOCORE PROJECT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Copyright (c) 2017, Intel Corporation. All rights reserved.

Revision History

Revision

Revision History

Date

0.l0

Initial release.

March 2017

0.20

Second release.

March 2017

1 FIRST CHAPTER

GitBook allows you to organize your book into chapters, each chapter is stored in a separate file like this one.

The heading above is an example of Heading Level 1. It is blue and left justified.

The following is a link to another part of this same file

- Link to Heading 5

The following is a link to a heading in another file

- Link to Second Chapter

The following are 2 links to the same external page. The first uses only an http address. The second provides a name associated with the external link.

- https://github.com/GitbookIO/gitbook/blob/master/docs/syntax/markdown.md

- Gitbook Markdown

1.1 Heading 2

The heading above is an example of Heading Level 2. It is blue and left justified.

1.1.1 Heading 3

The heading above is an example of Heading Level 3. It is blue and left justified.

1.1.1.1 Heading 4

The heading above is an example of Heading Level 4. It is blue and left justified.

Heading 5

The heading above is an example of Heading Level 5. It is bold and left justified.

Heading 6

The heading above is an example of Heading Level 6. It is grey and center justified. This heading is intended to be used as the title for tables, figures, and examples.

2 SECOND CHAPTER

This is a really short paragraph.

This is another paragraph.

2.1 List Items

*Not a list item. A list item requires a least once space.

- Hello

- Hello

- Hello

- Hello

- Hello

- Hello

- hello

- Hello

- link

- Hello

2.2 Tables

The table below is a simple table with no specified alignment.

Table 10 - Small Table

a

b

c

1

2

3

The table below is a simple table with example of left, center, and right alignment.

Table 11 - Small Table With Alignment

a

b

c

1

2

3

2.3 Code Examples

Single line code example

This is code style in a single line

Code block

Code example

Example 27 - Hello world

Code block of C code with color syntax highlighting

UINT8

EFIAPI

DecimalToBcd8 (

IN      UINT8                     Value

)

{

ASSERT (Value < 100);

return (UINT8) (((Value / 10) << 4) | (Value % 10));

}

Example 28 - C code example

Code block of INF file. INF files use INI file color syntax highlighting.

[Defines]

INF_VERSION                    = 0x00010005

BASE_NAME                      = BaseLib

MODULE_UNI_FILE                = BaseLib.uni

FILE_GUID                      = 27d67720-ea68-48ae-93da-a3a074c90e30

MODULE_TYPE                    = BASE

VERSION_STRING                 = 1.1

LIBRARY_CLASS                  = BaseLib

Example 29 - INI file example

2.4 Figures

The following figure is the Tianocore logo for documents

Figure 7 - Tianocore Logo

The figures below are generated using the PlantUML plugin that uses PlantUML syntax that is defined here.

Figure 8 - Simple DOT Diagram

Figure 9 - UML Class Diagram

Figure 10 - DOT Diagram

Figure 11 - DITAA Diagram

2.5 Tips, Notes, Cautions, Warnings

Note: This is a note.

This is a paragraph between notes

Note: This is a multiple line note. This is on first line.

This is on second line.

This is on third line.

This is a paragraph after a note

Warning: This is a warning.

Note: This is a note immediately after a warning

This is a paragraph after combined warning and note.

Table of Contents

EDK II Template Specification

1 First Chapter

2 Second Chapter