DOCSLIB.ORG

LDP Author Guide

Total Page：16

File Type：pdf, Size：1020Kb

Download full-text PDF Read full-text
LDP Author Guide LDP Author Guide Jorge Godoy Conectiva S.A. Publishing Department <[email protected]> Emma Jane Hogbin <[email protected]> Mark F. Komarinski <[email protected]> David C. Merrill david −AT− lupercalia.net 2005−03−04 Revision History Revision Revised by: 2006−04−202005−03−042005−01−232004−07−142004−04−192004−04−042004−04−022004−01−27 4.84.74.64.54.44.34.24.1 MGejhejhejhejhejhejhejh Added notes about prefered submission formats, corrected links, packaged templates.Typo fixed in sample DocBook markup. Added new web−based authoring tool and information on LaTeX to DocBook conversions.Typos fixed in xmlto notes and book template. Copied information about DocBook−capable word processing tools into the "Converting Documents to DocBook XML" Appendix; added new XML editors; and information about tools to convert other formats to DocBook XML.Updated information regarding CVS accounts and connecting to the CVS server.Added editor credit requirements to the Using DocBook section. Updated the submission procedure. New documents can now only be added by one of the Review Coordinators after the successful completion of each of the required reviews.Removed the section Contributing to The LDP (replaced by Summary of The LDP Process).Added references for LyX to DocBook conversions in the bibliography.Updated the license requirements and added them to the table of contents (moved them out of the sub−section). This guide describes the process of submitting and publishing a document with The Linux Documentation Project (TLDP). It includes information about the tools, toolchains and formats used by TLDP. The document's primary audience is new TLDP authors, but it also contains information for seasoned documentation authors. LDP Author Guide Table of Contents Chapter 1. About this Guide..............................................................................................................................1 1.1. About this Guide...............................................................................................................................1 1.2. About The LDP.................................................................................................................................1 1.3. Feedback...........................................................................................................................................2 1.4. Copyrights and Trademarks..............................................................................................................2 1.5. Acknowledgments and Thanks.........................................................................................................2 1.5.1. Version 1 − Version 3.............................................................................................................2 1.5.2. Version 4.................................................................................................................................2 1.6. Document Conventions.....................................................................................................................2 Chapter 2. Authoring TLDP Documents: An Introduction............................................................................4 2.1. Summary of The LDP Process..........................................................................................................4 2.2. Mailing Lists.....................................................................................................................................5 Chapter 3. Writing Your Proposal....................................................................................................................6 3.1. Choosing a Subject...........................................................................................................................6 3.2. Scope of Your Document..................................................................................................................6 3.2.1. Documentation Templates.......................................................................................................7 3.3. Unmaintained and Out−of−date Documents....................................................................................7 3.4. Developing an Outline......................................................................................................................8 3.5. Research............................................................................................................................................9 Chapter 4. Write...............................................................................................................................................10 4.1. Writing the Text..............................................................................................................................10 4.1.1. Writing Style and Style Guides.............................................................................................10 4.1.2. On−line Writing Resources...................................................................................................11 4.2. Edit and Proofread the Text............................................................................................................11 4.3. Tools for Writing, Editing and Maintaining your Document.........................................................12 4.3.1. Editing Tools.........................................................................................................................12 4.3.2. Concurrent Versions System (CVS)......................................................................................12 4.3.3. Spell Check............................................................................................................................13 Chapter 5. Markup...........................................................................................................................................14 5.1. Markup: A General Overview........................................................................................................14 5.2. DocBook: What it is and why we use it..........................................................................................14 5.3. XML and SGML: Why we use XML.............................................................................................15 5.4. Markup Languages Accepted by TLDP.........................................................................................16 Chapter 6. Distributing Your Documentation...............................................................................................17 6.1. Before Distributing Your Documentation......................................................................................17 6.2. Licensing and Copyright.................................................................................................................17 6.2.1. Copyright...............................................................................................................................18 6.2.2. Disclaimer.............................................................................................................................18 6.2.3. Licensing source code...........................................................................................................18 6.3. Acknowledgments...........................................................................................................................18 6.4. TLDP Review Process....................................................................................................................19 6.5. Submission to LDP for publication................................................................................................20 i LDP Author Guide Table of Contents Chapter 7. Maintenance...................................................................................................................................21 7.1. Maintaining Your Document..........................................................................................................21 7.2. Fixing Errors...................................................................................................................................21 7.2.1. Fixing Your Own Documents...............................................................................................21 7.2.2. Fixing Other Documents in the Collection............................................................................21 References..........................................................................................................................................................23 Markup and general information...........................................................................................................23 DocBook References.......................................................................................................................23 LinuxDoc.........................................................................................................................................24 Converting Other Formats to DocBook..........................................................................................24 LDP templates, tools & links..........................................................................................................24 DocBook Transformations..............................................................................................................25 General Writing Links and Style Guides........................................................................................25
Load more

