Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.1
    • Labels:
      None
    • Environment:
      Ubuntu Feisty

      Description

      I noticed in the DBF documentation that there is a TODO item to not blindly copy images. Would an acceptable solution be to add an 'includesfile' to the fileset for the copy task for images based on the target (and if desirable on the type)? For example, for the 'pdf' type of the 'manual' target there could be a file called manual.pdf.image.includes that would specify which images to include/exclude. I haven't tested the behavior of the includesfile attribute much, so it may be necessary to have a default includesfile with "images/**".

      1. default_imageincludes.txt
        0.0 kB
        Matthew Koch
      2. imageincludes.patch
        4 kB
        Matthew Koch

        Activity

        Hide
        Matthew Koch added a comment -

        Here's a sample patch for this issue. Change requires a file named docfile.type.imageincludes (ie. Manual.html.includes) in the base directory. Open to suggestions...

        Show
        Matthew Koch added a comment - Here's a sample patch for this issue. Change requires a file named docfile.type.imageincludes (ie. Manual.html.includes) in the base directory. Open to suggestions...
        Hide
        Matthew Koch added a comment -

        Update to previous patch. The includes files are now expected to be in the src/docbook/projectname directory with names akin to projectname.html.imageincludes. If the includes file does not exist, then a default.imageincludes is used from the dbf base directory.

        Show
        Matthew Koch added a comment - Update to previous patch. The includes files are now expected to be in the src/docbook/projectname directory with names akin to projectname.html.imageincludes. If the includes file does not exist, then a default.imageincludes is used from the dbf base directory.
        Hide
        Matthew Koch added a comment -

        oops, attached wrong file...

        Show
        Matthew Koch added a comment - oops, attached wrong file...
        Hide
        Matthew Koch added a comment -

        Real uploads this time. doh...

        Show
        Matthew Koch added a comment - Real uploads this time. doh...
        Hide
        Henning Schmiedehausen added a comment -

        This is a nice idea. Problem might be that now a docbook author must keep track which image to include where for all types of target media in multiple files. I will look into this over the weekend. Thanks for the patch.

        Show
        Henning Schmiedehausen added a comment - This is a nice idea. Problem might be that now a docbook author must keep track which image to include where for all types of target media in multiple files. I will look into this over the weekend. Thanks for the patch.
        Hide
        Henning Schmiedehausen added a comment -

        I think this patch is worth applying if it gets properly documented. Could you add a description "how it works" to the notes section of the manual? There is a section called "Referencing images", I could imagine a section "Selecting images for inclusion".

        As I understand your patch, this is strictly optional, so if I don't have a <foo>.images file, then the behaviour is as before, isn't it?

        Show
        Henning Schmiedehausen added a comment - I think this patch is worth applying if it gets properly documented. Could you add a description "how it works" to the notes section of the manual? There is a section called "Referencing images", I could imagine a section "Selecting images for inclusion". As I understand your patch, this is strictly optional, so if I don't have a <foo>.images file, then the behaviour is as before, isn't it?
        Hide
        Matthew Koch added a comment -

        Updated patch for extension change. Also, added a paragraph to the documentation explaining the includes file. By default (no project specific includes file) all images are included.

        Show
        Matthew Koch added a comment - Updated patch for extension change. Also, added a paragraph to the documentation explaining the includes file. By default (no project specific includes file) all images are included.
        Hide
        Henning Schmiedehausen added a comment -

        Patch applied with minor corrections. Thanks Matthew!

        Show
        Henning Schmiedehausen added a comment - Patch applied with minor corrections. Thanks Matthew!

          People

          • Assignee:
            Henning Schmiedehausen
            Reporter:
            Matthew Koch
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development