Jak można osadzać obrazy w lokalnej dokumentacji Haddock?Umieszczanie obrazów w dokumentacji programu Haddock
Widzę na przykład the lens package po prostu używa zewnętrznych linków do obrazów, ale chciałbym przechowywać obrazy lokalnie.
(To pytanie jest bardzo podobne do an (unanswered) question on the mailing list).
Jeśli chcesz zapisać obraz lokalnie można:
-- A longer description of the package.
description: Some haskell package description.
<<file:///home/user/your_image.png>>
Wynik:
Jeśli nie chcesz lub nie możesz dodać obraz względnej ścieżki, po prostu wstaw nazwę obrazu bez pełnej ścieżki:
<<your_image.png>>
W takim przypadku obraz musi znajdować się w katalogu project/docs.
Jak wyjaśniono w tym wątku, do którego odwołuje się lista adresowa, jedną z opcji jest użycie data URL do wstawiania obrazów do dokumentacji. To sprawia, że samo źródło jest nieco nieprzyjemne w czytaniu (ponieważ jest przeplatane dużymi blokami danych zakodowanych w 64-bitowym kodowaniu), chociaż użycie Haddock'a może pomóc w umieszczeniu wszystkich obrazów w nazwanych fragmentach na końcu pliku. Przykład takiego podejścia można znaleźć w artykule Haddock documentation for the circle-packing package.
To dziwne, że nie powinno ci pozwolić na odwoływanie się do plików danych w twoim pakiecie Cabal. o_o –
Nie sądzę, że Haddock wie cokolwiek o Cabal lub nawet ghc-pkg, prawda? – Dag
Sztuczka URL danych jest całkiem schludna. To może naprawić problemy z wydajnością, które pobieramy z wiki w 'soczewce'. (Zmieniliśmy linki w pliku 'lens.cabal', aby wskazywały na' imgur', ponieważ nie ma problemów z wyłączaniem pamięci podręcznej). –
Jak wyjaśniono w a blog post by Ian Ross można użyć opcji cabal extra-doc-files, aby zawiązać dodatkowe pliki w dokumentacji.
Nie mogę znaleźć żadnego sposobu na zhakowanie tego, aby uzyskać względną ścieżkę, chociaż jest to krucha, ponieważ zakłada katalog, w którym dokumentacja będzie używana na dysku użytkownika. Dobrze? – amindfv
Tak, masz rację. Jeśli nie możesz uzyskać względnej ścieżki do swoich obrazów, możesz również dodać tylko '' '<< Haskell-Logo-Variation.png >>' '', a obraz Haskell-Logo-Variation.png musi znajdować się w projekcie katalog doc. – 0xAX
Idealny! Tego właśnie szukałem. Czy możesz dodać to do swojej odpowiedzi? Zwróć też uwagę, że jeśli Twój obraz znajduje się w 'docs/images /', możesz odwoływać się do niego za pomocą '<< images/some_img.jpg >>' – amindfv