|\     /|
| )   ( |
| | _ | |
| |( )| |
| || || |
| () () |
(_______)
         

         
         
  ### ## 
 ##  ##  
 ##  ##  
  #####  
     ##  
 #####   

__   __
\ \ / /
 \ V / 
 /   \ 
/ /^\ \
\/   \/
       
       

         
         
  #####  
 ##      
  ####   
     ##  
 #####   
         

         
  ###    
   ##    
   ##    
   ##    
   ##    
  ####   
         

IMPORTANT: enter the case-INsensitive alphabetic (no numbers) code AND WRITE SOME SHORT summary of changes (below) if you are saving changes. (not required for previewing changes). Wiki-spamming is not tolerated, will be removed, so it does NOT even show up in history. Spammers go away now.


Visit Preferences to set your user name
Summary of change:
'''Developer notes on publishing GenBoard/Manual''' '''Automatically published HTML''' [http://megasquirtavr.sourceforge.net/manualhtml/index.html HTML Manual 1] and [http://megasquirtavr.sourceforge.net/manualhtml2/index.html HTML Manual 2] are generated on sourceforge server, by ''/home/groups/m/me/megasquirtavr/bin/daily_snapshot.sh'' script. This [http://www.vems.hu/documentation.html naughty page] still links the old unmaintained manual, there are serious errors in it. Use the new one above. TODO: fix the link (it's not an editable wiki page). Two solutions: * --Use the 2 XSL documents written by Peter.-- Done. The script has been edited to suit. * Fix the confusion within manual.xml to let it work with !DocBook XSL. Some local tests suggest it's OK, but that XSL import paths were messed up. Who knows... lets see what happens when CVS is updated. The HTML generation should be executed regularly. Marcell could change all sourceforge URLs in the wiki with a mass-replace ''http://megasquirtavr.sourceforge.net/manualhtml/ => http://www.vems.hu/manual/html/'' in SQL, but unfortunately: * http://megasquirtavr.sourceforge.net/manualhtml/Basics.Overview.Outside.html '''good filenames''' * http://www.vems.hu/manual/html/ch03s02.html '''bad filenames''' So we should make sure the HTML is generated with the good filenames. Should just be the matter of running with the right options (right xslt?). ---- '''Other output formats''' Producing formatted output is fairly easy with the XML files. Currently we've got chunked HTML and PDF output working: * HTML is produced by running a slightly tweaked !DocBook transform. We use a file called vems.xsl which sets the stylesheet then imports the standard chunk.xsl. The output can be seen [http://www.vems.hu/docs/genboardv3/ here]. * PDF is produced by running the fo/docbook.xsl transform to make a FO (Formatting Object) file, then using [http://xml.apache.org/fop/index.html Apache FOP] to convert this to PDF. There are other options for output such as PS, PCL, and even SVG, but PDF is the most useful to us. We'll probably make a custom XSL for this conversion too, so we can tweak the output to our needs. A "first cut" example of the PDF output is [http://www.vems.hu/files/MembersPage/RichardBarrington/manual.pdf here] (781 kB PDF file). ---- '''See also''' * GenBoard/Manual
Optional: Add document to category:
Wiki formatting: * is Bullet list ** Bullet list subentry ... '''Bold''', ---- is horizontal ruler, <code> preformatted text... </code> See wiki editing HELP for tables and other formatting tips and tricks.