├── LICENSE ├── README.md ├── asciidoc_only ├── afterword.asciidoc ├── appa.asciidoc ├── bibliography.asciidoc ├── ch01.asciidoc ├── foreword.asciidoc ├── glossary.asciidoc ├── intro.asciidoc ├── part1.asciidoc ├── preface.asciidoc ├── preface_make.asciidoc ├── sample_chapter.asciidoc └── v1_only │ ├── afterword.asciidoc │ ├── book-docinfo.xml │ ├── book.asciidoc │ ├── colophon │ ├── animal_or_cookbook │ │ └── colo.asciidoc │ ├── hacks │ │ └── colo.asciidoc │ ├── makerpress │ │ └── colo.asciidoc │ ├── realtime │ │ └── colo.asciidoc │ └── trade │ │ └── colo.asciidoc │ ├── dedication.asciidoc │ └── preface.asciidoc ├── author_bio.html ├── colo.html ├── copyright.html ├── cover.html ├── dedication.html ├── docbook_only ├── afterword.xml ├── appa.xml ├── bibliography.xml ├── ch01.xml ├── foreword.xml ├── glossary.xml ├── part1.xml ├── preface.xml ├── preface_make.xml ├── sample_chapter.xml └── v1_only │ ├── ascii_art │ ├── ascii_art.xml │ ├── ascii_art.xml.pdf │ └── figs │ │ ├── incoming │ │ ├── ascii_commandments.txt │ │ ├── ch02dia1.png │ │ └── iq-interaction.txt │ │ └── print │ │ ├── svc_0201.pdf │ │ └── xmpp_0205.pdf │ ├── book-docinfo.xml │ ├── book.xml │ ├── colophon │ ├── animal_or_cookbook │ │ └── colo.xml │ ├── hacks │ │ └── colo.xml │ ├── realtime │ │ └── colo.xml │ ├── theory │ │ └── colo.xml │ └── trade │ │ └── colo.xml │ └── dedication.xml ├── htmlbook_only ├── afterword.html ├── appa.html ├── bibliography.html ├── ch01.html ├── foreword.html ├── glossary.html ├── intro.html ├── part1.html ├── preface.html ├── preface_make.html └── sample_chapter.html ├── ix.html ├── jupyter_book_only ├── README.md ├── _config.yml ├── _toc.yml ├── afterword.ipynb ├── appx_a.ipynb ├── bibliography.ipynb ├── ch01.ipynb ├── foreword.ipynb ├── glossary.ipynb ├── preface.ipynb ├── requirements.txt └── sample_chapter.ipynb ├── layout.html ├── pdf.css ├── tarsier.png ├── titlepage.html └── toc.html /LICENSE: -------------------------------------------------------------------------------- 1 | +++++++++++++++++++++ 2 | Copyright (c) <2013> 3 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 4 | 5 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 6 | 7 | Except as contained in this notice, the name(s) of the above copyright holders shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization. 8 | 9 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 10 | +++++++++++++++++++++ 11 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # orm_book_samples 2 | 3 | This directory contains skeleton/boilerplate book files for use with the O'Reilly Media, Inc. internal publishing tools. 4 | 5 | NOTE: If you update any boilerplate in this repo, please update each filetype (HTMLBook, AsciiDoc, DocBook) as necessary and then deploy to the Atlas templates by following the instructions below. 6 | 7 | ## File Organization 8 | 9 | * root - standard files 10 | * book files for use with all Atlas projects regardless of content format 11 | * pdf.css (common theme overrides) 12 | * layout.html (use to specify EPUB/MOBI metadata) 13 | * README.md (this file) 14 | * LICENSE (license for use of files in this repo) 15 | * asciidoc_only/ 16 | * book files for use in AsciiDoc projects only 17 | * v1_only/ 18 | * book files for use with AsciiDoc projects in Atlas v1 (deprecated) 19 | * docbook_only/ 20 | * book files for use in DocBook projects only 21 | * v1_only/ 22 | * book files for use with DocBook projects in Atlas v1 (deprecated) 23 | * htmlbook_only/ 24 | * book files for use in HTMLBook projects only 25 | 26 | ## Steps for Updating Atlas Template Repos 27 | 28 |
    29 |
  1. 30 |

    Log on to Touchstone

    31 |

    This script can be run anywhere on Touchstone.

    32 |
    2. 33 | 34 |

  2. Decide what you want to update.

    35 |
      36 |

    • Peripheral files that are common to each repo can be updated.

      37 |

      NOTE: Updating peripheral files will push to all three Atlas template repos.

      38 | 39 |
      • 40 |

    • Format specific files that are specific to each template can be updated.

      41 |

      NOTE: You need to explicitly state which formats you want to update.

      42 |
      • 43 |
    44 |
    3. 45 | 46 |
  3. 47 |

    Run the script

    48 |

    $ [variables] v2sample_template_update

    49 |

    Here's a list of the variables to specify when you run the command:

    50 | 51 |
      52 |
    • 53 |

      To update format specific files

      54 | 
       55 |      format_specific=true asc=true # Specifies to update asciidoc template repo
 56 |      format_specific=true db=true # Specifies to update db template repo
 57 |      format_specific=true html=true # Specifies to update html template repo
      58 |
      • 59 |
    • 60 |

      To update peripheral files

      61 | 
      peripheral=true # Specifies to update every template repo's common files (like, titlepage.html, 
 62 |                                                                            toc.html, and so on)
      63 |
      • 64 |
    65 | 66 |
    4. 67 |
68 | 69 |

TIPs:

70 |
    71 |
  1. 72 |

    You can update format specific files for more than one sample repo at a time.

    73 | 

     74 | #Examples
 75 | $ format_specific=true asc=true db=true v2sample_template_update
 76 | $ format_specific=true asc=true db=true html=true v2sample_template_update
 77 |
    78 |
    2. 79 |
  2. 80 |

    You can update format specific files and peripheral files at the same time. (Peripheral file updates will be pushed to every template repo, but the format specific updates only apply to the repo specified):

    81 | 

    #Examples
 82 | $ peripheral=true format_specific=true asc=true v2sample_template_update
 83 | $ peripheral=true format_specific=true asc=true db=true html=true v2sample_template_update
 84 |
    85 |
    3. 86 | 87 |
