Page MenuHomeFreeBSD

fix inlined asciidoc code in en/books/fdp-primer/asciidoc-primer
ClosedPublic

Authored by vladlen on Wed, Sep 24, 3:19 PM.
Tags
Referenced Files
Unknown Object (File)
Sat, Oct 18, 3:01 PM
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:19 PM
Unknown Object (File)
Sun, Oct 12, 11:43 PM
Unknown Object (File)
Sun, Oct 12, 3:11 AM
Unknown Object (File)
Mon, Oct 6, 2:20 PM
Unknown Object (File)
Thu, Oct 2, 6:27 PM
Subscribers

Details

Summary

Asciidoc primer in FDP primer contains example, how to include images
into documentation and website. This code rendered wrong in both
html and pdf EN versions, and create troubles to generate correct translated
documents too.

  1. "ifdef::" were included to demonstrate real code from articles/releng,

but they are not rendered, but executed in adoc code - they are not shown as it was expected,

  1. due to they execution, these "ifdef::" hide this code in pdf version (condition of ifdef:: is false),

and pdf documents does not have text is this example.

  1. this kind of AsciiDoc examples do not correctly processed in PO files and require

manual processing after translation.

  1. these ifdef:: are not matched, 1 endif:: is missing, it is additional problem in this code.

This ifdef:: are not part of explanation about image directive (they are only nearby code)
and should be deleted from code.

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

vladlen created this revision.
bcr added a subscriber: bcr.

Looks good. We can try to fix the underlying issue separately.

This revision is now accepted and ready to land.Thu, Sep 25, 1:03 PM
In D52710#1204585, @bcr wrote:

Looks good. We can try to fix the underlying issue separately.

@bcr I have only doc/ru committers bit. It would be good if someone with EN doc committers bit fix it. I could do it, if I had permission.
It really fixes very annoying problem in this place of documentation.

Taking into account @bcr review, please go ahead and commit with

Reviewed by: bcr
Approved by: maxim (mentor)

In D52710#1204585, @bcr wrote:

Looks good. We can try to fix the underlying issue separately.

@bcr Similar patch in other fdp-primer file https://reviews.freebsd.org/D52678