From Mageia wiki
m (Fix minor leftovers) |
(→Making a new publication) |
||
| Line 62: | Line 62: | ||
** For '''EPUB format''' choose '''[DEFAULT] EPUB2''' | ** For '''EPUB format''' choose '''[DEFAULT] EPUB2''' | ||
* '''Stylesheet Params''' | * '''Stylesheet Params''' | ||
| − | ** For ''Installer'' manual, add this:<br /> | + | ** For ''Installer'' and ''NetInstall'' manual, add this:<br /> |
profile.condition=classical | profile.condition=classical | ||
::and for ''Live'' manual, add: | ::and for ''Live'' manual, add: | ||
Revision as of 20:20, 15 January 2019
Please remove this {{Draft}}template, when you're sure the page is complete and correct.
|
You can make all kinds of publications in Calenco.
At the moment we use:
- html without screenshots for the inline help
- html with screenshots for the online help
- EPUB
Downloading an existing publication
To download a publication:
| Note: If a publication is written to an external server, for instance to docteam.mageia.org.uk, then it is impossible to download it from Calenco |
- Open Mageia Calenco workspace
- Select the Manual you want to publish, for instance DrakX.xml on the right
- For MCC help, just replace "DrakX" with "MCC" everywhere in this paragraph.
- Choose Publications in the menu bar and select the publication you want to download
- In the drop-down menu:
- DrakX is the inline help for installer. It generates very basic html files without screenshots. Of course there is no inline MCC help for installer!
- In other languages, it is DrakX-FR, DrakX-DE, DrakX-EL, etc. (go to the correct language space, first)
- DrakX-EN-WebHelp is a very nice html help publication (it replaced the deprecated DrakX_HTML)
- You cannot download it from Calenco, but from http://docteam.mageia.org.uk/en/installer/content
- For MCC, the link is http://docteam.mageia.org.uk/en/MCC/content
- For other languages, replace "EN" with the needed language code
- You cannot download it from Calenco, but from http://docteam.mageia.org.uk/en/installer/content
- DrakX-EN-WebHelp-zipped is the same as the above publication, but easier to download. It is used for our official documentation (packaged and on our website. You can find it here http://docteam.mageia.org.uk/zipped/
- DrakX-EN-EPUB generates the English .epub help for installer, download from http://docteam.mageia.org.uk/EPUB/
- DrakX-EN-PDF generates the .pdf help http://docteam.mageia.org.uk/PDF/
- DrakX is the inline help for installer. It generates very basic html files without screenshots. Of course there is no inline MCC help for installer!
- Please ping papoteur on IRC if a publication doesn't include the last changes.
Making a new publication
- Select the Manuals classification on the left
- Select the Manual you want to make a publication for, for instance DrakX.xml on the right
- Choose Publications in the menu bar
- Choose Manage from the drop-down menu
- Choose New Publication in the new window that appears
- Choose a Pub(lication) Name, click tab: the output file name will now be the same as the publication name.
- Make sure you don't choose a name that already exists, not even for another language
- The installer webhelp publications should have similar names as DrakX-EN-Webhelp (replace EN with the correct language code)
- MCC webhelp should get names similar to MCC-ET-WebHelp (unfortunately, the English one misses the "EN-" in the name)
- The zipped MCC webhelp (for pasmatt to package) should be named like MCC-ET-WebHelp-zipped (again the English one misses the "EN-")
- EPUB: DrakX-EN-EPUB, MCC-EN-EPUB etc.
- PDF: DrakX-EN-PDF, MCC-EN-PDF etc.
- Choose an Output Format
- HTML-Based Formats (Multiple Pages) is good for the help in installer
- Web Help is good for the online help
- PDF for .pdf
- EPUB Format for .epub
- Output Processor Params (Optional): it is not needed to enter anything here
- Stylesheet
- If you chose the Webhelp Output Processor, the Stylesheet needs to be set to
- WebHelp-DrakX.xsl for DrakX (installer help)
- WebHelp-MCC.xsl for MCC help
- If you chose HTML-Based Formats (Multiple Pages), then choose docbook-xhtml-drakx.xsl here
- For PDF choose [DEFAULT] XSL-FO
- For EPUB format choose [DEFAULT] EPUB2
- If you chose the Webhelp Output Processor, the Stylesheet needs to be set to
- Stylesheet Params
- For Installer and NetInstall manual, add this:
- For Installer and NetInstall manual, add this:
profile.condition=classical
- and for Live manual, add:
profile.condition=live
- This will select some parts or images specific to each manual in common pages.
- If, when using non-Latin languages, the characters aren't displayed well in a PDF publication, then you should use special stylesheet for publication. Currently, we use the following stylesheets and fonts:
| Languages | Scripts | Stylesheet | Font |
|---|---|---|---|
| European non-Latin1 | Latin, Cyrillic, Greek | docbook-fo-fonteur.xsl | Liberation Sans |
| Chinese | Chinese traditional and simplified | docbook-fo-A4.xsl | Open Hei |
| Japanese | Kanji and kana | docbook-fo-fontja.xsl | UmePlus P Gothic |
- To add a new language you have to
- Determine a free font for its script
- Ask Calenco admin (Camille Bégnis) to install the font on server
- Copy under the new name docbook-fo-fontja.xsl from Calenco content folder
- Edit the new file and replace all UmePlus P Gothic strings with the name of the new font
- Choose the new stylesheet for PDF publication
- Store output on
- Workspace is currently the correct place for the inline help for installer
- All Webhelp publications should be stored remotely
- In the latter case, choose FTP Server and fill out all the needed fields
- If you want to make a webhelp publication for a new language, then it is easier to start your browser twice, put the screens side by side and login to Calenco twice. You can then click the edit button of a similar publication to easily copy most settings to the new publication.
- In the latter case, choose FTP Server and fill out all the needed fields
Here is a table with each publication we can have. Replace cc with the language code in same case.
| Manual | Publication name | Output Format | Stylesheet | Path | Stylesheet params | transfer each file instead of archive |
|---|---|---|---|---|---|---|
| DrakX | DrakX-CC-EPUB | EPUB Format | [DEFAULT]EPUB2 | public_html/EPUB/installer/ | profile.condition=classical | |
| cc | HTML-Based Formats (Multipl | docbook-xhtml-drakx.xsl | public_html/zipped/drakx-installer-help/ | profile.condition=classical | ||
| DrakX-CC-WebHelp | Web Help | WebHelp-DrakX.xsl | public_html/cc/installer/ | profile.condition=classical | X | |
| DrakX-CC-WebHelp-zipped | Web Help | WebHelp-DrakX.xsl | public_html/zipped/installer/cc/ | profile.condition=classical | ||
| DrakX-cover | DrakX-cover-CC-PDF | [DEFAULT]XSL-FO | public_html/PDF/installer/ | profile.condition=classical | ||
| DrakLive | DrakLive-CC-EPUB | EPUB Format | [DEFAULT]EPUB2 | public_html/EPUB/draklive/ | profile.condition=live | |
| DrakLive-CC-WebHelp | Web Help | WebHelp-DrakX.xsl | public_html/cc/draklive/ | profile.condition=live | x | |
| DrakLive-CC-WebHelp-zipped | Web Help | WebHelp-DrakX.xsl | public_html/zipped/draklive/cc/ | profile.condition=live | ||
| DrakLive-cover | DrakLive-cover-CC-PDF | [DEFAULT]XSL-FO | public_html/PDF/draklive/ | profile.condition=live | ||
| MCC | MCC-CC-EPUB | EPUB Format | [DEFAULT]EPUB2 | public_html/EPUB/MCC/ | ||
| MCC-CC-WebHelp | Web Help | WebHelp-MCC.xsl | public_html/cc/MCC/ | X | ||
| MCC-CC-WebHelp-zipped | Web Help | WebHelp-MCC.xsl | public_html/zipped/MCC/cc/ | |||
| MCC-cover | MCC-cover-CC-PDF | [DEFAULT]XSL-FO | public_html/PDF/MCC/ | |||
| NetInstall | NetInstall-CC-EPUB | EPUB Format | [DEFAULT]EPUB2 | public_html/EPUB/netinstall/ | ||
| NetInstall-CC-WebHelp | Web Help | WebHelp-DrakX.xsl | public_html/cc/netinstall/ | x | ||
| NetInstall-CC-WebHelp-zipped | Web Help | WebHelp-DrakX.xsl | public_html/zipped/netinstall/cc/ | |||
| NetInstall-cover | NetInstall-cover-CC-PDF | [DEFAULT]XSL-FO | public_html/PDF/netinstall/ |
- Attention-1: for some servers, using the remove existing files option makes the publication fail. For some other servers, it is the opposite: the publication fails if you do not use this option. For docteam.mageia.org.uk both options should work now, but ticking remove existing files sometimes helps to resolve a problem. (not ticking remove existing files is better, because then someone who reads the publication doesn't see any errors while it is updated)
- Attention-2: if the destination directory does not yet exist, then please make it first after connecting to the server with ssh or e.g. filezilla.
- Type
- If you choose Automatic, the publication will be updated automatically with every change to one of the .xml, .png or .xsl files it is made of. It was advised to use this setting, but since we have so much to publish on every change, the automatic publications break too often. We are now moving to only using it for the English publications, because the documentation is still written (in English) in Calenco. For all other languages Manual is better, now.