88 | 89 | ---- 90 | 91 | Script Man File (current as of 3/12/2015): 92 | ``` 93 | Usage 94 | $ [options] v2sample_template_update 95 | 96 | Examples 97 | $ peripheral=true v2sample_template_update 98 | $ format_specific=true asc=true v2sample_template_update 99 | 100 | Variables 101 | 102 | peripheral 103 | =true - Specifies that peripheral files should be updated (this updates to every template) 104 | 105 | format_specific 106 | =all - (NOT ADDED YET) Pushes updates to each atlas template's format specific files 107 | =true - Use in conjunction with a asc/db/html variables to specify which main content files 108 | should be updated. 109 | asc 110 | =true - Specifies that the asciidoc template repo's format specific files will be updated 111 | db 112 | =true - Specifies that the docbook template repo's format specific files will be updated 113 | html 114 | =true - Specifies that the htmlbook template repo's format specific files will be updated 115 | 116 | eso 117 | =true - (NOT ADDED YET) used for pushing esoteric files (in case we want this) 118 | ``` 119 | ---- 120 | -------------------------------------------------------------------------------- /asciidoc_only/afterword.asciidoc: -------------------------------------------------------------------------------- 1 | [appendix] 2 | [role="afterword"] 3 | == Afterword 4 | 5 | Afterword text begins here. 6 | -------------------------------------------------------------------------------- /asciidoc_only/appa.asciidoc: -------------------------------------------------------------------------------- 1 | [appendix] 2 | == Appendix Title 3 | 4 | An appendix is generally used for extra material that supplements your main book content. 5 | -------------------------------------------------------------------------------- /asciidoc_only/bibliography.asciidoc: -------------------------------------------------------------------------------- 1 | [[bibliography]] 2 | [appendix] 3 | [role="bibliography"] 4 | == Bibliography 5 | 6 | Bibliography content starts here. -------------------------------------------------------------------------------- /asciidoc_only/ch01.asciidoc: -------------------------------------------------------------------------------- 1 | [[unique_chapter_id]] 2 | == Chapter Title Goes Here 3 | 4 | Put some introductory text here. 5 | 6 | === Your First Section Heading Here 7 | 8 | Put more content here. -------------------------------------------------------------------------------- /asciidoc_only/foreword.asciidoc: -------------------------------------------------------------------------------- 1 | [preface] 2 | == Foreword 3 | 4 | Foreword text begins here. 5 | 6 | -------------------------------------------------------------------------------- /asciidoc_only/glossary.asciidoc: -------------------------------------------------------------------------------- 1 | [[glossary]] 2 | == Glossary 3 | 4 | A glossary contains a collection of terms and brief descriptions or definitions of those terms. The basic markup follows. 5 | 6 | [glossary] 7 | Gloss Term:: Gloss definition. 8 | 9 | Gloss Term 2:: Gloss definition 2. -------------------------------------------------------------------------------- /asciidoc_only/intro.asciidoc: -------------------------------------------------------------------------------- 1 | [introduction] 2 | == Introduction 3 | 4 | Content here. 5 | -------------------------------------------------------------------------------- /asciidoc_only/part1.asciidoc: -------------------------------------------------------------------------------- 1 | [[unique_part_id]] 2 | [part] 3 | == Part Title 4 | 5 | [partintro] 6 | -- 7 | If you want to group your chapters into parts, add the part markup to the top of the file that should be the first chapter in that part, above the chapter title. 8 | 9 | The +partintro+ section is not required. But if you want any introductory text on the part page, it goes here. 10 | -- 11 | 12 | 13 | [[unique_chapter_id]] 14 | == Chapter Title 15 | 16 | Chapter text begins here. 17 | 18 | === Top-Level Heading 19 | 20 | Within a chapter, the first and highest heading level uses three equals signs. 21 | 22 | ==== Second-Level Heading 23 | 24 | The second-level heading uses four equals signs. 25 | 26 | ===== Third-level heading 27 | 28 | The third-level heading uses five equals signs. 29 | -------------------------------------------------------------------------------- /asciidoc_only/preface.asciidoc: -------------------------------------------------------------------------------- 1 | [preface] 2 | == Preface 3 | 4 | === Conventions Used in This Book 5 | 6 | The following typographical conventions are used in this book: 7 | 8 | _Italic_:: Indicates new terms, URLs, email addresses, filenames, and file extensions. 9 | 10 | +Constant width+:: Used for program listings, as well as within paragraphs to refer to program elements such as variable or function names, databases, data types, environment variables, statements, and keywords. 11 | 12 | **`Constant width bold`**:: Shows commands or other text that should be typed literally by the user. 13 | 14 | _++Constant width italic++_:: Shows text that should be replaced with user-supplied values or by values determined by context. 15 | 16 | 17 | [TIP] 18 | ==== 19 | This element signifies a tip or suggestion. 20 | ==== 21 | 22 | [NOTE] 23 | ==== 24 | This element signifies a general note. 25 | ==== 26 | 27 | [WARNING] 28 | ==== 29 | This element indicates a warning or caution. 30 | ==== 31 | 32 | === Using Code Examples 33 | ++++ 34 | 35 | ++++ 36 | 37 | Supplemental material (code examples, exercises, etc.) is available for download at link:$$https://github.com/oreillymedia/title_title$$[]. 38 | 39 | If you have a technical question or a problem using the code examples, please send email to pass:[support@oreilly.com]. 40 | 41 | This book is here to help you get your job done. In general, if example code is offered with this book, you may use it in your programs and documentation. You do not need to contact us for permission unless you’re reproducing a significant portion of the code. For example, writing a program that uses several chunks of code from this book does not require permission. Selling or distributing examples from O’Reilly books does require permission. Answering a question by citing this book and quoting example code does not require permission. Incorporating a significant amount of example code from this book into your product’s documentation does require permission. 42 | 43 | We appreciate, but generally do not require, attribution. An attribution usually includes the title, author, publisher, and ISBN. For example: “_Book Title_ by Some Author (O’Reilly). Copyright 2012 Some Copyright Holder, 978-0-596-xxxx-x.” 44 | 45 | If you feel your use of code examples falls outside fair use or the permission given above, feel free to contact us at pass:[permissions@oreilly.com]. 46 | 47 | === O'Reilly Online Learning 48 | 49 | [role = "ormenabled"] 50 | [NOTE] 51 | ==== 52 | For more than 40 years, pass:[O’Reilly Media] has provided technology and business training, knowledge, and insight to help companies succeed. 53 | ==== 54 | 55 | Our unique network of experts and innovators share their knowledge and expertise through books, articles, and our online learning platform. O’Reilly’s online learning platform gives you on-demand access to live training courses, in-depth learning paths, interactive coding environments, and a vast collection of text and video from O'Reilly and 200+ other publishers. For more information, visit pass:[https://oreilly.com]. 56 | 57 | === How to Contact Us 58 | 59 | Please address comments and questions concerning this book to the publisher: 60 | 61 | ++++ 62 | 72 | ++++ 73 | 74 | We have a web page for this book, where we list errata, examples, and any additional information. You can access this page at link:$$https://www.oreilly.com/catalog/catalog_page$$[]. 75 | 76 | ++++ 77 | 78 | ++++ 79 | 80 | For news and information about our books and courses, visit link:$$https://oreilly.com$$[]. 81 | 82 | Find us on LinkedIn: link:$$https://linkedin.com/company/oreilly-media$$[] 83 | 84 | Watch us on YouTube: link:$$https://youtube.com/oreillymedia$$[] 85 | 86 | === Acknowledgments 87 | 88 | ++++ 89 | 90 | ++++ 91 | -------------------------------------------------------------------------------- /asciidoc_only/preface_make.asciidoc: -------------------------------------------------------------------------------- 1 | [preface] 2 | == Preface 3 | 4 | === Conventions Used in This Book 5 | 6 | The following typographical conventions are used in this book: 7 | 8 | _Italic_:: Indicates new terms, URLs, email addresses, filenames, and file extensions. 9 | 10 | +Constant width+:: Used for program listings, as well as within paragraphs to refer to program elements such as variable or function names, databases, data types, environment variables, statements, and keywords. 11 | 12 | **`Constant width bold`**:: Shows commands or other text that should be typed literally by the user. 13 | 14 | _++Constant width italic++_:: Shows text that should be replaced with user-supplied values or by values determined by context. 15 | 16 | 17 | [TIP] 18 | ==== 19 | This element signifies a tip or suggestion. 20 | ==== 21 | 22 | [NOTE] 23 | ==== 24 | This element signifies a general note. 25 | ==== 26 | 27 | [WARNING] 28 | ==== 29 | This element indicates a warning or caution. 30 | ==== 31 | 32 | === Using Code Examples 33 | ++++ 34 | 35 | ++++ 36 | 37 | Supplemental material (code examples, exercises, etc.) is available for download at link:$$https://github.com/oreillymedia/title_title$$[]. 38 | 39 | If you have a technical question or a problem using the code examples, please send email to pass:[bookquestions@oreilly.com]. 40 | 41 | This book is here to help you get your job done. In general, if example code is offered with this book, you may use it in your programs and documentation. You do not need to contact us for permission unless you’re reproducing a significant portion of the code. For example, writing a program that uses several chunks of code from this book does not require permission. Selling or distributing examples from Make: books does require permission. Answering a question by citing this book and quoting example code does not require permission. Incorporating a significant amount of example code from this book into your product’s documentation does require permission. 42 | 43 | We appreciate, but generally do not require, attribution. An attribution usually includes the title, author, publisher, and ISBN. For example: “_Book Title_ by Some Author (O’Reilly). Copyright 2012 Some Copyright Holder, 978-0-596-xxxx-x.” 44 | 45 | If you feel your use of code examples falls outside fair use or the permission given above, feel free to contact us at pass:[bookpermissions@makermedia.com]. 46 | 47 | === O'Reilly Online Learning 48 | 49 | [role = "ormenabled"] 50 | [NOTE] 51 | ==== 52 | For more than 40 years, pass:[O’Reilly Media] has provided technology and business training, knowledge, and insight to help companies succeed. 53 | ==== 54 | 55 | Our unique network of experts and innovators share their knowledge and expertise through books, articles, conferences, and our online learning platform. O’Reilly’s online learning platform gives you on-demand access to live training courses, in-depth learning paths, interactive coding environments, and a vast collection of text and video from O'Reilly and 200+ other publishers. For more information, please visit pass:[https://oreilly.com]. 56 | 57 | === How to Contact Us 58 | 59 | Please address comments and questions concerning this book to the publisher: 60 | 61 | ++++ 62 | 69 | ++++ 70 | 71 | We have a web page for this book, where we list errata, examples, and any additional information. You can access this page at link:$$https://www.oreilly.com/catalog/$$[]. 72 | 73 | ++++ 74 | 75 | ++++ 76 | 77 | Make: unites, inspires, informs, and entertains a growing community of resourceful people who undertake amazing projects in 78 | their backyards, basements, and garages. Make: celebrates your 79 | right to tweak, hack, and bend any technology to your will. The 80 | Make: audience continues to be a growing culture and community that believes in bettering ourselves, our environment, our 81 | educational system—our entire world. This is much more than 82 | an audience, it’s a worldwide movement that Make is leading we call it the Maker Movement. 83 | 84 | For more information about Make:, visit us online: 85 | 86 | ++++ 87 | 93 | ++++ 94 | 95 | To comment or ask technical questions about this book, send email to pass:[]. 96 | 97 | === Acknowledgments 98 | 99 | ++++ 100 | 101 | ++++ 102 | -------------------------------------------------------------------------------- /asciidoc_only/sample_chapter.asciidoc: -------------------------------------------------------------------------------- 1 | [[sample_chapter_unique_id]] 2 | == Sample Chapter 3 | 4 | Chapter text begins here. Replace any of this placeholder text with your opus. The following portion outlines heading levels and section structure. 5 | 6 | === This Is a Top-Level Heading (A-Head) 7 | 8 | Within a chapter, the first and highest heading level uses three equals signs. 9 | 10 | ==== This Is a Second-Level Heading (B-Head) 11 | 12 | The second-level heading uses four equals signs. This heading level should only follow a top-level heading (A-head). 13 | 14 | ===== This Is a Third-Level Heading (C-Head) 15 | 16 | The third-level heading uses five equals signs. This heading level should only follow a second-level heading (B-head). 17 | 18 | 19 | === Atlas User Docs and Examples 20 | 21 | Here are the https://docs.atlas.oreilly.com[Atlas user docs]. Here is the section on https://docs.atlas.oreilly.com/writing_in_asciidoc.html[writing in AsciiDoc]. 22 | 23 | Next we've included a few examples of commonly used block elements. You can add these elements using the buttons in the toolbar, as well. 24 | 25 | .This Is a Note 26 | [NOTE] 27 | ==== 28 | Many people use notes to qualify a statement they made in the preceding paragraphs, or to warn their readers about pitfalls they might run into. 29 | ==== 30 | 31 | [WARNING] 32 | ==== 33 | This is a warning, used to alert readers to something important or encourage caution. Headings are optional for admonitions like notes and warnings. 34 | ==== 35 | 36 | Here is an informal code listing: 37 | 38 | [source,python] 39 | ---- 40 | print('hello world') 41 | ---- 42 | 43 | And this is a formal listing, or example: 44 | 45 | [[example_code_block]] 46 | .Hello World in Python 47 | ==== 48 | [source,python] 49 | ---- 50 | print("Hello World") 51 | # Formal listings have titles that will be numbered in output. 52 | ---- 53 | ==== 54 | 55 | For either type of listing, you have the option of specifying the code language displayed; see the Code sub-section of the https://docs.atlas.oreilly.com/writing_in_asciidoc.html[Writing in AsciiDoc section] of the Atlas user docs for more details. 56 | 57 | You can also specify inline text as code: +print ("Hello World")+. 58 | 59 | Now, let's take a look at a figure with a caption: 60 | 61 | .Figures like this will be automatically numbered in output. 62 | image::images/tarsier.png["Drawing of Tarsiers"] 63 | 64 | Here is a blockquote with an author attribution: 65 | 66 | [quote, Lewis Carroll] 67 | ____ 68 | Alice was beginning to get very tired of sitting by her sister on the bank, and of having nothing to do: once or twice she had peeped into the book her sister was reading, but it had no pictures or conversations in it, 'and what is the use of a book,' thought Alice 'without pictures or conversation?' 69 | ____ 70 | 71 | There are three types of lists available. Numbered (ordered) lists are often used to describe steps in a process: 72 | 73 | . Parse the request. 74 | . Choose a handler function. 75 | . Run the handler function. 76 | 77 | Bulleted (unordered) lists are good for describing a set of requirements: 78 | 79 | * HTML source 80 | * CSS stylesheets 81 | * JavaScript code 82 | 83 | Definition/variable lists serve as glossaries of terminology: 84 | 85 | selectSource:: 86 | Returns a Source containing all the IDs and values from the database. This allows you to write streaming code. 87 | selectList:: 88 | Returns a list containing all the IDs and values from the database. All records will be loaded into memory. 89 | selectFirst:: 90 | Takes just the first ID and value from the database, if available. 91 | selectKeys:: 92 | Returns only the keys, without the values, as a +Source+. 93 | 94 | .Sidebar Title 95 | **** 96 | Here's a sidebar. Sidebars are great for setting aside a section of text that is related to the surrounding content but that doesn't necessarily fit into the main flow. 97 | **** 98 | 99 | Finally, here's a sample table: 100 | 101 | [[example_table]] 102 | .Features supported by Hadoop release series 103 | [options="header"] 104 | |======= 105 | |Feature|1.x|0.22|2.x 106 | |Secure authentication|Yes|No|Yes 107 | |Old configuration names|Yes|Deprecated|Deprecated 108 | |New configuration names|No|Yes|Yes 109 | |Old MapReduce API|Yes|Yes|Yes 110 | |New MapReduce API|Yes (with some missing libraries)|Yes|Yes 111 | |======= 112 | 113 | To insert a cross-reference, first add a block ID for the element to which you're referring. The block ID is a unique identifier enclosed in double square brackets. Place it on a single line above the block element (figure, table, section, etc.). 114 | 115 | Here's a cross-reference to <>. Here's one to <>. Finally, here's one to <>. 116 | 117 | For the book to be valid, ids must be unique across the entire book, have no spaces, and not start with a number. 118 | 119 | O'Reilly house style calls for every formal figure, formal table, and formal code example to be preceded by a specific in-text reference. Formal figures and formal tables are created when you add captions to these elements. 120 | 121 | To include hyperlinks to external sources, add the full URL followed by the anchor text enclosed in single square brackets. This, for example, is a link to the https://www.oreilly.com/[O'Reilly home page]. The bracketed text will become a clickable link in web versions. In print versions, it will appear in the text, followed by the actual URL in parentheses. 122 | 123 | === Creating a Book Build in Atlas 124 | A helpful feature of Atlas is to create a book build in real time. This build shows the interior design of the book in PDF format, which allows you to see how elements will render on the print page. 125 | 126 | First, go to the Dashboard tab of your book project. Then, look to the right panel, click the "PDF" box, and hit "Build". Atlas will take a moment to generate the pages. A "Download" button will appear - click this, and a PDF will open in your web browser. This PDF may then be saved locally. 127 | 128 | [TIP] 129 | ==== 130 | If the Build button is grayed out, simply refresh the browser. The Build button should then become active. 131 | ==== 132 | 133 | ==== Adding a Chapter to the Book Build 134 | In order to add a new chapter to your book in Atlas, you'll need to make an adjustment to the Configure tab in Atlas. 135 | 136 | . Move to the Configure tab in the book project in Atlas. 137 | . Scroll to the middle section of the page under "Files." Find the chapter you'd like to add and click the + symbol. 138 | . This will move the chapter to the "Build Contents" section on the right side of the page. 139 | . Use the three stacked lines to reorder the chapters as desired. 140 | . Once your contents list looks correct, scroll down the page to click "Save Settings." 141 | . Go back to the Dashboard and run a new book build as discussed in the previous section to verify your changes. 142 | 143 | The generated PDF should now include the new chapter you just added, and the Table of Contents will reflect the new addition automatically. 144 | 145 | 146 | [TIP] 147 | ==== 148 | You can also update the build contents by editing the "files" array in the atlas.json file in the repository. Changes to the build contents made using the Configure tab will be reflected in the atlas.json file, and vice versa. 149 | ==== 150 | 151 | -------------------------------------------------------------------------------- /asciidoc_only/v1_only/afterword.asciidoc: -------------------------------------------------------------------------------- 1 | [preface] 2 | [role="afterword"] 3 | == Afterword 4 | 5 | Afterword text begins here. 6 | -------------------------------------------------------------------------------- /asciidoc_only/v1_only/book-docinfo.xml: -------------------------------------------------------------------------------- 1 | 978etc... 2 | 1 3 | 4 | FirstName 5 | LastName 6 | 7 | -------------------------------------------------------------------------------- /asciidoc_only/v1_only/book.asciidoc: -------------------------------------------------------------------------------- 1 | Book Title 2 | ========== 3 | 4 | ///////////// 5 | Keep a blank line between each include::[] macro 6 | ///////////// 7 | 8 | include::preface.asciidoc[] 9 | 10 | include::ch01.asciidoc[] 11 | -------------------------------------------------------------------------------- /asciidoc_only/v1_only/colophon/animal_or_cookbook/colo.asciidoc: -------------------------------------------------------------------------------- 1 | [colophon] 2 | = Colophon 3 | 4 | The animal on the cover of _FILL IN TITLE_ is FILL IN DESCRIPTION. 5 | 6 | Many of the animals on O'Reilly covers are endangered; all of them are important to the world. To learn more about how you can help, go to http://animals.oreilly.com[animals.oreilly.com]. 7 | 8 | The cover image is from FILL IN CREDITS. The cover fonts are URW Typewriter and Guardian Sans. The text font is Adobe Minion Pro; the heading font is Adobe Myriad Condensed; and the code font is Dalton Maag's Ubuntu Mono. 9 | -------------------------------------------------------------------------------- /asciidoc_only/v1_only/colophon/hacks/colo.asciidoc: -------------------------------------------------------------------------------- 1 | [colophon] 2 | = Colophon 3 | 4 | The cover image is from FILL IN CREDITS. The cover fonts are URW Typewriter and Guardian Sans. The text font is Benton Sans; the heading font is Benton Sans; and the code font is Dalton Maag's Ubuntu Mono. -------------------------------------------------------------------------------- /asciidoc_only/v1_only/colophon/makerpress/colo.asciidoc: -------------------------------------------------------------------------------- 1 | [colophon] 2 | = Colophon 3 | 4 | The cover and body font is Benton Sans, the heading font is Serifa, and the code font is Bitstream Vera Sans Mono. -------------------------------------------------------------------------------- /asciidoc_only/v1_only/colophon/realtime/colo.asciidoc: -------------------------------------------------------------------------------- 1 | [colophon] 2 | = Colophon 3 | 4 | The animal on the cover of _FILL IN TITLE_ is FILL IN DESCRIPTION. 5 | 6 | Many of the animals on O'Reilly covers are endangered; all of them are important to the world. To learn more about how you can help, go to http://animals.oreilly.com[animals.oreilly.com]. 7 | 8 | The cover image is from FILL IN CREDITS. The cover fonts are URW Typewriter and Guardian Sans. The text font is Adobe Minion Pro; the heading font is Adobe Myriad Condensed; and the code font is Dalton Maag's Ubuntu Mono. 9 | -------------------------------------------------------------------------------- /asciidoc_only/v1_only/colophon/trade/colo.asciidoc: -------------------------------------------------------------------------------- 1 | [colophon] 2 | = Colophon 3 | 4 | The cover and body fonts are Scala Pro, the heading font is Benton Sans, and the code font is TheSansMono Condensed. -------------------------------------------------------------------------------- /asciidoc_only/v1_only/dedication.asciidoc: -------------------------------------------------------------------------------- 1 | [dedication] 2 | == Dedication 3 | 4 | This book is dedicated to my cat, Garfield. 5 | -------------------------------------------------------------------------------- /asciidoc_only/v1_only/preface.asciidoc: -------------------------------------------------------------------------------- 1 | [preface] 2 | == Preface 3 | 4 | === Conventions Used in This Book 5 | 6 | The following typographical conventions are used in this book: 7 | 8 | _Italic_:: Indicates new terms, URLs, email addresses, filenames, and file extensions. 9 | 10 | +Constant width+:: Used for program listings, as well as within paragraphs to refer to program elements such as variable or function names, databases, data types, environment variables, statements, and keywords. 11 | 12 | **`Constant width bold`**:: Shows commands or other text that should be typed literally by the user. 13 | 14 | _++Constant width italic++_:: Shows text that should be replaced with user-supplied values or by values determined by context. 15 | 16 | 17 | [TIP] 18 | ==== 19 | This element signifies a tip or suggestion. 20 | ==== 21 | 22 | [NOTE] 23 | ==== 24 | This element signifies a general note. 25 | ==== 26 | 27 | [WARNING] 28 | ==== 29 | This element indicates a warning or caution. 30 | ==== 31 | 32 | === Using Code Examples 33 | ++++ 34 | PROD: Please reach out to author to find out if they will be uploading code examples to oreilly.com or their own site (e.g., GitHub). If there is no code download, delete this whole section. If there is, when you email digidist with the link, let them know what you filled in for title_title (should be as close to book title as possible, i.e., learning_python_2e). This info will determine where digidist loads the files. 35 | ++++ 36 | 37 | Supplemental material (code examples, exercises, etc.) is available for download at link:$$https://github.com/oreillymedia/title_title$$[]. 38 | 39 | This book is here to help you get your job done. In general, if example code is offered with this book, you may use it in your programs and documentation. You do not need to contact us for permission unless you’re reproducing a significant portion of the code. For example, writing a program that uses several chunks of code from this book does not require permission. Selling or distributing a CD-ROM of examples from O’Reilly books does require permission. Answering a question by citing this book and quoting example code does not require permission. Incorporating a significant amount of example code from this book into your product’s documentation does require permission. 40 | 41 | We appreciate, but do not require, attribution. An attribution usually includes the title, author, publisher, and ISBN. For example: “_Book Title_ by Some Author (O’Reilly). Copyright 2012 Some Copyright Holder, 978-0-596-xxxx-x.” 42 | 43 | If you feel your use of code examples falls outside fair use or the permission given above, feel free to contact us at pass:[permissions@oreilly.com]. 44 | 45 | === Safari® Books Online 46 | 47 | [role = "safarienabled"] 48 | [NOTE] 49 | ==== 50 | pass:[Safari Books Online] is an on-demand digital library that delivers expert pass:[content] in both book and video form from the world’s leading authors in technology and business. 51 | ==== 52 | 53 | Technology professionals, software developers, web designers, and business and creative professionals use Safari Books Online as their primary resource for research, problem solving, learning, and certification training. 54 | 55 | Safari Books Online offers a range of pass:[plans and pricing] for pass:[enterprise], pass:[government], pass:[education], and individuals. 56 | 57 | Members have access to thousands of books, training videos, and prepublication manuscripts in one fully searchable database from publishers like O’Reilly Media, Prentice Hall Professional, Addison-Wesley Professional, Microsoft Press, Sams, Que, Peachpit Press, Focal Press, Cisco Press, John Wiley & Sons, Syngress, Morgan Kaufmann, IBM Redbooks, Packt, Adobe Press, FT Press, Apress, Manning, New Riders, McGraw-Hill, Jones & Bartlett, Course Technology, and hundreds pass:[more]. For more information about Safari Books Online, please visit us pass:[online]. 58 | 59 | === How to Contact Us 60 | 61 | Please address comments and questions concerning this book to the publisher: 62 | 63 | ++++ 64 | 65 | O’Reilly Media, Inc. 66 | 1005 Gravenstein Highway North 67 | Sebastopol, CA 95472 68 | 800-998-9938 (in the United States or Canada) 69 | 707-829-0515 (international or local) 70 | 707-829-0104 (fax) 71 | 72 | ++++ 73 | 74 | We have a web page for this book, where we list errata, examples, and any additional information. You can access this page at link:$$http://www.oreilly.com/catalog/$$[]. 75 | 76 | ++++ 77 | Don't forget to update the link above. 78 | ++++ 79 | 80 | To comment or ask technical questions about this book, send email to pass:[bookquestions@oreilly.com]. 81 | 82 | For more information about our books, courses, conferences, and news, see our website at link:$$http://www.oreilly.com$$[]. 83 | 84 | Find us on Facebook: link:$$http://facebook.com/oreilly$$[] 85 | 86 | Follow us on Twitter: link:$$http://twitter.com/oreillymedia$$[] 87 | 88 | Watch us on YouTube: link:$$http://www.youtube.com/oreillymedia$$[] 89 | 90 | === Acknowledgments 91 | 92 | ++++ 93 | Fill in... 94 | ++++ 95 | -------------------------------------------------------------------------------- /author_bio.html: -------------------------------------------------------------------------------- 1 |
2 |

