Page MenuHomeFreeBSD

fix inlined asciidoc code in en/books/fdp-primer/examples
AbandonedPublic

Authored by vladlen on Mon, Sep 22, 5:01 PM.
Tags
Referenced Files
F132336969: D52678.id162577.diff
Thu, Oct 16, 12:47 AM
Unknown Object (File)
Mon, Oct 13, 12:19 PM
Unknown Object (File)
Mon, Oct 13, 12:19 PM
Unknown Object (File)
Mon, Oct 13, 12:18 PM
Unknown Object (File)
Sun, Oct 12, 11:42 PM
Unknown Object (File)
Wed, Oct 8, 9:28 PM
Unknown Object (File)
Wed, Oct 1, 9:01 PM
Unknown Object (File)
Wed, Oct 1, 5:34 PM
Subscribers
None

Details

Reviewers
maxim
Group Reviewers
Doc Committers
Summary

I proposed simpler and from my point of view better solution in https://reviews.freebsd.org/D52774

FDP-primer has examples page, containing AsciiDoc example of code inside of AsciiDoc. It is always the challenge to represent AsciiDoc from AsciiDoc.
Currently example page rendered correctly in English, but PO file for translations is generated with destroyed AsciiDoc text (I did not find any way to fix it by options). Final translated version of books/fdp-primer/examples require manual correction or copy from English version.

I propose to use trick with include directive: put all examples code into separate files and include them inside of code block. It works.

Translators do not need any manual changes in this case, also they have option correctly translate examples in separate files.

Manual work documented in Wiki (https://wiki.freebsd.org/Doc/Translation/Weblate/Documents in section Books sentence about examples.adoc), but it is not described in FDP-primer now. This patch excludes this manual work.

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Lint Skipped
Unit
Tests Skipped