Reviewers: ,
Description:
CG: Add hints about using/adding images
This is somewhat sketchy, but I can't afford to make this more thorouh
ATM.
Please review this at https://codereview.appspot.com/61540043/
Affected files (+25, -0 lines):
M Documentation/contributor/doc-work.itexi
M Documentation/contributor/website-work.itexi
Index: Documentation/contributor/doc-work.itexi
diff --git a/Documentation/contributor/doc-work.itexi
b/Documentation/contributor/doc-work.itexi
index
55c51bddaf008f8ee63564f986188786b9f02ac9..9d24c1ace7304a9b442ad26ae5e21a40901d2ba9
100644
--- a/Documentation/contributor/doc-work.itexi
+++ b/Documentation/contributor/doc-work.itexi
@@ -1080,6 +1080,7 @@ ensures that all such characters appear in all output
formats.
* Books::
* Section organization::
* Checking cross-references::
+* Adding/using images::
* General writing::
* Technical writing style::
@end menu
@@ -1300,6 +1301,19 @@ might not accurately reflect the current state of
the docs.
@uref{http://kainhofer.com/~lilypond/linkdoc/}
@end example
+@node Using images
+@subsection Using/adding images
+
+Images are referenced through a number of commands like
+@code{@@imageFloat}. Please refer to the existing material for
+examples (as there currently isn't the time to describe
+this in detail here). Please note: If you want to add
+new images to the documentation or website they have to
+be present in the @var{Documentation/pictures} directory,
+and your patch must add them to the Git repository.
+Otherwise @code{make doc} will fail. If you want to make
+an image available for the website it has also to be
+present in the @ref{lilypond-extra} repository.
@node General writing
@subsection General writing
Index: Documentation/contributor/website-work.itexi
diff --git a/Documentation/contributor/website-work.itexi
b/Documentation/contributor/website-work.itexi
index
3136c1b144ca0864449d8ad3003b65df252dc548..283d3088c5a4954887c4cbab3803bd2dd7a1fe6a
100644
--- a/Documentation/contributor/website-work.itexi
+++ b/Documentation/contributor/website-work.itexi
@@ -46,6 +46,17 @@ from @file{.bib} files; formatting is done automatically
by
@file{texi-web.bst}.
@item
+If you want to add new images to the website you will have to add
+them to the @ref{lilypond-extra}. There is a @var{pictures}
+directory where images to be used on the website are located, and
+a @var{pictures-src} directory where you can place source files
+that may be used to generate updated or translated versions of
+images. Note that any images have to be present twice: in
+@var{lilypond-extra} for use in the website and in
+@var{Documentation/pictures} for use in the manuals, see
+@ref{Using images}.
+
+@item
@dots{}
@item
_______________________________________________
lilypond-devel mailing list
lilypond-devel@gnu.org
https://lists.gnu.org/mailman/listinfo/lilypond-devel