About the Author(s)

3 |

John Doe does some interesting stuff...

4 |
5 | -------------------------------------------------------------------------------- /colo.html: -------------------------------------------------------------------------------- 1 |
2 |

Colophon

3 | 4 |

The animal on the cover of FILL IN TITLE is FILL IN DESCRIPTION.

5 | 6 |

Many of the animals on O'Reilly covers are endangered; all of them are important to the world.

7 | 8 |

The cover illustration is by Karen Montgomery, based on a black-and-white engraving from FILL IN CREDITS. The series design is by Edie Freedman, Ellie Volckhausen, and Karen Montgomery. The cover fonts are Gilroy Semibold and Guardian Sans. The text font is Adobe Minion Pro; the heading font is Adobe Myriad Condensed; and the code font is Dalton Maag's Ubuntu Mono.

9 | 10 |
11 | -------------------------------------------------------------------------------- /copyright.html: -------------------------------------------------------------------------------- 1 |
2 | 3 | 4 |

{{ title }}

5 | 6 | 7 |

by ??? ?. ???

8 | 9 | 10 |

Copyright © 2017 ???. All rights reserved.

11 | 12 | 13 |

Published by O’Reilly Media, Inc., 1005 Gravenstein Highway North, Sebastopol, CA 95472.

14 | 15 |

