Changes between Initial Version and Version 1 of Docs/New_Manual

Timestamp:

11/10/16 00:53:18 (8 years ago)

Author:

Chris Johns

Comment:

--

Docs/New_Manual

@@ +1 @@
+= PAGE_TITLE =
+
+[[TOC(REPLACE_WITH_PAGE_URL , depth=2)]]
+
+A new manual is created by added the manual's directory to the top level directory of the [https://git.rtems.org/rtems-docs RTEMS Documentation Repository].
+
+Add the manual's directory to the top level `waf` script file's `build_all` list.
+
+In this example the new manual is called `new-manual`.
+
+Create a `conf.py` file in the manual directory containing:
+
+{{{
+import sys, os
+sys.path.append(os.path.abspath('../common/'))
+
+from conf import *
+
+version = '4.11.0'
+release = '4.11.0'
+
+project = "RTEMS New Manual"
+
+latex_documents = [
+        ('index', 'new-manual.tex', u'RTEMS New Manual', u'RTEMS Documentation Project', 'manual'),
+}}}
+
+'''NOTE:'''
+
+1. The file is a Python piece of code.
+1. The versions are manually set.
+1. The `project` variable is the name that appears in the HTML output.
+1. The `latex_documents` list is a truple of values needed to build a PDF.
+
+Create an `index.rst` file based on:
+
+{{{
+.. comment SPDX-License-Identifier: CC-BY-SA-4.0
+
+================
+RTEMS New Manual
+================
+
+RTEMS New Manual
+----------------
+
+ | COPYRIGHT (c) 2016.
+ | Makers of New Manuals
+
+The authors have used their best efforts in preparing this material.  These
+efforts include the development, research, and testing of the theories and
+programs to determine their effectiveness.  No warranty of any kind, expressed
+or implied, with regard to the software or the material contained in this
+document is provided.  No liability arising out of the application or use of
+any product described in this document is assumed.  The authors reserve the
+right to revise this material and to make changes from time to time in the
+content hereof without obligation to notify anyone of such revision or changes.
+
+The RTEMS Project is hosted at http://www.rtems.org/.  Any inquiries concerning
+RTEMS, its related support components, or its documentation should be directed
+to the Community Project hosted at http://www.rtems.org/.
+
+.. topic:: RTEMS Online Resources
+
+  ================  =============================
+  Home              https://www.rtems.org/
+  Developers        https://devel.rtems.org/
+  Documentation     https://docs.rtems.org/
+  Bug Reporting     https://devel.rtems.org/query
+  Mailing Lists     https://lists.rtems.org/
+  Git Repositories  https://git.rtems.org/
+  ================  =============================
+
+.. toctree::
+        :maxdepth: 5
+        :numbered:
+
+        preface
+        overview
+        body
+
+*       :ref:`genindex`
+*       :ref:`search`
+}}}
+
+'''NOTE:'''
+
+1.Provide chapters `preface.rst`, `overview.rst` and `body.rst`.