docs icon indicating copy to clipboard operation
docs copied to clipboard

Extend documentation on `ditafileset`

Open jelovirt opened this issue 3 years ago • 3 comments

Description

Extend <ditafileset> documentation to cover undocumented attributes.

Possible Solution

The following attributes are supported by the implementation

  • @input = true | falsetrue for start document, false for others; defaults to false
  • @inputResource = true | falsetrue for resources files (--resource in CLI), false for others; defaults to false
  • @conref = true | falsetrue for documents that use conref, false for others; defaults to false
  • @processingRole = resource-only | normalresource-only for documents references as resource only, normal for normal references; defaults to any.

Potential Alternatives

None

Additional Context

Example uses can be found from e.g. build_preprocess_template.xml or build_preprocess2_template.xml.

jelovirt avatar May 12 '21 05:05 jelovirt

@infotexture Has there been any discussion in separating Ant script docs into a separate reference? We have

  • <ditafileset> is our custom resource collection that allows choosing files based on file metadata from Job configuration. It can be used in our custom modules but also with Ant built-in tasks like <copy> or <pathconvert>.

  • <pipeline> that's documented in fragments like release notes and coding conventions, but not as a reference.

    The pipeline task is basically a wrapper around out custom modules and it was added ages ago. In many cases we could change the code and just have the module configuration alone, but it allows use the group modules and e.g. use <xslt> element which is a reserved element name by Ant's built-in tasks.

  • <module> which is only used with <pipeline> and calls custom or built-in modules, like XsltModule. I don't know if we should list all modules or just those that are general purpose.

jelovirt avatar May 13 '21 06:05 jelovirt

Has there been any discussion in separating Ant script docs into a separate reference?

@jelovirt Not that I recall.

Since the dita command was introduced in DITA-OT 2.0, there's been less focus on Ant scripting in the docs. I'm not necessarily opposed to adding this sort of information, but I'd need more input, as I haven't used Ant in years.

infotexture avatar May 17 '21 20:05 infotexture

These are not about calling DITA-OT with Ant directly. These are basically plug-in developer reference info. The kind of stuff you write in your custom plug-in's build.xml to process temporary files etc.

jelovirt avatar May 20 '21 12:05 jelovirt