How to edit the plain text from sdlxliff in Batch Task context

Andrea-Melinda Ghisa — Wed, 18 Jul 2018 07:36:12 GMT

Current Revision posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 7/18/2018 7:36:12 AM

In this page we'll explain how to edit an sdlxliff from selected project in Batch Task plugin context. Like in previous documentation we'll also use Project Anonymizer plugin for code example. Full source code of the project can be found here .

When we want to edit an sdlxliff file we need a BilingualProcessor.

How to create a Bilingual Processor

1. Create a new class which inherits AbstractBilingualContentProcessor class.

2. Override ProcessParagraphUnit() method.

gist.github.com/.../ee31598f79f5f51974a59eb0d042998c

Once we created the processor we need to add it to IMultiFileConverter object from ConfigureConverter method.

gist.github.com/.../c98f4a6a557aad81523e65bef24e22b0

Please make sure you override OnFileComplete() method in your application. If you don't override this method your changes on the file will not be saved.

gist.github.com/.../f3a3a411691fab1a5d3af6bd7dc7e790

In the processor class appears following object SegmentVisitor(). In order to read the information from each segment you need implement visitor pattern.

How to implement Visitor Pattern

1. Create a class which implements IMarkupDataVisitor interface.

2. Create a method which receive an ISegment object as parameter like this:

gist.github.com/.../c5401bc1054e897a81065dedc59a47de

Where VisitChildren() has the following implementation:

gist.github.com/.../ed42a79e331d8b41c1acc1c8c7d28734

3. Call VisitChildren() from VisitSegment() method like this:

gist.github.com/.../0174e4bdab7dbebccfecf6b912869a65

4. The last step is to add a implementation to VisitText() method. This method is fired automatically when we have a text in the segment.

gist.github.com/.../f4ae453d285792b2549d6e729e2d4658

More logic should be added in your implementation which will fit your needs. In the above example for each segment from your file will contains only this "New text we add to segment".

Tags: batch task, Studio Documentation, Studio API

How to edit the plain text from sdlxliff in Batch Task context

Andrea-Melinda Ghisa — Wed, 18 Jul 2018 07:33:27 GMT

Revision 9 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 7/18/2018 7:33:27 AM

When we want to edit an sdlxliff file we need a BilingualProcessor.

How to create a Bilingual Processor

1. Create a new class which inherits AbstractBilingualContentProcessor class.

2. Override ProcessParagraphUnit() method.

gist.github.com/.../ee31598f79f5f51974a59eb0d042998c

Once we created the processor we need to add it to IMultiFileConverter object from ConfigureConverter method.

gist.github.com/.../c98f4a6a557aad81523e65bef24e22b0

Please make sure you override OnFileComplete() method in your application. If you don't override this method your changes on the file will not be saved.

gist.github.com/.../f3a3a411691fab1a5d3af6bd7dc7e790

In the processor class appears following object SegmentVisitor(). In order to read the information from each segment you need implement visitor pattern.

How to implement Visitor Pattern

1. Create a class which implements IMarkupDataVisitor interface.

2. Create a method which receive an ISegment object as parameter like this:

public void VisitTextMethod(ISegment segment)
{
VisitChildren(segment);
}

Where VisitChildren() has the following implementation:

private void VisitChildren(IAbstractMarkupDataContainer container) { if (container == null) return; foreach (var item in container.ToList()) { item.AcceptVisitor(this); } }

3. Call VisitChildren() from VisitSegment() method like this:

public void VisitSegment(ISegment segment) { VisitChildren(segment); }

4. The last step is to add a implementation to VisitText() method. This method is fired automatically when we have a text in the segment.

public void VisitText(IText text)
{

text.Properties.Text = "New text we add to segment"

}

More logic should be added in your implementation which will fit your needs. In the above example for each segment from your file will contains only this "New text we add to segment".

Tags: batch task, Studio Documentation, Studio API

How to edit the plain text from sdlxliff in Batch Task context

Andrea-Melinda Ghisa — Fri, 27 Apr 2018 13:50:54 GMT

Revision 8 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/27/2018 1:50:54 PM

When we want to edit an sdlxliff file we need a BilingualProcessor.

How to create a Bilingual Processor

1. Create a new class which inherits AbstractBilingualContentProcessor class.

2. Override ProcessParagraphUnit() method.

public override void ProcessParagraphUnit(IParagraphUnit paragraphUnit)
{
base.ProcessParagraphUnit(paragraphUnit);
if (paragraphUnit.IsStructure) { return; }

foreach (var segmentPair in paragraphUnit.SegmentPairs.ToList())
{
var segmentVisitor = new SegmentVisitor();
segmentVisitor.VisitTextMethod(segmentPair.Source);
}
}

Once we created the processor we need to add it to IMultiFileConverter object from ConfigureConverter method.

protected override void ConfigureConverter(ProjectFile projectFile, IMultiFileConverter multiFileConverter)
{
multiFileConverter.AddBilingualProcessor(new BilingualContentHandlerAdapter(new YourCustomProcessor()));
}

Please make sure you override OnFileComplete() method in your application. If you don't override this method your changes on the file will not be saved.

public override bool OnFileComplete(ProjectFile projectFile, IMultiFileConverter multiFileConverter)
{
return true;
}

In the processor class appears following object SegmentVisitor(). In order to read the information from each segment you need implement visitor pattern.

How to implement Visitor Pattern

1. Create a class which implements IMarkupDataVisitor interface.

2. Create a method which receive an ISegment object as parameter like this:

public void VisitTextMethod(ISegment segment)
{
VisitChildren(segment);
}

Where VisitChildren() has the following implementation:

private void VisitChildren(IAbstractMarkupDataContainer container) { if (container == null) return; foreach (var item in container.ToList()) { item.AcceptVisitor(this); } }

