DocBook:Collab User Manual
Contents
1. Joornmla l Administrator Home Site Menu Content Components Modules Mambots Installers Messages System Help 0 ee 1 aa Logout soeren Joomla 1 0 12 Y z p l j Import Fh Rebuild P Download D AEE T i O Sa 4 DocBook AML p DocBook AML S DocBook AML i dars Hin Edit Delete i SOUTCeS from database SOU eS Fublish Unpublish lt collab gt veys SOT a heehee component for Dockock documents 5 z Document Man ager Document Name Repository Path Published lt lt Start lt Previous Next gt End gt gt No records found docbook collab gt 2006 Soeren Eberhardt amp others Check for latest version Joomla is Free Software released underthe SNUIGPL License Joomla 1 0 12 RO Sunfire 13 December 2006 05 00 UTC Check for latest Version Figure 5 Create a new document Click New After that a form shows up that allows you to specify the details for the new document Save Cancel lt collab gt Gi Whee ho Commons for Decco documenta e Add Document Document Title Type of DocBook Document JEF Book The structure of a DocBook file Simplified DocBook V1 7 DOCTYPE Declaration DocBook V4 5 More about Simplified DocBook Description Published Readgroup Public Frontend Editgroup Editor Admingroup Administrator R The Editgroup must have more or the same rights as the Readgroup and the Admingroup must have more or the same rights as the Editgroup e g Readgroup2. Hand Tools Power Tools Sarden Tools lt article gt Figure 13 Bitflux XML Editor TODO More about working with the BXE In the Source View you can edit the XML source 44 Manual Installation First Steps a WirtueMart User Manual k Installation k Installation FAG Created by 30 March 2007 17 07 i ia a R n f Installation FAG Last Modified by soeren 30 March 2007 19 03 Save Content Close f Cancel para gt enmphasis role bold gt Q lt emphasis gt The Installer tells me ERROR Could not find an XML setup file in the package What iosS s rong lt para gt lt para gt emphasis role bold gt A lt femphasis gt Mostly this problem Arises hecause you don 039 t have unpacked the file tried uploading installing this file para lt para gt para gt emphasis role hbold gt Q lt femphasis gt The Installer tells me Another component is already using the directory Figure 14 XML Source Editing The best way to comfortably edit the section s content is copying this source into an XML editor editing it there and copy paste the source back into this textarea 10 DocBook Collab User Manual 3 5 Apply Changes by rebuilding a Document Note This functionality is only available in the administrator backend Restructuring a document and editing the sections contents does not actually change the real XML document which is used for export So your changes do not show up in the document
3. 0 12 RC Sunfire 13 December 2 S o0 UT l Check for latest Version Figure 8 The document VirtueMart User Manual has been imported 3 3 Modifying Document Structure 3 3 1 Introduction Note This functionality is only available in the frontend When you re logged in as a user of the admin group you can modify the document structure This means you can add new sections move existing sections to other places reordering or moving to other parent sections or remove them completely Starting point is the document list in the frontend the start page of DocBook Collab lt collab gt a Aika ye component for GecBeck documenta Please select a document from the list VirtueMart User Manual A Show table of contents Browse document online SS EN Download the document as a I w h Wi docbook collab gt is a Wiki style component which supports the PEZ L Standard Figure 9 Start page of DocBook Collab Document List DocBook Collab User Manual In this listing you just need to find the document you want to modify and click Show tables of contents or the Edit Icon Now you can see the document structure He rie VirtueMart User Manual _ A s 8d a new section 1 Preambel A 2 introduction 1 What does itdo E A 1 About zE 2 Features F fi gt What does it not do 3 Screenshots 7 3 Installation A 1 Installati
4. in the frontend As an user of the edit group you are allowed to edit the content of a section To do so just browse to a section from the section list In the section view right above the section content you can find the button Edit Section Content If you click that button you can either see a Editor Window with an WYSIWYG view of the section s XML source or a textarea with the raw XML source This depends on the Document Declaration Type of the Document If it is of type Simplified Docbook you can use the editor if it is of another type you just see the textarea with the raw XML source 44 Manual Installation First Steps a VirtueMart User Manual Installation Installation FAG fi Installation FAG Edit Section Content Installation FAQ Q The Installer tells me ERROR Could not find an XML setup file in the package What s wrong A Mostly this problem arises because you dont have unpacked the file VirtueMart x x_ COMPLETE PACEACE zip before and tried uploading installing this file Figure 12 The section content view This is the BitFlux XML Editor BXE view DocBook Collab User Manual 7B ean E x H abet E Er sos 06 DocBookCollab User Manual Tolle Section Created by soeren fi Tolle Section Last Modified by soeren 30 March 2007 19 37 Contact Us Tolle Section docbook collab gt is a Wiki style component which supports the MIL Standard Wrapper ONLINE SHOP
5. is Author Editgrooup is Publisher and Admingroup is Publisher docbook collab gt 2006 Soeren Eberhardt amp others Check for latest version Figure 6 Add Document form Document Title Type of DocBook Document DOCTYPE Declaration Description Published Readgroup Editgroup Admingroup DocBook Collab User Manual The title of the Document This can be something like My Software User Manual Docbook allows two general types of documents the book and the article The book can have one or more articles where an article can contain different sections Currently only article is supported This usually is enough for normal User Manuals This allows you to select the doctype decaration used to validate the document Basically this defines the grammar for the XML document and specifies which tags can be used Recommended is Simplified Docbook because this will allow you to edit contents using the BitFlux XML Editor This XML WYSIWYG Editor can validate XML while you re typing and helps you to work with the Docbook tags This text is shown in the frontend document list to explain the content of this document Check this box to make it available to the public The Joomla minimal usergroup that is allowed to read this document All child groups will have access as well The Joomla minimal usergroup that is allowed to edit this document All child groups will have this permission as well The Joo
6. scripts and programs Please check if your server and client meets the following requirements 1 3 1 Server e Joomla gt 1 0 0 or Mambo gt 4 5 2 with DOMIT DocBook Collab User Manual e Java Runtime Environment needed for PDF creation e PHP with XSLT support e recommended PHP5 with DOM and XSL extensions e recommended alternative faster xsltproc command line program 1 3 2 Client You need Firefox or another Mozilla based browser for being able to use the BitFlux XML Editor 2 Installation In most cases it 1s not possible to install DocBook Collab using the component installer which is integrated in Joomla This is due to the large file size of the DocBook Collab distribution which must be uploaded to the server That s why the DocBook Collab installer file must be extracted to a local directory first To do so just open the file you have downloaded docbook_collab_1 0 x tar gz and extract its contents into a new directory r dochook_collab_1 0 4 tar gz 12 5 MB Gzip komprimiertes Tar gt i 40 E a O Par rab rr leaid Figure 1 docbook_collab_1 0 4 tar gz Installer Archive Note You can open tar gz files with WinZip or Winrar or whatever you use to extract archive files Archive files with the ending tar gz are not much different from ZIP files but they have a better compression rate After you have unpacked the archive just open your favourite FTP program SmartFTP WS_FTP FileZilla
7. terms and conditions of the GNU General Public License P Upload new component Success Dogc Book Collab DocBook Collab is a wiki stwWe component for shared user documentation manage ment Continue Figure 3 Installation was successful DocBook Collab is installed now Just start working with it S Joomla Administrator Home Site Menu Content Modules Mambots Installers Messages System Help g 188 Logout soeren Faia a E E O 3 Banners Import a Rebuild P Download ai virueMar Demo 1 Pm Book XML figg DocBook AML T DeeBeok XML es E jase Jol se Publish i docs New yy DocBook Caollab HEE Manage Documents JCE Admin HS Configuration Z CC joomlaAplorer About BocBook Collab anager Display 30 a wkati componant for Gack A hlass hlail W News Feeds Document Name W Balls Path Published 2 Syndicate s Next gt End gt gt E VirtueMart found yy VirtueMart Language Manager hardt amp others Check for latest version j Web Links pl under the GNU GPL License December 2006 05 00 UT Figure 4 The Docbook Collab controls can be accessed through the top menu Please don t forget to remove the installation files from the newly created directory media dbc You can just delete it 3 Working with Documents DocBook Collab User Manual 3 1 Create a new Document You can create a new document from scratch in DocBook Collab Just click the New button in the toolbar
8. DocBook Collab User Manual S ren Eberhardt Copyright 2007 S ren Eberhardt This document is published under the Open Content License available at http www opencontent org opl shtml Revision History Revision 1 0 30 03 2007 Table of Contents Tg MMTEOCUCELOM sia cone etarcecesuinrcnenatatctiescer cone chet EE E cet sonrelessedesenecousetaeabiasaarnet E N l PAE E S T E E A O A O T A E EE E E T E N N 2 3 Working with Documenis a6555 caaetasecdutdestonsiaccsemanedd a a Miedema dtiiudetasieoatdastousidedseoamensagudes 3 E 6 0 2 116 1b T O A I E T E E TE T O EE O E E A oer 1 1 Introduction lt collab gt BWR ye COMDOranG for Doce ock documente 1 1 About DocBook Collab is a wiki style component for the Content Management System Joomla Joomla is a framework to build a website and manage the content It can be extended easily using other software called components DocBook Collab is completely integrated into Joomla and let s users collaboratively work on Documents in the DocBook Format 1 2 Features DocBook Collab allows to e Upload and Import existing DocBook documents e Edit Section Content XML source online using a WYSIWYG editor e Restructure the Document by adding moving or removing Sections e Directly export the Document into various output formats such as Single Multi page HTML PDF or HTMLHelp chm 1 3 Requirements DocBook Collab is a complex component with a lot of helper
9. and login to your FTP server where the Joomla site is located on Browse to the subdirectory media Create a new subdirectory let s say dbc in media Browse into this directory Now upload the contents you have extracted before into this new subdirectory media dbc When you re finished you now need to login to your Joomla backend Go to Installers gt Components In the section called Install from directory you now need to fill in the path you have just uploaded the files into In my case this is opt lampp htdocs joomla_vml 0 media dd Install new Component Upload Package File Package File Durchsuchen Upload File amp Install Install fram directory Install directory Joptilampp htdocs joomla_vm1 0 media dd Install medial Writeable administratarcamponents Writeable components Writeable images stories Writeable s Figure 2 Point the installer to the directory with the docbook collab installer files DocBook Collab User Manual Click Install and Joomla will perform all required steps to install Docbook Collab It extracts the archive frontend_files tar gz and copies its contents into the correct directories lt CO lab gt Doc Book Collab Installation results ToDo Update leon task dacs Result sucess ToDo Update leon task about Result sucess ToDo Update leon task config Result sucess Copyright 2006 by Soeren Eberhardt This component is released under the
10. cked as archive foptlampp htdocsjoomla_vmnl Of componentscom_docbookcollab repositary Writeable edocbook collab gt 2006 Soeren Eberhardt amp others Check for latest version Joomla is Free Software released underthe GNU GPL License Check for latest Version Figure 7 Import Form After you have specified the file to import click Import Now and the Import starts If the Import was successful you will see the new document added to the document list Note The repository directory must be writable Please chmod 0777 the directory components com_docbookcollab repository DocBook Collab User Manual S Joomlal Administrator Home Site Menu Content Components Modules Mambots Installers Messages System Help a ga 1 Aa Logout soeren Fri 7 Joomla 1 0 12 IR i Import Rebuild P Download lke VirtueMart Dema f 5 K DocBook AML j DocBook SML SS S DocBook XML Ei com_docbookcallab Pie Edit Dei sources from database S sources Publish Unpublish lt collab gt ae Display 30 xj WREST component for Dockock documenta E Document Manager Document Name Repository Path Published 1 VirtueMart User Manual componentycam _docbhookcollab repositon Archiv tar 4 lt lt Start lt Prewious 1 Next gt End gt gt Results 1 1 of 1 docbhook collab gt 2006 Soeren Eberhardt amp others Check for latest version Joomla is Free Software released underthe GNU GPL License joomla 1
11. export downloads as long as you haven t rebuilt the document Rebuilding the document is an important process where the XML source document in the repository is rewritten by using the changed contents from the database All sections will be read from the tables and their content is written in the correct order directly into the XML source file Additionally all exported files will be removed so they can be freshly exported using the newly created XML source file as base Note So again All your changes in the frontend won t show up as long as you haven t rebuilt the document 4 Appendix 4 1 Export Formats 4 1 1 Single Page HTML The single HTML file format creates one big HTML file for the whole document 4 1 2 Multi Page HTML Multi page HTML is a format that will have a HTML file for each major section 4 1 3 PDF The PDF creation is possible if Java is installed on the server The PDF files will be created using Apache FOP 4 1 4 HTML Help This Export format creates a CHM file which is the Windows Help file format As it needs the Windows Help Compiler you need a Windows based Server Operating System or a Linux Unix Server with the latest Wine installed 4 2 Document Types Article and Book what s the difference Article is the only support document type at the moment 4 3 Links with more information Docbook Collab Hompage http joomlacode org gf project docbookcollab Home of Docbook http docbook
12. mla minimal usergroup that is allowed to modify this document and its structure All child groups will have this permission as well When you have finished filling in the requested information you can click Save in the toolbar and the new document and its repository will be created The XML file is created from a template file in the directory administrator components com_docbookcollab template 3 2 Import an existing Document Docbook Collab allows you to import existing Docbook documents including all additional files like screenshot images You can either import by using the upload field or specifying a file you have uploaded by FTP Note The Import File can either be the DocBook XML file or an archive zip tar gz tar bz with all the files used in the document You can access the Import Form by clicking Import existing Docbook XML sources in the toolbar DocBook Collab User Manual Home Site Menu Content Components Modules Mambots Installers Messages System Help 0 ge AR Logout soeren Joomla 1 0 12 VirtueMart Demo com_daocbookcollab 7 la R impart Import Roe al Howl Ahce lt collab gt BWHKEete Comoe for Deco documente ae Import existing DocBook sources Upload existing DocBook sources possible single AML PO AP Seer Rem file or multiple files packed as archive Specify a DocBook source on the server possible single foptilampp htdocsijoomlavmtO XML file or multiple files added ita Lal aE pa
13. on and Upgrade FA 2 Automatic Installation 3 Manual Installation FA 4 installation FAQ F 4 First Steps T Figure 10 The structure of a document the section list 3 3 2 Adding or modifying a section To add a new section click the Add a new section link at the top of the section structure the icon with two lines and a red arrow To modify an existing section click the first Icon after the section you want to modify the icon with the lines and the pen Add a new section VirtueMart User Manual Created by Title Published e Parent The Documentation Position First Position Figure 11 Section Form Here you can specify a title for the section and a parent section When you are done filling or changing the information in this form don t forget to click the Save Icon DocBook Collab User Manual 3 3 3 Moving or deleting a section To move a section you need to open the section form as explained in the last section Now change the parent section in the drop down list or change the position to reorder a section After having done your changes click the Save Icon to apply the changes To delete a section click the Delete Icon Trash Can in the section form Note Please note that a section is completely removed from the database if you delete it There s no way to restore it as there is no recycler 3 4 Editing Section Content Note This functionality is only available
14. org 1
Download Pdf Manuals
Related Search