Difference between revisions of "Book/HelloXenProject/Instructions for Improvement"

From Xen
Line 1: Line 1:
The content of the wiki page has now been converted. But there are a number if areas which could do with improvements
+
The content of the wiki page has now been converted.
  +
  +
== General Improvements ==
  +
But there are a number if areas which could do with improvements
 
* Empty spaces between chapters: the conversion left many <nowiki>\n</nowiki> in documents. These mean that extra empty space is added between chapters. These can be easily deleted
 
* Empty spaces between chapters: the conversion left many <nowiki>\n</nowiki> in documents. These mean that extra empty space is added between chapters. These can be easily deleted
 
* Code or config file snippets are currently not specifically formatted or formatted in <nowiki><nowiki>...</nowiki></nowiki> blocks. The best way to do this is to use <nowiki><syntaxhighlight lang="sh">...</syntaxhighlight></nowiki> instead
 
* Code or config file snippets are currently not specifically formatted or formatted in <nowiki><nowiki>...</nowiki></nowiki> blocks. The best way to do this is to use <nowiki><syntaxhighlight lang="sh">...</syntaxhighlight></nowiki> instead
Line 5: Line 8:
 
* If you come across unnecessary <nowiki><span ...> ...</span></nowiki> blocks, feel free to remove
 
* If you come across unnecessary <nowiki><span ...> ...</span></nowiki> blocks, feel free to remove
 
* Feel free to fix up badly formatted tables (see [https://www.mediawiki.org/wiki/Help:Tables#class.3D.22wikitable.22 1] and use [[Table_Style_Examples|class prettytable]])
 
* Feel free to fix up badly formatted tables (see [https://www.mediawiki.org/wiki/Help:Tables#class.3D.22wikitable.22 1] and use [[Table_Style_Examples|class prettytable]])
  +
  +
== Specific Issues ==
  +
* Chapter 1 does not render with the built in [[Special:Book]] generator. Probably due to a PDF is too large. When using external book renderers, the tick boxes in [[Book/HelloXenProject/1-Chapter#Compare_Virtualization_Software]] do not render correctly.
   
 
[[Category:Users]] [[Category:HelloXenProjectBook]]
 
[[Category:Users]] [[Category:HelloXenProjectBook]]

Revision as of 10:50, 18 April 2017

The content of the wiki page has now been converted.

General Improvements

But there are a number if areas which could do with improvements

  • Empty spaces between chapters: the conversion left many \n in documents. These mean that extra empty space is added between chapters. These can be easily deleted
  • Code or config file snippets are currently not specifically formatted or formatted in <nowiki>...</nowiki> blocks. The best way to do this is to use <syntaxhighlight lang="sh">...</syntaxhighlight> instead
  • If you come across bullets like ●, replace with proper mark-up, aka: *
  • If you come across unnecessary <span ...> ...</span> blocks, feel free to remove
  • Feel free to fix up badly formatted tables (see 1 and use class prettytable)

Specific Issues