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]
  • 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]
  • List of Word Processors (Page 1 of 2) Bob Hawes Copied This List From
    List of Word Processors (Page 1 of 2) Bob Hawes copied this list from http://en.wikipedia.org/wiki/List_of_word_processors. He added six additional programs, and relocated the Freeware section so that it directly follows the FOSS section. This way, most of the software on page 1 is free, and most of the software on page 2 is not. Bob then used page 1 as the basis for his April 15, 2011 presentation Free Word Processors. (Note that most of these links go to Wikipedia web pages, but those marked with [WEB] go to non-Wikipedia websites). Free/open source software (FOSS): • AbiWord • Bean • Caligra Words • Document.Editor [WEB] • EZ Word • Feng Office Community Edition • GNU TeXmacs • Groff • JWPce (A Japanese word processor designed for English speakers reading or writing Japanese). • Kword • LibreOffice Writer (A fork of OpenOffice.org) • LyX • NeoOffice [WEB] • Notepad++ (NOT from Microsoft) [WEB] • OpenOffice.org Writer • Ted • TextEdit (Bundled with Mac OS X) • vi and Vim (text editor) Proprietary Software (Freeware): • Atlantis Nova • Baraha (Free Indian Language Software) • IBM Lotus Symphony • Jarte • Kingsoft Office Personal Edition • Madhyam • Qjot • TED Notepad • Softmaker/Textmaker [WEB] • PolyEdit Lite [WEB] • Rough Draft [WEB] Proprietary Software (Commercial): • Apple iWork (Mac) • Apple Pages (Mac) • Applix Word (Linux) • Atlantis Word Processor (Windows) • Altsoft Xml2PDF (Windows) List of Word Processors (Page 2 of 2) • Final Draft (Screenplay/Teleplay word processor) • FrameMaker • Gobe Productive Word Processor • Han/Gul
    [Show full text]
  • Conservative Conversion Between and Texmacs
    Conservative conversion between A L TEX and TEXMACS by Joris van der Hoevena, François Poulainb LIX, CNRS École polytechnique 91128 Palaiseau Cedex France a. Email: [email protected] b. Email: [email protected] April 15, 2014 Abstract Back and forth converters between two document formats are said to be conservative if the following holds: given a source document D, its conversion D0, a locally modied version M 0 of D0 and the back con- version M of M 0, the document M is a locally modied version of D. We will describe mechanisms for the implementation of such converters, A with the L TEX and TEXMACS formats as our guiding example. Keywords: Conservative document conversion, LATEX conversion, TEXMACS, mathematical editing A.M.S. subject classication: 68U15, 68U35, 68N99 1 Introduction The TEXMACS project [7, 10] aims at creating a free scientic oce suite with an integrated structured mathematical text editor [8], tools for graphical drawings and presentations, a spreadsheed, interfaces to various computer algebra sys- tems, and so on. Although TEXMACS aims at a typesetting quality which is at least as good as TEX and LATEX [14, 15], the system is not based on these latter systems. In particular, a new incremental typesetting engine was implemented from scratch, which allows documents to be edited in a wysiwyg and thereby more user friendly manner. This design choice made it also possible or at least easier to use TEXMACS as an interface for external systems, or as an editor for technical drawings. However, unlike existing graphical front-ends for LATEX such as LyX [2] or Scientific Workplace [23], native compatibility with LATEX is not ensured.
    [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]
  • The Data Display Debugger Ddd [−−Gdb] [−−Dbx] [−−Xdb] [−−Jdb]
    () () NAME ddd, xddd - the data display debugger SYNOPSIS ddd [ −−gdb ][−−dbx ][−−xdb ][−−jdb ][−−pydb ][−−perl ][−−debugger name ][−−[r]host [username@]hostname ]] [−−help ][−−trace ][−−version ][−−configuration ][options... ] [ program [ core | process-id ]] but usually just ddd program DESCRIPTION The purpose of a debugger such as DDD is to allow you to see what is going on “inside” another program while it executes—or what another program was doing at the moment it crashed. DDD can do four main kinds of things (plus other things in support of these) to help you catch bugs in the act: • Start your program, specifying anything that might affect its behavior. • Make your program stop on specified conditions. • Examine what has happened, when your program has stopped. • Change things in your program, so you can experiment with correcting the effects of one bug and go on to learn about another. “Classical” UNIX debuggers such as the GNU debugger (GDB) provide a command-line interface and a multitude of commands for these and other debugging purposes. DDD is a comfortable graphical user interface around an inferior GDB, DBX, XDB, JDB, Python debugger, or Perl debugger. INVOKING DDD You can run DDD with no arguments or options. However, the most usual way to start DDD is with one argument or two, specifying an executable program as the argument: ddd program You can also start with both an executable program and a core file specified: ddd program core You can, instead, specify a process ID as a second argument, if you want to debug a running process: ddd program 1234 would attach DDD to process 1234 (unless you also have a file named ‘ 1234 ’; DDD does check for a core file first).
    [Show full text]
  • SAS on Unix/Linux- from the Terminal to GUI
    SAS on Unix/Linux- from the terminal to GUI. L Gakava & S Kannan – October 2015 Agenda All about the terminal o Customising your terminal o Basic Linux terminal commands o Running SAS in non-interactive mode o Available SAS file editors o What to look out for on Unix/Linux platform All about Graphical User Interface (GUI) o Launching SAS GUI. o Changing SAS default behaviour o SAS ToolBox commands o SAS editor commands. Motivation - Why Use SAS On Unix/Linux? Using SAS on UNIX/Linux Platform o Company migrating to UNIX/Linux o Joining a company which is using SAS on the Linux platform Challenge Too many commands to learn! Why Use SAS On Unix/Linux o Customising Linux sessions will ensure you increase work efficiency by taking advantage of the imbedded Linux tools. In general transferring and running large files will be quicker in Linux compared to PC*. Terminal What to expect when you login? % pwd /home/username % ls Customise: Update .bashrc file with this line PS1='$IV $PWD$EE> ' will change your prompt to show the following: /home/username> Terminal Navigation Command Meaning ls list files and directories ls -a list all files and directories mkdir make a directory cd directory change to named directory cd change to home-directory cd ~ change to home-directory cd .. change to parent directory Terminal Navigation Command Meaning cp file1 file2 copy file1 and call it file2 mv file1 file2 move or rename file1 to file2 rm file remove a file rmdir directory remove a directory cat file display a file less file display a file a page at a time head file display the first few lines of a file tail file display the last few lines of a file grep 'keyword' file search a file for keywords count number of lines/words/ wc file characters in file Terminal useful commands How do you find out if a version of a file has changed? /home/username>diff file1.txt file2.txt Command to compare two files.
    [Show full text]
  • Research Methodology Series
    Research Methodology Series Referencing Made Easy: Reference Management Softwares ROMIT SAXENA,1 JAYA SHANKAR KAUSHIK2 From Departments of Pediatrics, 1Maulana Azad Medical College, New Delhi; 2Post Graduate Institute of Medical Sciences, Rohtak, Haryana. Correspondence to: Dr Romit Saxena, Department of Pediatrics, Maulana Azad Medical College, Bahadur Shah Zafar Marg, New Delhi. [email protected] PII: S097475591600363 Note: This early-online version of the article is an unedited manuscript that has been accepted for publication. It has been posted to the website for making it available to readers, ahead of its publication in print. This version will undergo copy-editing, typesetting, and proofreading, before final publication; and the text may undergo minor changes in the final version. INDIAN PEDIATRICS 1 SEPTEMBER 04, 2021 [E-PUB AHEAD OF PRINT] ROMIT SAXENA AND JAYA SHANKAR KAUSHIK REFERENCE MANAGEMENT SOFTWARES ABSTRACT Reference management softwares are a powerful tool in the researchers’ armamentarium. They primarily help in resequencing, re-styling and reformatting of the citation content in the research manuscripts. They also enable multi-user collaboration on research and allow the researcher to manage database searches and digital libraries. Using these softwares allows synchronization of cloud based digital libraries on multiple electronic devices enabling remote access, and also allows for management of online portfolios. We, herein, describe the basic principles, functions, and limitations of various reference management sofares. Keywords: Bibliography, Citation, Metadata, Research. Researchers often use existing medical literature as books, journal articles, monographs and internet sites, as a base for new research articles. The researcher duly acknowledges and gives credit to the previous researcher for their contribution by citing the referenced literature sources at the end of one’s article.
    [Show full text]