Category:HelloXenProjectBook: Difference between revisions

From Xen
Jump to navigationJump to search
No edit summary
Line 3: Line 3:


== Converting chapters ==
== Converting chapters ==
For instructions on how to convert chapters from DOC file to this wiki, check out [[Book/HelloXenProject/Instructions_for_Conversion]]. It takes 1-3 hours to convert a chapter. Any help from community members is highly appreciated.
=== Prerequisites ===
* Install a Linux distribution which contains LibreOffice's MediaWiki export function (e.g. openSUSE, Fedora, some versions of Debian)
* Download the the attachment from [https://lists.xenproject.org/archives/html/xen-devel/2017-04/msg01738.html]

=== Workflow ===
Chose the chapter that you want to convert. You can do this in one of two ways
* Convert the entire document and delete the portions of the generated mark-up that are not part of the chapter you want to add
* Use the [https://help.libreoffice.org/4.3/Writer/Working_with_Master_Documents_and_Subdocuments Working with Master Documents and Subdocuments] to split the document into subsections
* Run the generated markup through [http://www.unit-conversion.info/texttools/strip-tags/ www.unit-conversion.info/texttools/strip-tag] or similar, otherwise the markup will contain unnecessary html
* Fix up the mark-up (see below)
* Add images (see below)
* Repeat and rinse until correct

==== Preparing the generated markup ====
Before you create the page, copy the chapter into your favourite editor. I observed that several things tend to go wrong
* Some of the bulleting does not get converted correctly: you may find special characters being created such as "•" and "• " (sometimes in different sizes). You may need to replace "•" with "* ", etc.
* Tables tend to be generated poorly, but ultimately they are OK. If you want them to look pretty, remove any style="..." elements (you can use replace the style strong with "") and make sure table headers start with "!". In addition you may want to add have the table begin with <pre>{| class="prettytable"</pre>
* Special characters such as ticks or crosses get to converted wrongly: they will end up as "x". You will have to fix these up manually. Check out [https://wiki.xenproject.org/wiki/Category:Templates] for suggestions
* Images tend to get generated as
<pre>
[[Image:|top]]

==== Figure 2: ... ====
</pre>
To fix this you can use search and replace to get something like
<pre>[[Image:|top|Figure 2: ... ]]</pre>
After that, replace "[[Image:|top|" with "[[Image:XXX.png|600px|none|thumb|" - this ensures that images are the same size and you can search for XXX.png
* Headlines do not always come across correctly. You may need to do some editing there.
* At the bottom of the page, add
<pre>[[Category:Users]] [[Category:HelloXenProjectBook]]</pre>

==== Creating the page ====
If you add chapter X, then create a page called
* <pre>Book/HelloXenProject/X-Chapter</pre> and copy the content in
* Go to preview and check how it looks
* Fix up any remaining issues
* Then save
* Go to [[Book/HelloXenProject/0-Contents]] and add the chapter. This will look something like
<pre>
[[Book/HelloXenProject/X-Chapter|Chapter title]]<br>
</pre>
* Go to [[Book/HelloXenProject/0-Credits_and_Title#Subsequent_Contributions|Subsequent_Contributions]] and add yourself as a contributor

==== Adding images ====

Revision as of 17:22, 12 April 2017

Credits

This book was originally contributed by Mohsen Mostafa Jokar (see e-mail thread that includes a PDF) with the intention to become a book that others can contribute to and evolve over time.

Converting chapters

For instructions on how to convert chapters from DOC file to this wiki, check out Book/HelloXenProject/Instructions_for_Conversion. It takes 1-3 hours to convert a chapter. Any help from community members is highly appreciated.

Retrieved from "https://wiki.xenproject.org/index.php?title=Category:HelloXenProjectBook&oldid=17697"