doc.transformers.se_tpb_imageConverter.html Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pipeline1-adapter Show documentation
The newest version!



	
		
		se_tpb_imageConverter
		
	
	
		Transformer documentation: se_tpb_imageConverter
		
		
		
			
				
					Transformer Purpose
				
				
					Input Requirements
				
				
					Output
					
						
							On success
						
						
							On error
						
					
				
				
					Configuration/Customization
					
						
							Parameters (tdf)
						
						
							Extended configurability
						
					
				
				
					Further development
				
				
					Dependencies
				
				
					Author
				
				
					Licensing
				
			
		
		Transformer Purpose
		This transformer converts images associated with an xml document and updates any references made to the converted images in the xml document.
		Input Requirements
		An xml document.
		Output
		On success
		A modified xml document containing updated references together with the linked images and any additional resources found in the folder containing the source document.
		On error
		
		A partly modified file set. Some images may not have been converted.
		Configuration/Customization
		Parameters (tdf)
		
		
			input
			The input file
			output
			The output directory
			converter
			Path to executable. Leave blank to use ImageMagick
			arguments
			String of arguments that should be past to the executable. Use the place holders below to specify where the image's input and output path should be inserted
			extension
			Set the output file extension (ImageMagick uses the extension to specify the image format)
			placeholderInput
			The substring in the arguments string that should be replaced by the image input path. May not contain whitespace
			placeholderOutput
			The substring in the arguments string that should be replaced by the image output path. May not contain whitespace
			lookForTag
			Name of the tag that contains an image reference attribute (see below)
			lookForAttribute
			Name of the attribute that contains an image reference
		
		Extended configurability
		The path to ImageMagick can be set using the pipeline user properties. Set the "pipeline.imageMagick.converter.path" to the path to imageMagick's convert.exe.
		
		Further development
		Additional resources in subdirectories could be copied to output.
		
		Dependencies
		
		ImageMagick
		Author
		
		Joel Håkansson, TPB
		Licensing
		
		LGPL