Recommended publications
  • Build It with Nitrogen the Fast-Off-The-Block Erlang Web Framework
    Build it with Nitrogen The fast-off-the-block Erlang web framework Lloyd R. Prentice & Jesse Gumm dedicated to: Laurie, love of my life— Lloyd Jackie, my best half — Jesse and to: Rusty Klophaus and other giants of Open Source— LRP & JG Contents I. Frying Pan to Fire5 1. You want me to build what?7 2. Enter the lion’s den9 2.1. The big picture........................ 10 2.2. Install Nitrogen........................ 11 2.3. Lay of the land........................ 13 II. Projects 19 3. nitroBoard I 21 3.1. Plan of attack......................... 21 3.2. Create a new project..................... 23 3.3. Prototype welcome page................... 27 3.4. Anatomy of a page...................... 30 3.5. Anatomy of a route...................... 33 3.6. Anatomy of a template.................... 34 3.7. Elements............................ 35 3.8. Actions............................. 38 3.9. Triggers and Targets..................... 39 3.10. Enough theory........................ 40 i 3.11. Visitors............................ 44 3.12. Styling............................. 64 3.13. Debugging........................... 66 3.14. What you’ve learned..................... 66 3.15. Think and do......................... 68 4. nitroBoard II 69 4.1. Plan of attack......................... 69 4.2. Associates........................... 70 4.3. I am in/I am out....................... 78 4.4. Styling............................. 81 4.5. What you’ve learned..................... 82 4.6. Think and do......................... 82 5. A Simple Login System 83 5.1. Getting Started........................ 83 5.2. Dependencies......................... 84 5.2.1. Rebar Dependency: erlpass ............. 84 5.3. The index page........................ 85 5.4. Creating an account..................... 87 5.4.1. db_login module................... 89 5.5. The login form........................ 91 5.5.1.
    [Show full text]
  • LYX Frequently Asked Questions with Answers
    LYX Frequently Asked Questions with Answers by the LYX Team∗ January 20, 2008 Abstract This is the list of Frequently Asked Questions for LYX, the Open Source document processor that provides a What-You-See-Is-What-You-Mean environment for producing high quality documents. For further help, you may wish to contact the LYX User Group mailing list at [email protected] after you have read through the docs. Contents 1 Introduction and General Information 3 1.1 What is LYX? ......................... 3 1.2 That's ne, but is it useful? . 3 1.3 Where do I start? . 4 1.4 Does LYX run on my computer? . 5 1.5 How much hard disk space does LYX need? . 5 1.6 Is LYX really Open Source? . 5 2 Internet Resources 5 2.1 Where should I look on the World Wide Web for LYX stu? 5 2.2 Where can I get LYX material by FTP? . 6 2.3 What mailing lists are there? . 6 2.4 Are the mailing lists archived anywhere? . 6 2.5 Okay, wise guy! Where are they archived? . 6 3 Compatibility with other word/document processors 6 3.1 Can I read/write LATEX les? . 6 3.2 Can I read/write Word les? . 7 3.3 Can I read/write HTML les? . 7 4 Obtaining and Compiling LYX 7 4.1 What do I need? . 7 4.2 How do I compile it? . 8 4.3 I hate compiling. Where are precompiled binaries? . 8 ∗If you have comments or error corrections, please send them to the LYX Documentation mailing list, <[email protected]>.
    [Show full text]
  • Debugging with DDD
    Debugging with DDD User’s Guide and Reference Manual First Edition, for DDD Version 3.2 Last updated 2000-01-03 Andreas Zeller Debugging with DDD User’s Guide and Reference Manual Copyright c 2000 Universität Passau Lehrstuhl für Software-Systeme Innstraße 33 D-94032 Passau GERMANY Distributed by Free Software Foundation, Inc. 59 Temple Place – Suite 330 Boston, MA 02111-1307 USA ddd and this manual are available via the ddd www page. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies. Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided also that the sections entitled “Copying” and “GNU General Public License” (see Appendix G [License], page 181) are included exactly as in the original, and provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one. Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that this permission notice may be stated in a translation approved by the Free Software Foundation. Send questions, comments, suggestions, etc. to [email protected]. Send bug reports to [email protected]. i Short Contents Summary of DDD .............................................. 1 1 A Sample DDD Session ...................................... 5 2 Getting In and Out of DDD ................................... 15 3 The DDD Windows ........................................ 39 4 Navigating through the Code .................................. 71 5 Stopping the Program ....................................... 79 6 Running the Program ....................................... 89 7 Examining Data .........................................
    [Show full text]
  • C-C++ Beautifier HOW-TO
    C-C++ Beautifier HOW-TO Al Dev (Alavoor Vasudevan) < alavoor[AT]yahoo.com > v16.7, 2 Nov 2003 Abstract This document will help you to format (beautify) the C/C++ programs so that it is more readable and confirms to your site C/C++ coding standards. The information in this document applies to all the operating sytems that is - Lin- ux, MS DOS, Apple Macintosh, Windows 95/NT/2000, BeOS, OS/2, IBM OSes, all flavors of Unix like Solaris, HPUX, AIX, SCO, Sinix, BSD, UnixWare, etc.. and to all other operating systems which support "C" compiler (it means almost all the operating systems on this planet!). Table of Contents Introduction ...................................................................................................................... 1 Installing BCPP ................................................................................................................. 2 How can I trust Beautifier programs??!! ................................................................................ 3 Method 1: Verfication Program for C++/C ..................................................................... 3 Method 2: Verfication Program for C++/C ..................................................................... 3 Method 3: Verfication Program for Java/C++/Others ........................................................ 4 Method 4: Shell script: Verfication Program for C++/C .................................................... 5 HTML Beautifier ..............................................................................................................
    [Show full text]
  • A Work-Pattern Centric Approach to Building a Personal Knowledge Advantage Machine
    Graduate Theses, Dissertations, and Problem Reports 2012 A Work-Pattern Centric Approach to Building a Personal Knowledge Advantage Machine Daniel Sloan West Virginia University Follow this and additional works at: https://researchrepository.wvu.edu/etd Recommended Citation Sloan, Daniel, "A Work-Pattern Centric Approach to Building a Personal Knowledge Advantage Machine" (2012). Graduate Theses, Dissertations, and Problem Reports. 4919. https://researchrepository.wvu.edu/etd/4919 This Thesis is protected by copyright and/or related rights. It has been brought to you by the The Research Repository @ WVU with permission from the rights-holder(s). You are free to use this Thesis in any way that is permitted by the copyright and related rights legislation that applies to your use. For other uses you must obtain permission from the rights-holder(s) directly, unless additional rights are indicated by a Creative Commons license in the record and/ or on the work itself. This Thesis has been accepted for inclusion in WVU Graduate Theses, Dissertations, and Problem Reports collection by an authorized administrator of The Research Repository @ WVU. For more information, please contact [email protected]. A Work-Pattern Centric Approach to Building a Personal Knowledge Advantage Machine Daniel Sloan Thesis submitted to the College of Engineering and Mineral Resources at West Virginia University in partial fulfillment of the requirements for the degree of Master of Science in Computer Science Yenumula V. Reddy, Ph.D., Chair Bojan Cukic, Ph.D. Cynthia D. Tanner, MS. Lane Department of Computer Science and Electrical Engineering Morgantown, West Virginia 2012 Keywords: Work-patterns, file usage, semantic desktop, machine learning Copyright c 2012 Daniel Sloan Abstract A Work-Pattern Centric Approach to Building a Personal Knowledge Advantage Machine Daniel Sloan A work pattern, also known as a usage pattern, can be broadly defined as the methods by which a user typically utilizes a particular system.
    [Show full text]
  • Metadefender Core V4.12.2
    MetaDefender Core v4.12.2 © 2018 OPSWAT, Inc. All rights reserved. OPSWAT®, MetadefenderTM and the OPSWAT logo are trademarks of OPSWAT, Inc. All other trademarks, trade names, service marks, service names, and images mentioned and/or used herein belong to their respective owners. Table of Contents About This Guide 13 Key Features of Metadefender Core 14 1. Quick Start with Metadefender Core 15 1.1. Installation 15 Operating system invariant initial steps 15 Basic setup 16 1.1.1. Configuration wizard 16 1.2. License Activation 21 1.3. Scan Files with Metadefender Core 21 2. Installing or Upgrading Metadefender Core 22 2.1. Recommended System Requirements 22 System Requirements For Server 22 Browser Requirements for the Metadefender Core Management Console 24 2.2. Installing Metadefender 25 Installation 25 Installation notes 25 2.2.1. Installing Metadefender Core using command line 26 2.2.2. Installing Metadefender Core using the Install Wizard 27 2.3. Upgrading MetaDefender Core 27 Upgrading from MetaDefender Core 3.x 27 Upgrading from MetaDefender Core 4.x 28 2.4. Metadefender Core Licensing 28 2.4.1. Activating Metadefender Licenses 28 2.4.2. Checking Your Metadefender Core License 35 2.5. Performance and Load Estimation 36 What to know before reading the results: Some factors that affect performance 36 How test results are calculated 37 Test Reports 37 Performance Report - Multi-Scanning On Linux 37 Performance Report - Multi-Scanning On Windows 41 2.6. Special installation options 46 Use RAMDISK for the tempdirectory 46 3. Configuring Metadefender Core 50 3.1. Management Console 50 3.2.
    [Show full text]
  • The Focus - Issue 36
    Contents The Focus - Issue 36 A Publication for ANSYS Users Contents Feature Articles ● Linux & ANSYS: Lessons Learned ● Backup Tool ● Design Modeler FAQ On the Web ● APDL Customization course notes now available for purchase ● ANSYS and MathCAD ● ANSYS Acquires Century Dynamics Resources ● PADT Support: How can we help? ● Upcoming Training at PADT ● About The Focus ❍ The Focus Library ❍ Contributor Information ❍ Subscribe / Unsubscribe ❍ Legal Disclaimer http://www.padtinc.com/epubs/focus/common/contents.asp [3/28/2005 9:06:12 AM] Linux & ANSYS: Lessons Learned The Focus - Issue 36 A Publication for ANSYS Users Linux & ANSYS: Lessons Learned by Eric Miller, PADT Every couple of years, the computing picture for analysts gets turned upside down. For a long time now the industry has been moving from Unix workstations to Windows/Intel desktop machines. The wintel price/performance has been fantastic, the IT guys are happier, and all of that productivity software that you spend so much time with runs in the same spot. We have been happy with a stable and known environment. However, accepting the fact that unless you work for a big company that can buy some Unix servers, you just don’t have an easy way to get some extra horsepower other then getting a new box. Then along comes this Finnish guy that may or may not have been named after Lucy’s little brother. With not much of a life and a very large brain, he popped out the majority of a complete and free version of Unix that anyone can use, breaking the stranglehold of (expensive) proprietary Unix OS’s that ran on (expensive) proprietary hardware.
    [Show full text]
  • Howtos with Linuxdoc
    HOWTOs with LinuxDoc David S. Lawyer v0.09, November 2007 Questo testo tratta di come scrivere gli HOWTO usando il semplice linguaggio a marcatori (markup) LinuxDoc. È rivolto principalmente agli autori del Linux Documentation Project (e ad autori futuri alle prime armi che vogliono iniziare rapidamente). Se si vuole usare DocBook, il linguaggio a marcatori più completo e dicile, (incluso XML), vedere la LDP Authoring Guide (Guida per gli autori di LDP). Traduzione ed adattamenti in italiano a cura di Beatrice Torracca, beatricet (at) libero (dot) it, e Hugh Hartmann, hhartmann (at) libero (dot) it, revisione a cura di Vieri Giugni, v.giugni (at) gmail (dot) com). Per versioni aggiornate di questo documento, e per trovare altra documentazione in italiano sul software libero, visitare il sito dell' ILDP <http://it.ildp.org> Indice 1 Introduzione 2 1.1 Per partire immediatamente.....................................2 1.2 Copyright e licenza..........................................3 1.3 Perché si dovrebbe scrivere un HOWTO?.............................3 1.4 Perché ho scritto questo documento................................3 2 Informazioni sulla scrittura di un HOWTO3 2.1 Copyright...............................................3 2.2 Scegliere un argomento........................................3 3 Il formato degli HOWTO4 3.1 Introduzione..............................................4 4 LinuxDoc e DocBook a confronto4 5 Imparare LinuxDoc 6 5.1 Introduzione..............................................6 5.2 Esempio 1 (nome le: esempio1.sgml)...............................6 5.3 Esempio 2 (nome le: esempio2.sgml)...............................7 5.4 Esempio 3 (nome le: esempio3.sgml)...............................9 5.5 Guida di consultazione rapida di LinuxDoc............................ 11 5.5.1 Intestazione.......................................... 11 5.5.2 Impaginazione del corpo................................... 12 5.5.3 Tipi di carattere....................................... 12 1.
    [Show full text]
  • Open-Source Documentation
    Open-Source Documentation: In Search of User-Driven, Just-in-Time Writing Erik Berglund Michael Priestley Linköping University IBM Toronto Lab S-581 83, Linköping, Canada Sweden [email protected] + 46 13 28 24 93 [email protected] ABSTRACT Keywords Iterative development models allow developers to respond quickly Open source documentation, just-in-time, user-driven. to changing user requirements, but place increasing demands on writers who must handle increasing amounts of change with ever- 1. THE PROBLEM decreasing resources. In the software development world, one Over the years, the software industry has accepted that changing solution to this problem is open-source development: allowing the requirements are simply part of the software development process. users to set requirements and priorities by actually contributing to An allowance for client requirements change, even an expectation the development of the software. This results in just-in-time of change, is at the foundation of most software development software improvements that are explicitly user-driven, since they methodologies. The Rational Unified Process (RUP) illustrates are actually developed by users. this, and Extreme Programming (XP) exemplifies it. Taken to the In this article we will discuss how the open source model can be extreme, as it often is in open-source development, the extended to the development of documentation. In many open- functionality of the product may not be determined until the day it source projects, the role of writer has remained unchanged: is completed. documentation development remains a specialized activity, owned Continuous requirements change makes traditional methods of by a single writer or group of writers, who work as best they can software documentation difficult.
    [Show full text]
  • An Introduction to PWF Linux
    An Introduction to PWF Linux Dr MJ Rutter [email protected] Michaelmas 2001 Typeset by FoilTEX °c 2001 MJ Rutter UNIX Development of UNIX started in 1969 in AT&T Bell Labs. Version 1, written in assembler, appeared in 1971. A couple of years later it was rewritten in the new C language, also developed by Bell Labs. In 1975 UNIX was made available outside Bell Labs. By the early 1990s it was the operating system for largish computers. Cray, DEC, HP, IBM, SGI and Sun all sold versions with their computers. None of its competitors achieved this level of cross-platform support. Competitors included MVS (IBM only), VMS (DEC only) and WinNT (effectively Intel only). 1 Linux Linux famously started being developed by a Finnish graduate student, Linus Torvalds, in 1991. It was intended to be a UNIX variant running on Intel i386- based PCs. From an early stage Linus made the source freely available and encouraged others to contribute. In 1994 version 1 was released, followed by 1.2 a year later, and 2.0 the following year. By this time support had grown to include Macintoshes and Alphas as well as PCs. The current version is 2.4, released in 2001, and development continues. 2 The Computer Resources The computers in the Physics PWF and in the CS-run PWFs in the centre of Cambridge all run a version of Linux which contains all the software needed for this course. These computers use the same Novell server for your home directories that they do when running Windows.
    [Show full text]
  • Introduction to Free Software-SELF
    Introduction to Free Software Jordi Mas Hernández (coordinador) David Megías Jiménez (coordinador) Jesús M. González Barahona Joaquín Seoane Pascual Gregorio Robles XP07/M2101/02708 © FUOC • XP07/M2101/02708 Introduction to Free Software Jordi Mas Hernández David Megías Jiménez Jesús M. González Barahona Founding member of Softcatalà and Computer Science Engineer by the Professor in the Department of Tele- of the telematic network RedBBS. Universitat Autònoma de Barcelona matic Systems and Computation of He has worked as a consultant in (UAB, Spain). Master in Advanced the Rey Juan Carlos University (Ma- companies like Menta, Telépolis, Vo- Process Automatisation Techniques drid, Spain), where he coordinates dafone, Lotus, eresMas, Amena and by the UAB. PhD. in Computer Sci- the research group LibreSoft. His Terra España. ence by the UAB. Associate Profes- professional areas of interest include sor in the Computer Science, Multi- the study of free software develop- media and Telecommunication De- ment and the transfer of knowledge partment of the Universitat Oberta in this field to the industrial sector. de Catalunya (UOC, Spain) and Di- rector of the Master Programme in Free Software at the UOC. Joaquín Seoane Pascual Gregorio Robles PhD. Enigeer of Telecommunicati- Assistant professor in the Rey Juan ons in the Politechnical University Carlos University (Madrid, Spain), of Madrid (Spain). He has worked where he acquired his PhD. de- in the private sector and has al- gree in February 2006. Besides his so taught in the Computer Scien- teaching tasks, he researches free ce Faculty of that same university. software development from the Nowadays he is professor in the De- point of view of software enginee- partment of Telematic Systems En- ring, with special focus in quantitati- gineering, and has taught courses ve issues.
    [Show full text]
  • Java Decompiler HOW-TO
    Java Decompiler HOW−TO Java Decompiler HOW−TO Table of Contents Java Decompiler HOW−TO..............................................................................................................................1 Al Dev (Alavoor Vasudevan) alavoor@yahoo.com...............................................................................1 1. Introduction..........................................................................................................................................1 2. How can I trust Java Decompiler ??!!..................................................................................................1 3. Related URLs.......................................................................................................................................1 4. Other Formats of this Document..........................................................................................................1 5. Copyright.............................................................................................................................................1 1. Introduction..........................................................................................................................................1 2. How can I trust Java Decompiler ??!!..................................................................................................2 3. Related URLs.......................................................................................................................................3 4. Other Formats of this Document..........................................................................................................3
    [Show full text]