3. Call VisitChildren() from VisitSegment() method like this:

public void VisitSegment(ISegment segment) { VisitChildren(segment); }

4. The last step is to add a implementation to VisitText() method. This method is fired automatically when we have a text in the segment.

public void VisitText(IText text)
{

text.Properties.Text = "New text we add to segment"

}

More logic should be added in your implementation which will fit your needs. In the above example for each segment from your file will contains only this "New text we add to segment".

Tags: batch task, Studio Documentation, Studio API

How to edit the plain text from sdlxliff in Batch Task context

Andrea-Melinda Ghisa — Fri, 27 Apr 2018 13:22:28 GMT

Revision 7 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/27/2018 1:22:28 PM

When we want to edit an sdlxliff file we need a BilingualProcessor.

How to create a Bilingual Processor

1. Create a new class which inherits AbstractBilingualContentProcessor class.

2. Override ProcessParagraphUnit() method.

Once we created the processor we need to add it to IMultiFileConverter object from ConfigureConverter method.

Please make sure you override OnFileComplete() method in your application. If you don't override this method your changes on the file will not be saved.

public override bool OnFileComplete(ProjectFile projectFile, IMultiFileConverter multiFileConverter)
{
return true;
}

In the processor class appears following object SegmentVisitor(). In order to read the information from each segment you need implement visitor pattern.

How to implement Visitor Pattern

1. Create a class which implements IMarkupDataVisitor interface.

2. Create a method which receive an ISegment object as parameter like this:

public void VisitText(ISegment segment)
{
VisitChildren(segment);
}

Where VisitChildren() has the following implementation:

private void VisitChildren(IAbstractMarkupDataContainer container) { if (container == null) return; foreach (var item in container.ToList()) { item.AcceptVisitor(this); } }

3. Call VisitChildren() from VisitSegment() method like this:

public void VisitSegment(ISegment segment) { VisitChildren(segment); }

4. The last step is to add a implementation to VisitText() method. This method is fired automatically when we have a text in the segment.

public void VisitText(IText text)
{

text.Properties.Text = "New text we add to segment"

}

More logic should be added in your implementation which will fit your needs. In the above example for each segment from your file will contains only this "New text we add to segment".

Tags: batch task, Studio Documentation, Studio API

How to edit the plain text from sdlxliff in Batch Task context

Andrea-Melinda Ghisa — Fri, 27 Apr 2018 13:15:13 GMT

Revision 6 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/27/2018 1:15:13 PM

When we want to edit an sdlxliff file we need a BilingualProcessor.

How to create a Bilingual Processor

1. Create a new class which inherits AbstractBilingualContentProcessor class.

2. Override ProcessParagraphUnit() method.

Once we created the processor we need to add it to IMultiFileConverter object from ConfigureConverter method.

Please make sure you override OnFileComplete() method in your application. If you don't override this method your changes on the file will not be saved.

public override bool OnFileComplete(ProjectFile projectFile, IMultiFileConverter multiFileConverter)
{
return true;
}

In the processor class appears following object SegmentVisitor(). In order to read the information from each segment you need implement visitor pattern.

How to implement Visitor Pattern

1. Create a class which implements IMarkupDataVisitor interface.

2. Create a method which receive an ISegment object as parameter like this:

public void VisitText(ISegment segment)
{
VisitChildren(segment);
}

Where VisitChildren() has the following implementation:

private void VisitChildren(IAbstractMarkupDataContainer container) { if (container == null) return; foreach (var item in container.ToList()) { item.AcceptVisitor(this); } }

Tags: batch task, Studio Documentation, Studio API

How to edit the plain text from sdlxliff in Batch Task context

Andrea-Melinda Ghisa — Fri, 27 Apr 2018 13:08:08 GMT

Revision 5 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/27/2018 1:08:08 PM

When we want to edit an sdlxliff file we need a BilingualProcessor.

How to create a Bilingual Processor

1. Create a new class which inherits AbstractBilingualContentProcessor class.

2. Override ProcessParagraphUnit() method.

Once we created the processor we need to add it to IMultiFileConverter object from ConfigureConverter method.

Please make sure you override OnFileComplete() method in your application. If you don't override this method your changes on the file will not be saved.

public override bool OnFileComplete(ProjectFile projectFile, IMultiFileConverter multiFileConverter)
{
return true;
}

Tags: batch task, Studio Documentation, Studio API

How to edit the plain text from sdlxliff in Batch Task context

Andrea-Melinda Ghisa — Fri, 27 Apr 2018 12:58:19 GMT

Revision 4 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/27/2018 12:58:19 PM

When we want to edit an sdlxliff file we need a BilingualProcessor.

How to create a Bilingual Processor

1. Create a new class which inherits AbstractBilingualContentProcessor class.

2. Override ProcessParagraphUnit() method.

Tags: batch task, Studio Documentation, Studio API

How to edit an sdlxliff from a Batch Task

Andrea-Melinda Ghisa — Fri, 27 Apr 2018 12:51:36 GMT

Revision 3 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/27/2018 12:51:36 PM

When we want to edit an sdlxliff file we need a BilingualProcessor.

Tags: batch task, Studio Documentation, Studio API

How to edit an sdlxliff from a Batch Task

Andrea-Melinda Ghisa — Fri, 27 Apr 2018 12:48:11 GMT

Revision 2 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/27/2018 12:48:11 PM

Tags: batch task, Studio Documentation, Studio API

How to edit an sdlxliff from a Batch Task

Andrea-Melinda Ghisa — Mon, 23 Apr 2018 11:42:06 GMT

Revision 1 posted to Studio Developers WIKI by Andrea-Melinda Ghisa on 4/23/2018 11:42:06 AM

Tags: batch task, Studio Documentation, Studio API