Giter Club home page Giter Club logo

genode-manual's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

genode-manual's Issues

Warnings when generating grayscale PNGs for epub

When I try to build the epub version of the manual, 'convert' outputs the following warning message, which causes 'make' to abort:

convert-im6.q16: profile 'icc': 'RGB ': RGB color space not permitted on grayscale PNG `img/protection_domain.png' @ warning/png.c/MagickPNGWarningHandler/1665.

This happens not only with 'protection_domain.png' but with all grayscale images. The problem is probably the ghostscript command which generates the PNG image and is called with the pngalpha argument so that sRGB is used. 'convert', however, seems to output the above-mentioned warning message if its input file has a sRGB colorspace although containing only grayscale content.

Removing the ICC profile suppressed the warning message on my setup:

img/%.png: img/%-unscaled.png
    #convert -filter lanczos -resize 80% $< $@                 #before
    convert -filter lanczos -resize 80% +profile icc $< $@     #after

I can't exclude that this change just hides potential problems. That warning message might have a purpose.

My ImageMagick version on Debian/unstable:

Version: ImageMagick 6.9.10-8 Q16 x86_64 20180723 https://www.imagemagick.org

Make failed because of no 64ee151d07a65dd0a77039817cb9a7fa11b53a6e in genode.git

There seem be no commit 64ee151d07a65dd0a77039817cb9a7fa11b53a6e in genode.git repo.

logs:
cd genode.git; git reset --hard 64ee151d07a65dd0a77039817cb9a7fa11b53a6e
fatal: Could not parse object '64ee151d07a65dd0a77039817cb9a7fa11b53a6e'.
make[1]: *** No rule to make target 'genode.git/checked_out.tag', needed by 'class_index.mk'. Stop.
make[1]: Leaving directory '/home/zp/stemos/genode-manual.git/manual/spec'
make: *** [Makefile:49: spec/classes] Error 2

Build error for `img/nested_config.pdf`

When building the foundations, I get a TeX capacity exceeded, sorry [grouping levels=255] error that is caused by img/nested_config.tikz. The same error occurs when I try to build img/nested_config.pdf. Here is an excerpt from the log:

(./tikz-common.tex)) (./nested_config.tikz
! TeX capacity exceeded, sorry [grouping levels=255].
\pgfpicture ->\begingroup 
                          \pgfpicturetrue \global \advance \pgf@picture@seri...
l.66 }

Build failed due to missing chapter tag

Hi,

I get the following error when building Genode foundations 20.05:

gosh --style manual.gosh genode-foundations-20-05.txt > misc.tmp.tex can't read "chapter_tag": no such variable

entire log: build-log.txt

I made sure that I have all required programs.

Best,
Chris

Web Version

I used your EPUB code for implementing a usable web version of the manual. My main motivation was the rigid layout of the PDF doc. This web version always tries to adapt its layout to the screen and font size. In most cases, the content should be well readable on any device. The makefile also separates all sections from each other. Together with the navigation elements, which were inspired by the "page per node" GNU manuals, these changes hopefully make navigating through the docs much comfortable.

Besides that, a very basic version of the specification chapter is added. This is may be the biggest, remaining task. Instead of formatting all those API data, the GitHub header file of each referenced element is just hyperlinked. However, since the readers would visit the web manual with their browsers anyway, this might actually be an acceptable solution.

But the commits may not be ready for a merge:

  • I used many, possibly error-prone hacks. For example, if one of your section names contained a single quote, it would break the whole build process.
  • Some parts make heavy use of gosh internals. Redesigning parts of gosh could simplify the build code.
  • The EPUB generation might be partially broken now. The EPUB file still works when opened with mupdf. But its images are not displayed on my PocketBook.
  • There are still a few minor HTML bugs:

If you are not willing to merge yet, these commits might serve as a basis for a cleaner implementation. Unfortunately, I can't put more time into this for a while. However, feel free to ask me if you have any questions.

Live demo
Code, see the readme for building instructions.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.