O’Reilly books may be purchased for educational, business, or sales promotional use. Online editions are also available for most 16 | titles (https://oreilly.com). For more information, contact our corporate/institutional sales department: 800-998-9938 or .

17 | 18 | 19 |
    20 |
  • Acquisitions Editor: FILL IN
    • 21 |
  • Development Editor: TO COME
    • 22 |
  • Production Editor: TO COME
    • 23 |
  • Copyeditor: TO COME
    • 24 |
  • Proofreader: TO COME
    • 25 |
  • Indexer: TO COME
    • 26 |
  • Cover Designer: TO COME
    • 27 |
  • Cover Illustrator: TO COME
    • 28 |
  • Interior Designer: David Futato
    • 29 |
  • Interior Illustrator: Kate Dullea
    • 30 |
31 | 32 | 33 |
    34 |
  • Month Year: First Edition
    • 35 |
36 | 37 | 38 |
39 |

Revision History for the First Edition

40 |
    41 |
  • yyyy-mm-dd: First Release
    • 42 |
43 |
44 | 45 | 46 |

See https://oreilly.com/catalog/errata.csp?isbn=XXXXXXXXXXXXX for release details.

47 | 48 | 49 |
50 |

The O’Reilly logo is a registered trademark of O’Reilly Media, Inc. {{ title }}, the cover image, and related trade dress are trademarks of O’Reilly Media, Inc.

51 | 52 |

The views expressed in this work are those of the author(s), and do not represent the publisher's views. While the publisher and the author(s) have used good faith efforts to ensure that the information and instructions contained in this work are accurate, the publisher and the author(s) disclaim all responsibility for errors or omissions, including without limitation responsibility for damages resulting from the use of or reliance on this work. Use of the information and instructions contained in this work is at your own risk. If any code samples or other technology this work contains or describes is subject to open source licenses or the intellectual property rights of others, it is your responsibility to ensure that your use thereof complies with such licenses and/or rights.

53 |
54 | 55 |
56 |

xxx-x-xxx-xxxx-x

57 |

[???]

58 |
59 | 60 |
61 | -------------------------------------------------------------------------------- /cover.html: -------------------------------------------------------------------------------- 1 |
2 | 3 |
-------------------------------------------------------------------------------- /dedication.html: -------------------------------------------------------------------------------- 1 |
2 |

Dedication

3 |

This book is dedicated to my cat, Garfield.

4 |
-------------------------------------------------------------------------------- /docbook_only/afterword.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | Afterword 6 | 7 | Put the text of your Afterword here... 8 | 9 | Note this is an <appendix> element with 10 | role="afterword". It will render as a “moral” Afterword, 11 | showing the title but suppressing the usual Appendix label from TOC, opener, 12 | footers, and PDF bookmark. 13 | -------------------------------------------------------------------------------- /docbook_only/appa.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | Appendix Title Here 6 | 7 | 8 | Section Title Here 9 | Opening para... 10 | 11 | 12 | -------------------------------------------------------------------------------- /docbook_only/bibliography.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | Bibliography 6 | 7 | Bibliography content starts here. 8 | 9 | 16 | 17 | 18 | AhoSethiUllman96 19 | 20 | Alfred V.Aho 21 | RaviSethi 22 | Jeffrey D.Ullman 23 | 24 | 1996 25 | Bell Telephone Laboratories, Inc. 26 | James T.DeWolf 27 | 0-201-10088-6 28 | 29 | Addison-Wesley Publishing Company 30 | 31 | Compilers, Principles, Techniques, and Tools 32 | 33 | 34 | 35 | 36 | Walsh, Norman. 37 | Introduction to Cascading Style Sheets. 38 | 39 | 40 | The World Wide Web Journal 41 | 21. 42 | O'Reilly & Associates, Inc. and 43 | The World Wide Web Consortium. 44 | Winter, 1996. 45 | 46 | 47 | -------------------------------------------------------------------------------- /docbook_only/ch01.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 6 | Chapter Title Goes Here 7 | 8 | Put some introductory text here. 9 | 10 | 11 | Your First Section Heading Here 12 | 13 | Put more content here. 14 | 15 | 16 | -------------------------------------------------------------------------------- /docbook_only/foreword.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 6 | 7 | Firstname 8 | 9 | Lastname 10 | 11 | 12 | 13 | Foreword 14 | 15 | The world of web services has been on a fast track to supernova ever 16 | since the architect astronauts spotted another meme to rocket out of 17 | pragmatism and into the universe of enterprisey. But thankfully all is not 18 | lost, for you can rewrite this placeholder text! 19 | 20 | If you want your Foreword to have an attribution at the end, use the 21 | <prefaceinfo> element as demonstrated here. The 22 | stylesheets will render this as a right-aligned “—Firstname Lastname” below 23 | the final paragraph. 24 | -------------------------------------------------------------------------------- /docbook_only/glossary.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | Glossary 6 | 7 | A glossary contains a collection of terms and brief descriptions or 8 | definitions of those terms. The basic markup follows. 9 | 10 | 11 | Term1 12 | 13 | 14 | This is the definition of Term1. 15 | 16 | 17 | 18 | 19 | Term2 20 | 21 | 22 | 23 | 24 | 25 | Term3 26 | 27 | 28 | This is the definition of Term3. It includes a “see also” 29 | reference. 30 | 31 | 32 | 33 | 34 | 35 | 36 | Term4 37 | 38 | 39 | This is the definition of Term4. It includes two “see also” 40 | references. 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | -------------------------------------------------------------------------------- /docbook_only/part1.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | Getting Started 6 | 7 | 8 | The <partintro> element is not required. But if you want any introductory text on the part page, it goes here. 9 | 10 | 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docbook_only/preface.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | Preface 6 | 7 | 8 | Conventions Used in This Book 9 | 10 | The following typographical conventions are used in this 11 | book: 12 | 13 | 14 | 15 | Italic 16 | 17 | 18 | Indicates new terms, URLs, email addresses, filenames, and 19 | file extensions. 20 | 21 | 22 | 23 | 24 | Constant width 25 | 26 | 27 | Used for program listings, as well as within paragraphs to 28 | refer to program elements such as variable or function names, 29 | databases, data types, environment variables, statements, and 30 | keywords. 31 | 32 | 33 | 34 | 35 | Constant width bold 36 | 37 | 38 | Shows commands or other text that should be typed literally by 39 | the user. 40 | 41 | 42 | 43 | 44 | Constant width italic 45 | 46 | 47 | Shows text that should be replaced with user-supplied values 48 | or by values determined by context. 49 | 50 | 51 | 52 | 53 | 54 | This element signifies a tip or suggestion. 55 | 56 | 57 | 58 | This element signifies a general note. 59 | 60 | 61 | 62 | This element indicates a warning or caution. 63 | 64 | 65 | 66 | 67 | Using Code Examples 68 | 69 | PROD: Please reach out to author to find out if they will be 70 | uploading code examples to oreilly.com or their own site (e.g., GitHub). 71 | If there is no code download, delete this whole section. If there is, when you email digidist with the link, let them know what you filled in for title_title (should be as close to book title as possible, i.e., learning_python_2e). This info will determine where digidist loads the files. 72 | 73 | Supplemental material (code examples, exercises, etc.) is available 74 | for download at . 75 | 76 | 77 | If you have a technical question or a problem using the code examples, please send email to support@oreilly.com. 78 | 79 | This book is here to help you get your job done. In general, if 80 | example code is offered with this book, you may use it in your programs 81 | and documentation. You do not need to contact us for permission unless 82 | you’re reproducing a significant portion of the code. For example, writing 83 | a program that uses several chunks of code from this book does not require 84 | permission. Selling or distributing examples from O’Reilly 85 | books does require permission. Answering a question by citing this book 86 | and quoting example code does not require permission. Incorporating a 87 | significant amount of example code from this book into your product’s 88 | documentation does require permission. 89 | 90 | We appreciate, but generally do not require, attribution. An attribution 91 | usually includes the title, author, publisher, and ISBN. For example: 92 | “Book Title by Some Author (O’Reilly). Copyright 2012 93 | Some Copyright Holder, 978-0-596-xxxx-x.” 94 | 95 | If you feel your use of code examples falls outside fair use or the 96 | permission given above, feel free to contact us at 97 | permissions@oreilly.com. 98 | 99 | 100 | 101 | O'Reilly Online Learning 102 | 103 | 104 | For more than 40 years, O'Reilly Media has provided technology and business training, knowledge, and insight to help companies succeed. 106 | 107 | 108 | Our unique network of experts and innovators share their knowledge and expertise through books, articles, and our online learning platform. O’Reilly’s online learning platform gives you on-demand access to live training courses, in-depth learning paths, interactive coding environments, and a vast collection of text and video from O'Reilly and 200+ other publishers. For more information, visit http://oreilly.com. 110 | 111 | 112 | 113 | 114 | How to Contact Us 115 | 116 | Please address comments and questions concerning this book to the 117 | publisher: 118 | 119 | 120 | O’Reilly Media, Inc. 121 | 122 | 1005 Gravenstein Highway North 123 | 124 | Sebastopol, CA 95472 125 | 126 | 800-889-8969 (in the United States or Canada) 127 | 128 | 707-827-7019 (international or local) 129 | 130 | 707-829-0104 (fax) 131 | support@oreilly.com 132 | 133 | 134 | 135 | We have a web page for this book, where we list errata, examples, 136 | and any additional information. You can access this page at . 138 | 139 | Don’t forget to update the <url> attribute, too. 140 | 141 | For news and information about our books and courses, visit . 143 | 144 | Find us on LinkedIn: 146 | 147 | Watch us on YouTube: 149 | 150 | 151 | 152 | Acknowledgments 153 | Fill in here 154 | 155 | 156 | -------------------------------------------------------------------------------- /docbook_only/preface_make.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | Preface 6 | 7 | 8 | Conventions Used in This Book 9 | 10 | The following typographical conventions are used in this 11 | book: 12 | 13 | 14 | 15 | Italic 16 | 17 | 18 | Indicates new terms, URLs, email addresses, filenames, and 19 | file extensions. 20 | 21 | 22 | 23 | 24 | Constant width 25 | 26 | 27 | Used for program listings, as well as within paragraphs to 28 | refer to program elements such as variable or function names, 29 | databases, data types, environment variables, statements, and 30 | keywords. 31 | 32 | 33 | 34 | 35 | Constant width bold 36 | 37 | 38 | Shows commands or other text that should be typed literally by 39 | the user. 40 | 41 | 42 | 43 | 44 | Constant width italic 45 | 46 | 47 | Shows text that should be replaced with user-supplied values 48 | or by values determined by context. 49 | 50 | 51 | 52 | 53 | 54 | This element signifies a tip or suggestion. 55 | 56 | 57 | 58 | This element signifies a general note. 59 | 60 | 61 | 62 | This element indicates a warning or caution. 63 | 64 | 65 | 66 | 67 | Using Code Examples 68 | 69 | PROD: Please reach out to author to find out if they will be 70 | uploading code examples to oreilly.com or their own site (e.g., GitHub). 71 | If there is no code download, delete this whole section. If there is, when you email digidist with the link, let them know what you filled in for title_title (should be as close to book title as possible, i.e., learning_python_2e). This info will determine where digidist loads the files. 72 | 73 | Supplemental material (code examples, exercises, etc.) is available 74 | for download at . 75 | 76 | 77 | If you have a technical question or a problem using the code examples, please send email to bookquestions@oreilly.com. 78 | 79 | This book is here to help you get your job done. In general, if 80 | example code is offered with this book, you may use it in your programs 81 | and documentation. You do not need to contact us for permission unless 82 | you’re reproducing a significant portion of the code. For example, writing 83 | a program that uses several chunks of code from this book does not require 84 | permission. Selling or distributing examples from Make: 85 | books does require permission. Answering a question by citing this book 86 | and quoting example code does not require permission. Incorporating a 87 | significant amount of example code from this book into your product’s 88 | documentation does require permission. 89 | 90 | We appreciate, but generally do not require, attribution. An attribution 91 | usually includes the title, author, publisher, and ISBN. For example: 92 | “Book Title by Some Author (O’Reilly). Copyright 2012 93 | Some Copyright Holder, 978-0-596-xxxx-x.” 94 | 95 | If you feel your use of code examples falls outside fair use or the 96 | permission given above, feel free to contact us at 97 | bookpermissions@makermedia.com. 98 | 99 | 100 | 101 | O'Reilly Online Learning 102 | 103 | 104 | For more than 40 years, O'Reilly Media has provided technology and business training, knowledge, and insight to help companies succeed. 106 | 107 | 108 | Our unique network of experts and innovators share their knowledge and expertise through books, articles, conferences, and our online learning platform. O’Reilly’s online learning platform gives you on-demand access to live training courses, in-depth learning paths, interactive coding environments, and a vast collection of text and video from O'Reilly and 200+ other publishers. For more information, please visit http://oreilly.com. 110 | 111 | 112 | 113 | 114 | How to Contact Us 115 | 116 | Please address comments and questions concerning this book to the 117 | publisher: 118 | 119 | 120 | Maker Media, Inc. 121 | 1700 Montgomery Street, Suite 240 122 | San Francisco, CA 94111 123 | 877-306-6253 (in the United States or Canada) 124 | 707-639-1355 (international or local) 125 | 126 | 127 | We have a web page for this book, where we list errata, examples, 128 | and any additional information. You can access this page at . 130 | 131 | Don’t forget to update the <url> attribute, too. 132 | 133 | Make: unites, inspires, informs, and entertains a growing community of resourceful people who undertake amazing projects in 134 | their backyards, basements, and garages. Make: celebrates your 135 | right to tweak, hack, and bend any technology to your will. The 136 | Make: audience continues to be a growing culture and community that believes in bettering ourselves, our environment, our 137 | educational system—our entire world. This is much more than 138 | an audience, it’s a worldwide movement that Make is leading we call it the Maker Movement. 139 | 140 | For more information about Make:, visit us online: 141 | 142 | 143 | Make: magazine: 144 | Maker Faire: 145 | Makezine.com: 146 | Maker Shed: 147 | 148 | To comment or ask technical questions about this book, send email to 149 | bookquestions@oreilly.com. 150 | 151 | 152 | 153 | 154 | Acknowledgments 155 | Fill in here 156 | 157 | 158 | 159 | -------------------------------------------------------------------------------- /docbook_only/sample_chapter.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 6 | Chapter Title 7 | Chapter text begins here. Replace any of this placeholder text with your opus. The following portion outlines heading levels and section structure. 8 | 9 | This Is a Top-Level Heading (A-Head) 10 | Section text begins here. 11 | 12 | This Is a Second-Level Heading (B-Head) 13 | Your text goes here. 14 | 15 | This Is a Third-Level Heading (C-Head) 16 | Section content goes here. 17 | 18 | This Is a Fourth-Level Heading (D-Head) 19 | Section content goes here. 20 | 21 | This Is a Fifth-Level Heading 22 | This is the lowest level of section delineation available, but is not commonly used. 23 | 24 | Next we've included a few examples of commonly used block elements. You can add these elements using the buttons in the toolbar, as well. 25 | 26 | 27 | This Is a Note 28 | Many people use notes to qualify a statement they made in the preceding paragraphs, or to warn their readers about pitfalls they might run into. 29 | 30 | 31 | 32 | This is a warning, used to alert readers to something important or encourage caution. Headings are optional for admonitions like notes and warnings. 33 | 34 | 35 | Here is an informal code listing: 36 | 37 | print('hello world') 38 | 39 | And this is a formal listing, or example: 40 | 41 | 42 | Hello World in Python 43 | print "Hello World" 44 | # Formal listings have titles that will be numbered in output. 45 | 46 | 47 | For either type of listing, you have the option of specifying the code language displayed via the language attribute. 48 | 49 | You can also specify inline text as code: print "Hello World". 50 | 51 | Now, let's take a look at a figure with a caption: 52 | 53 |
54 | Figures like this will be automatically numbered in output. 55 | 56 | 57 | 58 | 59 | Drawing of Tarsiers 60 | 61 |
62 | 63 | Here is a blockquote with an author attribution: 64 | 65 |
66 | Lewis Carol 67 | Alice was beginning to get very tired of sitting by her sister on the bank, and of having nothing to do: once or twice she had peeped into the book her sister was reading, but it had no pictures or conversations in it, and what is the use of a book, thought Alice without pictures or conversation? 68 |
69 | 70 | There are three types of lists available. Numbered (ordered) lists are often used to describe steps in a process: 71 | 72 | 73 | 74 | Parse the request. 75 | 76 | 77 | Choose a handler function. 78 | 79 | 80 | Run the handler function. 81 | 82 | 83 | 84 | Bulleted (unordered) lists are good for describing a set of requirements: 85 | 86 | 87 | 88 | HTML source 89 | 90 | 91 | CSS stylesheets 92 | 93 | 94 | JavaScript code 95 | 96 | 97 | 98 | Definition/variable lists serve as glossaries of terminology: 99 | 100 | 101 | 102 | selectSource 103 | 104 | Returns a Source containing all the IDs and values from the database. This allows you to write streaming code. 105 | 106 | 107 | 108 | selectList 109 | 110 | Returns a list containing all the IDs and values from the database. All records will be loaded into memory. 111 | 112 | 113 | 114 | selectFirst 115 | 116 | Takes just the first ID and value from the database, if available. 117 | 118 | 119 | 120 | selectKeys 121 | 122 | Returns only the keys, without the values, as a Source. 123 | 124 | 125 | 126 | 127 | 128 | Sidebar Title 129 | Here's a sidebar. Sidebars are great for setting aside a section of text that is related to the surrounding content but that doesn't necessarily fit into the main flow. 130 | 131 | 132 | Finally, here's a sample table: 133 | 134 | 135 | Features supported by Hadoop release series 136 | 137 | 138 | 139 | Feature 140 | 1.x 141 | 0.22 142 | 2.x 143 | 144 | 145 | 146 | 147 | Secure authentication 148 | Yes 149 | No 150 | Yes 151 | 152 | 153 | Old configuration names 154 | Yes 155 | Deprecated 156 | Deprecated 157 | 158 | 159 | New configuration names 160 | No 161 | Yes 162 | Yes 163 | 164 | 165 | Old MapReduce API 166 | Yes 167 | Yes 168 | Yes 169 | 170 | 171 | New MapReduce API 172 | Yes (with some missing libraries) 173 | Yes 174 | Yes 175 | 176 | 177 | 178 |
179 | 180 | 181 | 182 | 183 | 184 | 185 | 186 | -------------------------------------------------------------------------------- /docbook_only/v1_only/ascii_art/ascii_art.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | ASCII Art in DocBook 5 | 6 | The following explains how to mark up special cases 7 | of ASCII art in DocBook. For general guidelines on preparing 8 | illustrations—along with how and when to get in touch with our 9 | illustration staff—see . Thanks for 11 | your attention to these details. 12 | 13 | 14 | Incoming Text Blocks 15 | 16 | While it’s perfectly valid DocBook to have a 17 | <figure> that contains a “verbatim block” 18 | of text<programlisting>, 19 | <screen>, or 20 | <literallayout> instead 21 | of a pointer to a graphic file, using such markup creates 22 | ambiguities for production staff. Do you want the typeset book 23 | to display the text exactly as is (like 24 | code), or should the illustrator redraw it (“line art”) or 25 | process it in any other way (e.g., remapping fonts to match 26 | standard figures)? 27 | 28 | To avoid problems, please distinguish all figures 29 | containing text blocks as follows: 30 | 31 | 32 | 33 | “Sketch” for Figure to be Drawn by Illustrator 34 | 35 | 36 | If you intend such a text block as a “sketch” to 37 | be drawn or modified in any way by our illustrator, 38 | please mark it up like so (): 40 | 41 | <figure role="orm:drawme" id="FIG_ID"/> 42 | 43 | The @role="orm:drawme" attribute 44 | will signal our tools to sequence a proper placeholder 45 | for it during our intake process. The final version will 46 | be drawn by a professional illustrator, in consultation 47 | with you; for example, see . 48 | 49 | 50 | 51 | 52 | Text to be Kept Exactly As Is 53 | 54 | If you want such a text block to be rendered 55 | exactly as it appears in the PDF 56 | generated by our build system, do not add the custom 57 | @role attribute. When the manuscript 58 | comes in to production, we will leave it as is, and it 59 | will render just as in the PDF (i.e., using the same 60 | font as for code, but placed inside a standard captioned 61 | figure box). For example, see . 63 | 64 | 65 | 66 | 67 |
68 | ASCII Art to be Redrawn by Illustrator 69 | 70 |
71 | 72 | 73 |
74 | Redrawn Version of <xref linkend="text_for_graphic"/> 75 | 76 | 77 | 78 | 79 | 80 |
81 | 82 |
83 | ASCII Art to be Kept As Is 84 | 85 | 86 | 87 |
88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | Examples vs. Figures 113 | In some cases, it may be more appropriate to use an 114 | <example> instead of a 115 | <figure> to “illustrate” a verbatim 116 | block. Your editor can provide more guidance here. 117 | 118 | 119 | 120 | 121 | Incoming Graphics 122 | 123 | For screenshots or other illustrations for which you’re 124 | providing a graphic file, use standard 125 | <figure> markup as demonstrated in the 126 | source below (and as described in our “Get Started Writing in 127 | DocBook” guide). 129 | 130 |
131 | Traditional Figure (Raw Version, MS Stage) 132 | 133 | 134 | 135 | 136 | 137 |
138 | 139 | In the MS phase, it will look something like in PDFs rendered by our build 141 | system. During the production phase, the figure will be 142 | processed to look something more like in the printed book. 144 | 145 | Reminder: for instructions on preparing the actual graphic 146 | files, please see , and 148 | contact our illustration staff with any questions or for 149 | special cases as explained therein. 150 | 151 |
152 | Processed Version of <xref linkend="std_fig_ms_version"/> 153 | 154 | 155 | 156 | 157 | 158 |
159 | 160 | 161 | 162 | 163 | 164 | -------------------------------------------------------------------------------- /docbook_only/v1_only/ascii_art/ascii_art.xml.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oreillymedia/orm_book_samples/66898f831dc795cabc85781b6b028701b6a94ad1/docbook_only/v1_only/ascii_art/ascii_art.xml.pdf -------------------------------------------------------------------------------- /docbook_only/v1_only/ascii_art/figs/incoming/ascii_commandments.txt: -------------------------------------------------------------------------------- 1 | -------------------THE ASCII ART FAQ TEN COMMANDMENTS------------------- 2 | 3 | \\\\`/// 4 | / _ _| 1. Thou shalt read the FAQ. 5 | (\'('\/') 2. Thou shalt not remove the 6 | ______/( >(__ initials from any ASCII art. 7 | /`- \ \_=__| `\ 3. Thou shalt not claim ownership 8 | / /__( _____\ _____ of someone else's ASCII art. 9 | /_ \.____ ," "." ",__ 4. Thou shalt read the FAQ. 10 | | / _\__/_ - / \ 5. Thou shalt ask permission 11 | \/ /____ \ASCII ART FAQ /// before using someone else's 12 | ) / / \__\ - | ASCII art. 13 | '-.__|_/ ///| I VI | 6. Thou shalt not sell someone 14 | \_ | | | else's ASCII art. 15 | | | II VII | 7. Thou shalt read the darn FAQ. 16 | \ | | | 8. Thou shalt not post someone 17 | / | III VIII | else's ASCII art without making 18 | \ | | | clear that you didn't make it. 19 | \_ | IV IX | 9. Thou shalt not assume that 20 | \| | | ASCII art isn't art at all. 21 | | V X | 10. Thou shalt read the FAQing FAQ. 22 | |______b'ger______| 23 | 24 | [http://www.ascii-art.de/ascii/faq.html] -------------------------------------------------------------------------------- /docbook_only/v1_only/ascii_art/figs/incoming/ch02dia1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oreillymedia/orm_book_samples/66898f831dc795cabc85781b6b028701b6a94ad1/docbook_only/v1_only/ascii_art/figs/incoming/ch02dia1.png -------------------------------------------------------------------------------- /docbook_only/v1_only/ascii_art/figs/incoming/iq-interaction.txt: -------------------------------------------------------------------------------- 1 | Sender Receiver 2 | | | 3 | | IQ-get | 4 | |------------------>| 5 | | IQ-result | 6 | |<------------------| 7 | | IQ-set | 8 | |------------------>| 9 | | IQ-result | 10 | |<------------------| 11 | | | 12 | -------------------------------------------------------------------------------- /docbook_only/v1_only/ascii_art/figs/print/svc_0201.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oreillymedia/orm_book_samples/66898f831dc795cabc85781b6b028701b6a94ad1/docbook_only/v1_only/ascii_art/figs/print/svc_0201.pdf -------------------------------------------------------------------------------- /docbook_only/v1_only/ascii_art/figs/print/xmpp_0205.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oreillymedia/orm_book_samples/66898f831dc795cabc85781b6b028701b6a94ad1/docbook_only/v1_only/ascii_art/figs/print/xmpp_0205.pdf -------------------------------------------------------------------------------- /docbook_only/v1_only/book-docinfo.xml: -------------------------------------------------------------------------------- 1 | 1 2 | 3 | FirstName 4 | LastName 5 | 6 | -------------------------------------------------------------------------------- /docbook_only/v1_only/book.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | Book Title Goes Here 20 | 21 | 22 | 1 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /docbook_only/v1_only/colophon/animal_or_cookbook/colo.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Colophon 5 | The animal on the cover of FILL IN TITLE 6 | is FILL IN DESCRIPTION. 7 | 8 | Many of the animals on O'Reilly covers are endangered; all of them are important to the world. To learn more about how you can help, go to animals.oreilly.com. 9 | The cover image is from FILL IN CREDITS. The cover fonts are URW Typewriter 10 | and Guardian Sans. The text font is Adobe Minion Pro; the heading font is Adobe 11 | Myriad Condensed; and the code font is Dalton Maag's Ubuntu Mono. 12 | 13 | -------------------------------------------------------------------------------- /docbook_only/v1_only/colophon/hacks/colo.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Colophon 5 | The cover image is from FILL IN CREDITS. The cover fonts are URW Typewriter 6 | and Guardian Sans. The text font is Benton Sans; the heading font is Benton Sans; 7 | and the code font is Dalton Maag's Ubuntu Mono. 8 | 9 | -------------------------------------------------------------------------------- /docbook_only/v1_only/colophon/realtime/colo.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Colophon 5 | The animal on the cover of FILL IN TITLE 6 | is FILL IN DESCRIPTION. 7 | 8 | Many of the animals on O'Reilly covers are endangered; all of them are important to the world. To learn more about how you can help, go to animals.oreilly.com. 9 | The cover image is from FILL IN CREDITS. The cover fonts are URW Typewriter 10 | and Guardian Sans. The text font is Adobe Minion Pro; the heading font is Adobe 11 | Myriad Condensed; and the code font is Dalton Maag's Ubuntu Mono. 12 | 13 | -------------------------------------------------------------------------------- /docbook_only/v1_only/colophon/theory/colo.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Colophon 5 | The cover image is from CREDIT HERE. The cover fonts are Akzidenz Grotesk and Orator. 6 | The text font is Meridien; the heading font is ITC Bailey. 7 | 8 | -------------------------------------------------------------------------------- /docbook_only/v1_only/colophon/trade/colo.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Colophon 5 | The cover and body fonts are Scala Pro, the heading font is Benton Sans, and the code font is TheSansMono Condensed. 6 | 7 | -------------------------------------------------------------------------------- /docbook_only/v1_only/dedication.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |
5 | A. T. Moseley 6 | For all the toolsmiths who don’t yet have a name for what they do. 7 |
8 |
9 | L. Cohen 10 | Ditto. Sincerely. 11 |
12 | (If either of us forgot to mention you, please use the View/Submit Errata link on the catalog page for this book and we’ll agitate for a reprint with corrections just as soon as humanly possible.) 13 | 14 | -------------------------------------------------------------------------------- /htmlbook_only/afterword.html: -------------------------------------------------------------------------------- 1 |
2 |

Afterword Title

3 |

Afterword text begins here.

4 |
-------------------------------------------------------------------------------- /htmlbook_only/appa.html: -------------------------------------------------------------------------------- 1 |
2 |

Appendix Title

3 | 4 |
5 |

This Is an A-Head

6 | 7 |

An appendix is generally used for extra material that supplements your main book content.

8 |
9 |
10 | -------------------------------------------------------------------------------- /htmlbook_only/bibliography.html: -------------------------------------------------------------------------------- 1 |
2 |

Bibliography

3 |

Bibliography content starts here.

4 |
-------------------------------------------------------------------------------- /htmlbook_only/ch01.html: -------------------------------------------------------------------------------- 1 |
2 |

Chapter Title Goes Here

3 |

Put some introductory text here.

4 |
5 |

Your First Section Heading Here

6 |

Put more content here.

7 |
8 |
-------------------------------------------------------------------------------- /htmlbook_only/foreword.html: -------------------------------------------------------------------------------- 1 |
2 |

Foreword

3 |

Foreword text begins here.

4 |
-------------------------------------------------------------------------------- /htmlbook_only/glossary.html: -------------------------------------------------------------------------------- 1 |
2 |

Glossary

3 | 4 |

A glossary contains a collection of terms and brief descriptions or definitions of those terms. The basic markup follows.

5 | 6 |
7 |
8 | Gloss Term 9 |
10 |
Gloss definition.
11 |
12 | Gloss Term 2 13 |
14 |
Gloss definition 2.
15 |
16 |
-------------------------------------------------------------------------------- /htmlbook_only/intro.html: -------------------------------------------------------------------------------- 1 |
2 |

Introduction

3 | 4 |

Content here.

5 | 6 |
7 | -------------------------------------------------------------------------------- /htmlbook_only/part1.html: -------------------------------------------------------------------------------- 1 |
2 |

Part Title

3 |

Part introduction text here.

4 | 5 |
-------------------------------------------------------------------------------- /htmlbook_only/preface.html: -------------------------------------------------------------------------------- 1 |
2 |

Preface

3 |
4 |

Conventions Used in This Book

5 |

The following typographical conventions are used in this book:

6 |
7 |
Italic
8 |
9 |

Indicates new terms, URLs, email addresses, filenames, and file extensions.

10 |
11 |
Constant width
12 |
13 |

Used for program listings, as well as within paragraphs to refer to program elements such as variable or function names, databases, data types, environment variables, statements, and keywords.

14 |
15 |
Constant width bold
16 |
17 |

Shows commands or other text that should be typed literally by the user.

18 |
19 |
Constant width italic
20 |
21 |

Shows text that should be replaced with user-supplied values or by values determined by context.

22 |
23 |
24 |
25 |

This element signifies a tip or suggestion.

26 |
27 |
28 |

This element signifies a general note.

29 |
30 |
31 |

This element indicates a warning or caution.

32 |
33 |
34 |
35 |

Using Code Examples

36 | 37 |

Supplemental material (code examples, exercises, etc.) is available for download at https://github.com/oreillymedia/title_title.

38 |

If you have a technical question or a problem using the code examples, please send email to .

39 |

This book is here to help you get your job done. In general, if example code is offered with this book, you may use it in your programs and documentation. You do not need to contact us for permission unless you’re reproducing a significant portion of the code. For example, writing a program that uses several chunks of code from this book does not require permission. Selling or distributing examples from O’Reilly books does require permission. Answering a question by citing this book and quoting example code does not require permission. Incorporating a significant amount of example code from this book into your product’s documentation does require permission.

40 |

We appreciate, but generally do not require, attribution. An attribution usually includes the title, author, publisher, and ISBN. For example: “Book Title by Some Author (O’Reilly). Copyright 2012 Some Copyright Holder, 978-0-596-xxxx-x.”

41 |

If you feel your use of code examples falls outside fair use or the permission given above, feel free to contact us at .

42 |
43 |
44 |

O'Reilly Online Learning

45 |
46 |

For more than 40 years, O'Reilly Media has provided technology and business training, knowledge, and insight to help companies succeed.

47 |
48 |

Our unique network of experts and innovators share their knowledge and expertise through books, articles, and our online learning platform. O’Reilly’s online learning platform gives you on-demand access to live training courses, in-depth learning paths, interactive coding environments, and a vast collection of text and video from O'Reilly and 200+ other publishers. For more information, visit https://oreilly.com.

49 |
50 |
51 |

How to Contact Us

52 |

Please address comments and questions concerning this book to the publisher:

53 | 63 |

We have a web page for this book, where we list errata, examples, and any additional information. You can access this page at https://www.oreilly.com/catalog/<catalog page>.

64 | 65 | 66 |

For news and information about our books and courses, visit https://oreilly.com.

67 |

Find us on LinkedIn: https://linkedin.com/company/oreilly-media

68 |

Watch us on YouTube: https://youtube.com/oreillymedia

69 |
70 |
71 |

Acknowledgments

72 | 73 |
74 |
75 | -------------------------------------------------------------------------------- /htmlbook_only/preface_make.html: -------------------------------------------------------------------------------- 1 |
2 |

Preface

3 |
4 |

Conventions Used in This Book

5 |

The following typographical conventions are used in this book:

6 |
7 |
Italic
8 |
9 |

Indicates new terms, URLs, email addresses, filenames, and file extensions.

10 |
11 |
Constant width
12 |
13 |

Used for program listings, as well as within paragraphs to refer to program elements such as variable or function names, databases, data types, environment variables, statements, and keywords.

14 |
15 |
Constant width bold
16 |
17 |

Shows commands or other text that should be typed literally by the user.

18 |
19 |
Constant width italic
20 |
21 |

Shows text that should be replaced with user-supplied values or by values determined by context.

22 |
23 |
24 |
25 |

This element signifies a tip or suggestion.

26 |
27 |
28 |

This element signifies a general note.

29 |
30 |
31 |

This element indicates a warning or caution.

32 |
33 |
34 |
35 |

Using Code Examples

36 | 37 |

Supplemental material (code examples, exercises, etc.) is available for download at https://github.com/oreillymedia/title_title.

38 |

If you have a technical question or a problem using the code examples, please send email to .

39 |

This book is here to help you get your job done. In general, if example code is offered with this book, you may use it in your programs and documentation. You do not need to contact us for permission unless you’re reproducing a significant portion of the code. For example, writing a program that uses several chunks of code from this book does not require permission. Selling or distributing examples from Make: books does require permission. Answering a question by citing this book and quoting example code does not require permission. Incorporating a significant amount of example code from this book into your product’s documentation does require permission.

40 |

We appreciate, but generally do not require, attribution. An attribution usually includes the title, author, publisher, and ISBN. For example: “Book Title by Some Author (O’Reilly). Copyright 2012 Some Copyright Holder, 978-0-596-xxxx-x.”

41 |

If you feel your use of code examples falls outside fair use or the permission given above, feel free to contact us at .

42 |
43 |
44 |

O'Reilly Online Learning

45 |
46 |

For more than 40 years, O'Reilly Media has provided technology and business training, knowledge, and insight to help companies succeed.

47 |
48 |

Our unique network of experts and innovators share their knowledge and expertise through books, articles, conferences, and our online learning platform. O’Reilly’s online learning platform gives you on-demand access to live training courses, in-depth learning paths, interactive coding environments, and a vast collection of text and video from O'Reilly and 200+ other publishers. For more information, please visit https://oreilly.com.

49 |
50 | 51 |
52 |

How to Contact Us

53 |

Please address comments and questions concerning this book to the publisher:

54 |
    55 |
  • Maker Media, Inc.
    • 56 |
  • 1700 Montgomery Street, Suite 240
    • 57 |
  • San Francisco, CA 94111
    • 58 |
  • 877-306-6253 (in the United States or Canada)
    • 59 |
  • 707-639-1355 (international or local)
    • 60 |
61 |

We have a web page for this book, where we list errata, examples, and any additional information. You can access this page at https://www.oreilly.com/catalog/<catalog page>.

62 | 63 | 64 |

Make: unites, inspires, informs, and entertains a growing community of resourceful people who undertake amazing projects in 65 | their backyards, basements, and garages. Make: celebrates your 66 | right to tweak, hack, and bend any technology to your will. The 67 | Make: audience continues to be a growing culture and community that believes in bettering ourselves, our environment, our 68 | educational system—our entire world. This is much more than 69 | an audience, it’s a worldwide movement that Make is leading we call it the Maker Movement.

70 | 71 |

For more information about Make:, visit us online:

72 | 73 | 79 | 80 | 81 |

To comment or ask technical questions about this book, send email to .

82 | 83 |
84 |
85 |

Acknowledgments

86 | 87 |
88 |
89 | -------------------------------------------------------------------------------- /htmlbook_only/sample_chapter.html: -------------------------------------------------------------------------------- 1 |
2 |

Chapter Title

3 | 4 |

Chapter text begins here. Replace any of this placeholder text with your opus. The following portion outlines heading levels and section structure.

5 | 6 |
7 |

This Is a Top-Level Heading (A-Head) 

8 | 9 |

Section text begins here.

10 | 11 |
12 |

This Is a Second-Level Heading (B-Head)

13 | 14 |

Your text goes here.

15 | 16 |
17 |

This Is a Third-Level Heading (C-Head)

18 | 19 |

Section content goes here.

20 | 21 |
22 |

This Is a Fourth-Level Heading (D-Head)

23 | 24 |

Section content goes here.

25 | 26 |
27 |
This Is a Fifth-Level Heading
28 | 29 |

This is the lowest level of section delineation available, but is not commonly used.

30 | 31 |

Next we've included a few examples of commonly used block elements. You can add these elements using the buttons in the toolbar, as well.

32 | 33 |
34 |

This Is a Note

35 | 36 |

Many people use notes to qualify a statement they made in the preceding paragraphs, or to warn their readers about pitfalls they might run into.

37 |
38 | 39 |
40 |

This is a warning, used to alert readers to something important or encourage caution. Headings are optional for admonitions like notes and warnings.

41 |
42 | 43 |

Here is an informal code listing:

44 | 45 | 
 46 | print('hello world')
 47 |
48 | 49 |

And this is a formal listing, or example:

50 | 51 |
52 |
Hello World in Python
53 | 54 | 
 55 | print "Hello World"
 56 | # Formal listings have titles that will be numbered in output.
 57 |
58 |
59 | 60 |

For either type of listing, you have the option of specifying the code language displayed; see http://docs.atlas.oreilly.com/ch05.html#idp1668976 for more details.

61 | 62 |

You can also specify inline text as code: print "Hello World".

63 | 64 |

Now, let's take a look at a figure with a caption:

65 | 66 |
Drawing of Tarsiers 67 |
Figures like this will be automatically numbered in output.
68 |
69 | 70 |

Here is a blockquote, and specifically it's an epigraph, with an author attribution (epigraphs are a subset of blockquotes):

71 | 72 |
73 |

Alice was beginning to get very tired of sitting by her sister on the bank, and of having nothing to do: once or twice she had peeped into the book her sister was reading, but it had no pictures or conversations in it, 'and what is the use of a book,' thought Alice 'without pictures or conversation?'

74 | 75 |

Lewis Carroll, Alice in Wonderland

76 |
77 | 78 |

There are three types of lists available. Numbered (ordered) lists are often used to describe steps in a process:

79 | 80 |
    81 |
  1. Parse the request.
    2. 82 |
  2. Choose a handler function.
    3. 83 |
  3. Run the handler function.
    4. 84 |
85 | 86 |

Bulleted (unordered) lists are good for describing a set of requirements:

87 | 88 |
    89 |
  • HTML source
    • 90 |
  • CSS stylesheets
    • 91 |
  • JavaScript code
    • 92 |
93 | 94 |

Definition/variable lists serve as glossaries of terminology:

95 | 96 |
97 |
selectSource
98 |
Returns a Source containing all the IDs and values from the database. This allows you to write streaming code.
99 |
selectList
100 |
Returns a list containing all the IDs and values from the database. All records will be loaded into memory.
101 |
selectFirst
102 |
Takes just the first ID and value from the database, if available.
103 |
selectKeys
104 |
Returns only the keys, without the values, as a Source.
105 |
106 | 107 | 112 | 113 |

Finally, here's a sample table:

114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 |
Features supported by Hadoop release series
Feature1.x0.222.x
Secure authenticationYesNoYes
Old configuration namesYesDeprecatedDeprecated
New configuration namesNoYesYes
Old MapReduce APIYesYesYes
New MapReduce APIYes (with some missing libraries)YesYes
158 |
159 |
160 |
161 |
162 |
163 |
-------------------------------------------------------------------------------- /ix.html: -------------------------------------------------------------------------------- 1 | 2 |
3 | -------------------------------------------------------------------------------- /jupyter_book_only/README.md: -------------------------------------------------------------------------------- 1 | # Welcome to Your Jupyter Book Template 2 | 3 | This is an example "book" to give you an idea for how Jupyter book content is structured. 4 | Writing in Jupyter Book is just like writing in Jupyter Notebooks (although you can also add 5 | markdown-only content), with the addition of additional markup features provided by 6 | [MySt][myst]. 7 | 8 | ```{important} 9 | By default, all cells are run when building your book. If you would like to disable this feature 10 | (which is recommended in some cases, e.g., when you're mixing languages in your notebook files), 11 | files, change the `execute_notebooks` element to `off` in the _config.yml file. 12 | ``` 13 | 14 | See the [Jupyter Book documentation][jupyter_book] for more information about 15 | Jupyter Book-specific markup and content. For information about how Jupyter Notebooks/Jupyter 16 | book interacts with atlas, see the [Atlas Documentation][atlas]. 17 | 18 | [jupyter_book]: https://jupyterbook.org 19 | [atlas]: https://docs.atlas.oreilly.com/writing_in_jupyter.html). 20 | [myst]: https://jupyterbook.org/en/stable/reference/cheatsheet.html 21 | 22 | 23 | ```{note} 24 | This file will not appear included in the book in atlas, and can be safely left in the repository 25 | and _toc.yml file. Feel free to rewrite its contents to suit your needs. 26 | ``` 27 | -------------------------------------------------------------------------------- /jupyter_book_only/_config.yml: -------------------------------------------------------------------------------- 1 | # Book settings 2 | # Learn more at https://jupyterbook.org/customize/config.html 3 | 4 | title: Atlas Example Book 5 | author: O'Reilly Media 6 | 7 | # Force re-execution of notebooks on each build. 8 | # See https://jupyterbook.org/content/execute.html 9 | execute: 10 | execute_notebooks: force 11 | 12 | # Information about where the book exists on the web 13 | repository: 14 | url: https://github.com/executablebooks/jupyter-book # Online location of your book 15 | path_to_book: docs # Optional path to your book, relative to the repository root 16 | branch: main # Which branch of the repository should be used when creating links (optional) 17 | 18 | # Add GitHub buttons to your book 19 | # See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository 20 | html: 21 | use_issues_button: true 22 | use_repository_button: true 23 | 24 | parse: 25 | myst_enable_extensions: 26 | # don't forget to list any other extensions you want enabled, 27 | # including those that are enabled by default! 28 | - deflist # Required to use definitions lists 29 | # See https://jupyterbook.org/en/stable/content/content-blocks.html#definition-lists -------------------------------------------------------------------------------- /jupyter_book_only/_toc.yml: -------------------------------------------------------------------------------- 1 | # Table of contents 2 | # Learn more at https://jupyterbook.org/customize/toc.html 3 | 4 | format: jb-book 5 | root: README 6 | parts: 7 | - caption: Part Title # Note that Jupyter Book does not support text on part pages 8 | chapters: 9 | - file: preface # The preface will be moved automatically ahead of the part page in Atlas 10 | - file: ch01 11 | - file: sample_chapter 12 | - file: appx_a 13 | -------------------------------------------------------------------------------- /jupyter_book_only/afterword.ipynb: -------------------------------------------------------------------------------- 1 | { 2 | "cells": [ 3 | { 4 | "attachments": {}, 5 | "cell_type": "markdown", 6 | "metadata": {}, 7 | "source": [ 8 | "# Afterword Title\n", 9 | "\n", 10 | "Afterword text begins here. \n", 11 | "\n", 12 | "" 14 | ] 15 | } 16 | ], 17 | "metadata": { 18 | "kernelspec": { 19 | "display_name": "Python 3", 20 | "language": "python", 21 | "name": "python3" 22 | }, 23 | "language_info": { 24 | "name": "python", 25 | "version": "3.9.6 (default, Jun 13 2022, 11:08:50) \n[Clang 13.0.0 (clang-1300.0.29.30)]" 26 | }, 27 | "orig_nbformat": 4, 28 | "vscode": { 29 | "interpreter": { 30 | "hash": "513788764cd0ec0f97313d5418a13e1ea666d16d72f976a8acadce25a5af2ffc" 31 | } 32 | } 33 | }, 34 | "nbformat": 4, 35 | "nbformat_minor": 2 36 | } 37 | -------------------------------------------------------------------------------- /jupyter_book_only/appx_a.ipynb: -------------------------------------------------------------------------------- 1 | { 2 | "cells": [ 3 | { 4 | "attachments": {}, 5 | "cell_type": "markdown", 6 | "metadata": {}, 7 | "source": [ 8 | "# Appendix Title\n", 9 | "\n", 10 | "An appendix is generally used for extra material that supplements your main book content. \n", 11 | "\n", 12 | "```{important}\n", 13 | "All appendix file names must have the \"appx\" prefix, e.g., _appx_introduction_to_ml.ipynb_. \n", 14 | "```" 15 | ] 16 | } 17 | ], 18 | "metadata": { 19 | "kernelspec": { 20 | "display_name": "Python 3", 21 | "language": "python", 22 | "name": "python3" 23 | }, 24 | "language_info": { 25 | "name": "python", 26 | "version": "3.9.6 (default, Jun 13 2022, 11:08:50) \n[Clang 13.0.0 (clang-1300.0.29.30)]" 27 | }, 28 | "orig_nbformat": 4, 29 | "vscode": { 30 | "interpreter": { 31 | "hash": "513788764cd0ec0f97313d5418a13e1ea666d16d72f976a8acadce25a5af2ffc" 32 | } 33 | } 34 | }, 35 | "nbformat": 4, 36 | "nbformat_minor": 2 37 | } 38 | -------------------------------------------------------------------------------- /jupyter_book_only/bibliography.ipynb: -------------------------------------------------------------------------------- 1 | { 2 | "cells": [ 3 | { 4 | "attachments": {}, 5 | "cell_type": "markdown", 6 | "metadata": {}, 7 | "source": [ 8 | "# Bibliography\n", 9 | "\n", 10 | "Bibliography content starts here.\n", 11 | "\n", 12 | "```{note}\n", 13 | "Jupyter Book supports its own bibliography mechanism(s), which now have limited support in Atlas (namely: they will be provided, but will need to be reformatted to proper Chicago Author-Date styling in production). For more, see [the Jupyter Book documentation](https://jupyterbook.org/en/stable/content/citations.html). \n", 14 | "```" 15 | ] 16 | } 17 | ], 18 | "metadata": { 19 | "kernelspec": { 20 | "display_name": "Python 3", 21 | "language": "python", 22 | "name": "python3" 23 | }, 24 | "language_info": { 25 | "name": "python", 26 | "version": "3.9.6 (default, Jun 13 2022, 11:08:50) \n[Clang 13.0.0 (clang-1300.0.29.30)]" 27 | }, 28 | "orig_nbformat": 4, 29 | "vscode": { 30 | "interpreter": { 31 | "hash": "513788764cd0ec0f97313d5418a13e1ea666d16d72f976a8acadce25a5af2ffc" 32 | } 33 | } 34 | }, 35 | "nbformat": 4, 36 | "nbformat_minor": 2 37 | } 38 | -------------------------------------------------------------------------------- /jupyter_book_only/ch01.ipynb: -------------------------------------------------------------------------------- 1 | { 2 | "cells": [ 3 | { 4 | "attachments": {}, 5 | "cell_type": "markdown", 6 | "metadata": {}, 7 | "source": [ 8 | "(ch01)=\n", 9 | "# Chapter Title\n", 10 | "\n", 11 | "Put some introductory text here.\n", 12 | "\n", 13 | "## Your First Section Heading Here\n", 14 | "\n", 15 | "Put more content here." 16 | ] 17 | } 18 | ], 19 | "metadata": { 20 | "kernelspec": { 21 | "display_name": "Python 3", 22 | "language": "python", 23 | "name": "python3" 24 | }, 25 | "language_info": { 26 | "name": "python", 27 | "version": "3.9.6 (default, Jun 13 2022, 11:08:50) \n[Clang 13.0.0 (clang-1300.0.29.30)]" 28 | }, 29 | "orig_nbformat": 4, 30 | "vscode": { 31 | "interpreter": { 32 | "hash": "513788764cd0ec0f97313d5418a13e1ea666d16d72f976a8acadce25a5af2ffc" 33 | } 34 | } 35 | }, 36 | "nbformat": 4, 37 | "nbformat_minor": 2 38 | } 39 | -------------------------------------------------------------------------------- /jupyter_book_only/foreword.ipynb: -------------------------------------------------------------------------------- 1 | { 2 | "cells": [ 3 | { 4 | "attachments": {}, 5 | "cell_type": "markdown", 6 | "metadata": {}, 7 | "source": [ 8 | "# Foreword\n", 9 | "\n", 10 | "Foreword text begins here.\n" 11 | ] 12 | } 13 | ], 14 | "metadata": { 15 | "language_info": { 16 | "name": "python" 17 | }, 18 | "orig_nbformat": 4 19 | }, 20 | "nbformat": 4, 21 | "nbformat_minor": 2 22 | } 23 | -------------------------------------------------------------------------------- /jupyter_book_only/glossary.ipynb: -------------------------------------------------------------------------------- 1 | { 2 | "cells": [ 3 | { 4 | "attachments": {}, 5 | "cell_type": "markdown", 6 | "metadata": {}, 7 | "source": [ 8 | "(glossary)=\n", 9 | "# Glossary\n", 10 | "\n", 11 | "A glossary contains a collection of terms and brief descriptions or definitions of those terms. The basic Jupyter Book markup is as follows:\n", 12 | "\n", 13 | "```{glossary}\n", 14 | "Gloss Term\n", 15 | " Gloss definition.\n", 16 | "\n", 17 | "Gloss Term 2\n", 18 | " Gloss definition 2.\n", 19 | "```\n", 20 | "\n", 21 | "Alternatively, if you would like to use simple definition lists instead, that is also acceptable:\n", 22 | "\n", 23 | "Gloss Term\n", 24 | ": Gloss definition.\n", 25 | "\n", 26 | "Gloss Term 2\n", 27 | ": Gloss definition 2.\n", 28 | "\n" 29 | ] 30 | } 31 | ], 32 | "metadata": { 33 | "kernelspec": { 34 | "display_name": "Python 3", 35 | "language": "python", 36 | "name": "python3" 37 | }, 38 | "language_info": { 39 | "name": "python", 40 | "version": "3.9.6 (default, Jun 13 2022, 11:08:50) \n[Clang 13.0.0 (clang-1300.0.29.30)]" 41 | }, 42 | "orig_nbformat": 4, 43 | "vscode": { 44 | "interpreter": { 45 | "hash": "513788764cd0ec0f97313d5418a13e1ea666d16d72f976a8acadce25a5af2ffc" 46 | } 47 | } 48 | }, 49 | "nbformat": 4, 50 | "nbformat_minor": 2 51 | } 52 | -------------------------------------------------------------------------------- /jupyter_book_only/preface.ipynb: -------------------------------------------------------------------------------- 1 | { 2 | "cells": [ 3 | { 4 | "attachments": {}, 5 | "cell_type": "markdown", 6 | "metadata": {}, 7 | "source": [ 8 | "# Preface" 9 | ] 10 | }, 11 | { 12 | "attachments": {}, 13 | "cell_type": "markdown", 14 | "metadata": {}, 15 | "source": [ 16 | "## Conventions Used in This Book\n", 17 | "\n", 18 | "The following typographical conventions are used in this book:\n", 19 | "\n", 20 | "_Italic_\n", 21 | ": Indicates new terms, URLs, email addresses, filenames, and file extensions.\n", 22 | "\n", 23 | "`Constant width`\n", 24 | ": Used for program listings, as well as within paragraphs to refer to program elements such as variable or function names, databases, data types, environment variables, statements, and keywords.\n", 25 | "\n", 26 | "**`Constant width bold`**:\n", 27 | ": Shows commands or other text that should be typed literally by the user.\n", 28 | "\n", 29 | "_`Constant width italic`_\n", 30 | ": Shows text that should be replaced with user-supplied values or by values determined by context.\n", 31 | "\n", 32 | "\n", 33 | "```{tip}\n", 34 | "This element signifies a tip or suggestion.\n", 35 | "```\n", 36 | "\n", 37 | "```{note}\n", 38 | "This element signifies a general note.\n", 39 | "```\n", 40 | "\n", 41 | "```{warning}\n", 42 | "This element indicates a warning or caution.\n", 43 | "```\n", 44 | "\n", 45 | "## Using Code Examples\n", 46 | "\n", 47 | "\n", 48 | "\n", 49 | "Supplemental material (code examples, exercises, etc.) is available for download at [https://github.com/oreillymedia/title_title](https://github.com/oreillymedia/title_title).\n", 50 | "\n", 51 | "If you have a technical question or a problem using the code examples, please send email to support@oreilly.com.\n", 52 | "\n", 53 | "This book is here to help you get your job done. In general, if example code is offered with this book, you may use it in your programs and documentation. You do not need to contact us for permission unless you’re reproducing a significant portion of the code. For example, writing a program that uses several chunks of code from this book does not require permission. Selling or distributing examples from O’Reilly books does require permission. Answering a question by citing this book and quoting example code does not require permission. Incorporating a significant amount of example code from this book into your product’s documentation does require permission.\n", 54 | "\n", 55 | "We appreciate, but generally do not require, attribution. An attribution usually includes the title, author, publisher, and ISBN. For example: “_Book Title_ by Some Author (O’Reilly). Copyright 2012 Some Copyright Holder, 978-0-596-xxxx-x.”\n", 56 | "\n", 57 | "If you feel your use of code examples falls outside fair use or the permission given above, feel free to contact us at permissions@oreilly.com.\n", 58 | "\n", 59 | "## O'Reilly Online Learning\n", 60 | "\n", 61 | "
\n", 62 | "

For more than 40 years, O'Reilly Media has provided technology and business training, knowledge, and insight to help companies succeed.

\n", 63 | "
\n", 64 | "\n", 65 | "Our unique network of experts and innovators share their knowledge and expertise through books, articles, and our online learning platform. O’Reilly’s online learning platform gives you on-demand access to live training courses, in-depth learning paths, interactive coding environments, and a vast collection of text and video from O'Reilly and 200+ other publishers. For more information, visit https://oreilly.com.\n", 66 | "\n", 67 | "## How to Contact Us\n", 68 | "\n", 69 | "Please address comments and questions concerning this book to the publisher:\n", 70 | "\n", 71 | "
    \n", 72 | "
  • O’Reilly Media, Inc.
    • \n", 73 | "
  • 1005 Gravenstein Highway North
    • \n", 74 | "
  • Sebastopol, CA 95472
    • \n", 75 | "
  • 800-889-8969 (in the United States or Canada)
    • \n", 76 | "
  • 707-827-7019 (international or local)
    • \n", 77 | "
  • 707-829-0104 (fax)
    • \n", 78 | "
  • support@oreilly.com
    • \n", 79 | "
  • [https://oreilly.com/about/contact.html](https://oreilly.com/about/contact.html)
    • \n", 80 | "
\n", 81 | "\n", 82 | "We have a web page for this book, where we list errata, examples, and any additional information. You can access this page at https://www.oreilly.com/catalog/.\n", 83 | "\n", 84 | "\n", 85 | "\n", 86 | "For news and information about our books and courses, visit [https://oreilly.com](https://oreilly.com).\n", 87 | "\n", 88 | "Find us on LinkedIn: [https://linkedin.com/company/oreilly-media](https://linkedin.com/company/oreilly-media).\n", 89 | "\n", 90 | "Watch us on YouTube: [https://youtube.com/oreillymedia](https://youtube.com/oreillymedia).\n", 91 | "\n", 92 | "## Acknowledgments\n", 93 | "\n", 94 | "" 95 | ] 96 | } 97 | ], 98 | "metadata": { 99 | "kernelspec": { 100 | "display_name": "Python 3", 101 | "language": "python", 102 | "name": "python3" 103 | }, 104 | "language_info": { 105 | "name": "python", 106 | "version": "3.9.6 (default, Jun 13 2022, 11:08:50) \n[Clang 13.0.0 (clang-1300.0.29.30)]" 107 | }, 108 | "orig_nbformat": 4, 109 | "vscode": { 110 | "interpreter": { 111 | "hash": "513788764cd0ec0f97313d5418a13e1ea666d16d72f976a8acadce25a5af2ffc" 112 | } 113 | } 114 | }, 115 | "nbformat": 4, 116 | "nbformat_minor": 2 117 | } 118 | -------------------------------------------------------------------------------- /jupyter_book_only/requirements.txt: -------------------------------------------------------------------------------- 1 | jupyter-book 2 | matplotlib 3 | numpy 4 | -------------------------------------------------------------------------------- /jupyter_book_only/sample_chapter.ipynb: -------------------------------------------------------------------------------- 1 | { 2 | "cells": [ 3 | { 4 | "attachments": {}, 5 | "cell_type": "markdown", 6 | "metadata": {}, 7 | "source": [ 8 | "(unique_chapter_id_01)=\n", 9 | "# Chapter Title\n", 10 | "\n", 11 | "Chapter text begins here. Replace any of this placeholder text with your opus. The following portion outlines heading levels and section structure.\n", 12 | "\n", 13 | "## This Is a Top-Level Heading (A-Head)\n", 14 | "\n", 15 | "Within a chapter, the first and highest heading level uses three equals signs.\n", 16 | "\n", 17 | "### This Is a Second-Level Heading (B-Head)\n", 18 | "\n", 19 | "The second-level heading uses four equals signs. This heading level should only follow a top-level heading (A-head).\n", 20 | "\n", 21 | "#### This Is a Third-Level Heading (C-Head)\n", 22 | "\n", 23 | "The third-level heading uses five equals signs. This heading level should only follow a second-level heading (B-head).\n", 24 | "\n", 25 | "Next we've included a few examples of commonly used block elements.\n", 26 | "\n", 27 | "\n", 28 | "```{admonition} This Is a Note With a Title\n", 29 | ":class: note\n", 30 | "\n", 31 | "Many people use notes to qualify a statement they made in the preceding paragraphs, or to warn their readers about pitfalls they might run into. Mind the special syntax required to include a title.\n", 32 | "```\n", 33 | "\n", 34 | "```{warning}\n", 35 | "This is a warning, used to alert readers to something important or encourage caution. Headings are optional for admonitions like notes and warnings.\n", 36 | "```\n", 37 | "\n", 38 | "Here is an executable code listing:" 39 | ] 40 | }, 41 | { 42 | "cell_type": "code", 43 | "execution_count": 1, 44 | "metadata": {}, 45 | "outputs": [ 46 | { 47 | "name": "stdout", 48 | "output_type": "stream", 49 | "text": [ 50 | "hello world\n" 51 | ] 52 | } 53 | ], 54 | "source": [ 55 | "print('hello world')" 56 | ] 57 | }, 58 | { 59 | "attachments": {}, 60 | "cell_type": "markdown", 61 | "metadata": {}, 62 | "source": [ 63 | "And here follows a formal code example ({ref}`example_uuid`). Note that the cell has an \"example\" tag added to its metadata." 64 | ] 65 | }, 66 | { 67 | "cell_type": "code", 68 | "execution_count": 1, 69 | "metadata": { 70 | "tags": [ 71 | "example" 72 | ] 73 | }, 74 | "outputs": [], 75 | "source": [ 76 | "# example_uuid\n", 77 | "# Put the example title in the second comment\n", 78 | "\n", 79 | "def my_example_func():\n", 80 | " return \"This is an example!\"" 81 | ] 82 | }, 83 | { 84 | "attachments": {}, 85 | "cell_type": "markdown", 86 | "metadata": {}, 87 | "source": [ 88 | "Python and R blocks (that use the `rpy2` syntax) will automatically have syntax higlighting applied.\n", 89 | "\n", 90 | "You can also specify inline text as code: `print \"Hello World\"`.\n", 91 | "\n", 92 | "Now, let's take a look at a figure with a caption ([](tarsier)):\n", 93 | "\n", 94 | "\n", 95 | "```{figure} images/tarsier.png\n", 96 | "---\n", 97 | "name: tarsier\n", 98 | "---\n", 99 | "Drawing of Tarsiers\n", 100 | "```\n", 101 | "\n", 102 | "Here is a blockquote with an author attribution:\n", 103 | "\n", 104 | "```{epigraph}\n", 105 | "Alice was beginning to get very tired of sitting by her sister on the bank, and of having nothing to do: once or twice she had peeped into the book her sister was reading, but it had no pictures or conversations in it, 'and what is the use of a book,' thought Alice 'without pictures or conversation?'\n", 106 | "\n", 107 | "-- Lewis Carol\n", 108 | "```" 109 | ] 110 | }, 111 | { 112 | "attachments": {}, 113 | "cell_type": "markdown", 114 | "metadata": {}, 115 | "source": [ 116 | "\n", 117 | "There are three types of lists available. Numbered (ordered) lists are often used to describe steps in a process:\n", 118 | "\n", 119 | "1. Parse the request.\n", 120 | "2. Choose a handler function.\n", 121 | "3. Run the handler function.\n", 122 | "\n", 123 | "Bulleted (unordered) lists are good for describing a set of requirements:\n", 124 | "\n", 125 | "* HTML source\n", 126 | "* CSS stylesheets\n", 127 | "* JavaScript code\n", 128 | "\n", 129 | "Definition/variable lists serve as glossaries of terminology:\n", 130 | "\n", 131 | "`selectSource`\n", 132 | ": Returns a Source containing all the IDs and values from the database. This allows you to write streaming code.\n", 133 | "\n", 134 | "`selectList`\n", 135 | ": Returns a list containing all the IDs and values from the database. All records will be loaded into memory.\n", 136 | "\n", 137 | "`selectFirst`\n", 138 | ": Takes just the first ID and value from the database, if available.\n", 139 | "\n", 140 | "`selectKeys`\n", 141 | ": Returns only the keys, without the values, as a +Source+." 142 | ] 143 | }, 144 | { 145 | "attachments": {}, 146 | "cell_type": "markdown", 147 | "metadata": {}, 148 | "source": [ 149 | "\n", 150 | "```{sidebar} Sidebar Title\n", 151 | "Here's a sidebar. Sidebars are great for setting aside a section of text that is related to the surrounding content but that doesn't necessarily fit into the main flow.\n", 152 | "```" 153 | ] 154 | }, 155 | { 156 | "attachments": {}, 157 | "cell_type": "markdown", 158 | "metadata": {}, 159 | "source": [ 160 | "\n", 161 | "Finally, here's a sample table:\n", 162 | "\n", 163 | "```{list-table} Features supported by Hadoop release series\n", 164 | ":header-rows: 1\n", 165 | ":name: sample_table\n", 166 | "\n", 167 | "* - Feature\n", 168 | " - 1.x\n", 169 | " - 0.22\n", 170 | " - 2.x\n", 171 | "* - Secure authentication\n", 172 | " - Yes\n", 173 | " - No\n", 174 | " - Yes\n", 175 | "* - Old configuration names\n", 176 | " - Yes\n", 177 | " - Deprecated\n", 178 | " - Deprecated\n", 179 | "* - New configuration names\n", 180 | " - No\n", 181 | " - Yes\n", 182 | " - Yes\n", 183 | "* - Old MapReduce API\n", 184 | " - Yes\n", 185 | " - Yes\n", 186 | " - Yes\n", 187 | "* - New MapReduce API\n", 188 | " - Yes (with some missing libraries)\n", 189 | " - Yes\n", 190 | " - Yes\n", 191 | "```\n", 192 | "\n", 193 | "To insert a cross-reference, first add a block ID for the element to which you're referring. The block ID is a unique identifier. Each block has a specific syntax. For example, a heading ID would be added in parenthesis followed by an equals sign:\n", 194 | "\n", 195 | "```\n", 196 | "(unique_id_01)=\n", 197 | "## A Section Title\n", 198 | "```\n", 199 | "\n", 200 | "(See the [Jupyter Book documentation](https://jupyterbook.org/en/stable/intro.html) for more types of ID anchoring.)\n", 201 | "\n", 202 | "Here's a cross-reference to {ref}`ch01`. Here's one to {ref}`unique_id_02`. Finally, here's one to {ref}`unique_chapter_id_01`.\n", 203 | "\n", 204 | "For the book to be valid, IDs must be unique across the entire book, have no spaces, and not start with a number.\n", 205 | "\n", 206 | "```{tip}\n", 207 | "While it's still best practice to ensure your IDs are unique, the script Atlas uses in the backend will force/ensure your IDs are unique across the book.\n", 208 | "```\n", 209 | "\n", 210 | "O'Reilly house style calls for every formal figure, formal table, and formal code example to be preceded by a specific in-text reference. Formal figures and formal tables are created when you add captions to these elements.\n", 211 | "\n", 212 | "To include hyperlinks to external sources, add the anchor text enclosed in single square brackets followed by the full URL in parentheses. This, for example, is a link to the [O'Reilly home page](https://www.oreilly.com). You may also use [alternate link syntaxes][link_syntaxes] if you prefer. The bracketed text will become a clickable link in web versions. In print versions, it will appear in the text, followed by the actual URL in parentheses.\n", 213 | "\n", 214 | "[link_syntaxes]: https://jupyterbook.org/en/stable/reference/cheatsheet.html#links" 215 | ] 216 | } 217 | ], 218 | "metadata": { 219 | "kernelspec": { 220 | "display_name": "Python 3", 221 | "language": "python", 222 | "name": "python3" 223 | }, 224 | "language_info": { 225 | "codemirror_mode": { 226 | "name": "ipython", 227 | "version": 3 228 | }, 229 | "file_extension": ".py", 230 | "mimetype": "text/x-python", 231 | "name": "python", 232 | "nbconvert_exporter": "python", 233 | "pygments_lexer": "ipython3", 234 | "version": "3.9.6" 235 | }, 236 | "orig_nbformat": 4, 237 | "vscode": { 238 | "interpreter": { 239 | "hash": "513788764cd0ec0f97313d5418a13e1ea666d16d72f976a8acadce25a5af2ffc" 240 | } 241 | } 242 | }, 243 | "nbformat": 4, 244 | "nbformat_minor": 2 245 | } 246 | -------------------------------------------------------------------------------- /layout.html: -------------------------------------------------------------------------------- 1 | {{ doctype }} 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | {{ title }} 11 | 12 | 13 | {{ content }} 14 | 15 | 16 | -------------------------------------------------------------------------------- /pdf.css: -------------------------------------------------------------------------------- 1 | @charset "UTF-8"; 2 | 3 | /*--------Put Your Custom CSS Rules Below--------*/ 4 | /*--- This oneoff overrides the code in https://github.com/oreillymedia//blob/master/pdf/pdf.css---*/ 5 | 6 | /*---Less space for section pagebreaks (AsciiDoc)---*/ 7 | section.less_space > h3:first-child, 8 | section.less_space > h2:first-child, 9 | section.less_space > h1:first-child 10 | { margin-top: 0 !important; } 11 | 12 | /*---Less space for pagebreaks (HTML & AsciiDoc)---*/ 13 | .less_space {margin-top: 0 !important;} 14 | 15 | /*----Uncomment to temporarily turn on code-eyballer highlighting (make sure to recomment after you build) 16 | 17 | pre { 18 | background-color: yellow; 19 | } 20 | ---*/ 21 | 22 | /*----Uncomment to turn on automatic code wrapping 23 | 24 | pre { 25 | white-space: pre-wrap; 26 | word-wrap: break-word; 27 | } 28 | ----*/ 29 | 30 | /*----Uncomment to change the TOC start page (set 31 | the number to one page _after_ the one you want; 32 | so 6 to start on v, 8 to start on vii, etc.) 33 | 34 | @page toc:first { 35 | counter-reset: page 6; 36 | } 37 | ----*/ 38 | 39 | /*----Uncomment to fix a bad break in the title 40 | (increase padding value to push down, decrease 41 | value to pull up) 42 | 43 | section[data-type="titlepage"] h1 { 44 | padding-left: 1.5in; 45 | } 46 | ----*/ 47 | 48 | /*----Uncomment to fix a bad break in the subtitle 49 | (increase padding value to push down, decrease 50 | value to pull up) 51 | 52 | section[data-type="titlepage"] h2 { 53 | padding-left: 1in; 54 | } 55 | ----*/ 56 | 57 | /*----Uncomment to fix a bad break in the author names 58 | (increase padding value to push down, decrease 59 | value to pull up) 60 | 61 | section[data-type="titlepage"] p.author { 62 | padding-left: 3in; 63 | } 64 | ----*/ 65 | 66 | /* ----Uncomment to suppress duplicate page numbers in index entries 67 | WARNING: MAY CAUSE PDF BUILDS TO SEGFAULT 68 | 69 | div[data-type="index"] { 70 | -ah-suppress-duplicate-page-number: true; 71 | } 72 | 73 | ----*/ 74 | -------------------------------------------------------------------------------- /tarsier.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/oreillymedia/orm_book_samples/66898f831dc795cabc85781b6b028701b6a94ad1/tarsier.png -------------------------------------------------------------------------------- /titlepage.html: -------------------------------------------------------------------------------- 1 |
2 |

Book Title Here

3 |

??? Edition

4 |

Subtitle Goes Here

5 |

Some Author

6 |
7 | 8 | 10 | -------------------------------------------------------------------------------- /toc.html: -------------------------------------------------------------------------------- 1 | 2 |