This task explains how to check out a module (short-term) for editing in Arbortext Editor.
Before you begin
SDL Contenta Web clients only: The Contenta Editor Extensions and the Contenta S1000D Arbortext Editor plug-in must be installed on your client.
SDL Contenta Web clients only: In the top banner of your desktop, click Preferences to specify a path to your checkout directory.
SDL Contenta Web clients only: SDL Contenta Web clients that have Arbortext Editor installed on them support both long-term and short-term editing cycles. A long-term checkout is required when Arbortext Editor is not installed on your SDL Contenta Web client.
If Arbortext Editor is not installed on your client, see Checking out a module for editing long term.
Note: SDL Contenta Web clients: If Arbortext Editor is not installed on your client, an administrator may want to remove the Arbortext (short term) web tool from your Contenta toolbox. If Arbortext Editor is not installed on any web clients at your site, an administrator may decide to remove the Arbortext web tool altogether, since in this case all users must use the long-term Arbortext Check Out and Arbortext Check In web tools.
About this task
With short-term checkout and checkin, the module is exported to the checkout directory where you edit it in Arbortext Editor. When you close the document in Arbortext, you are presented with the available checkin options.
If the module you check out contains references to other modules, the referenced objects are not checked out at the same time.
Note: A lock is placed on the selected object when it is checked out and removed when the object is checked in.
Note: If using a later maintenance level of Arbortext Editor than the one with which SDL Contenta S1000D was built and qualified with our styles, you may see a warning that one or more modules in style file <path and filename> is out of date. Ok to update? the first time you use it. This is an Arbortext Editor prompt to update the styles. Update the styles by clicking YES through the Arbortext Editor dialogs. After updating the styles no more warnings are displayed next time Arbortext Editor is launched.
Procedure
- In SDL Contenta S1000D, navigate to the DM, PM, or SCPM that you want to edit.
- Click Tools, then click Arbortext.
- If your module contains graphics, you may be asked if you want to export them. Respond as you deem appropriate. See Exporting and displaying graphics when you check out a module.
Note: If you check Do not prompt me again, your graphics export preference will be saved, and you will not be asked if you want to export graphics the next time you check out a module for editing.
Note: SDL Contenta Web clients only: If you decline to use the Applet, graphics are not exported. Only the XML module is exported. (The Applet is required to transfer multiple files.)
In most cases, Arbortext Editor launches automatically and you can skip the next step.
- If Arbortext did not launch automatically (for example, Arbortext Editor is not installed on your SDL Contenta Web client, or the launchArbortext AppData setting is set to no): From your checkout directory, open the module in Arbortext Editor.
- Edit the module in Arbortext then save it.
- Close the module in Arbortext.
- SDL Contenta Explorer clients only: When prompted Do you want to check in this document? click Yes or No.
If you clicked
Yes, click
OK to acknowledge the
Document is checked in successfully message.
If you clicked No, click OK to acknowledge the Object unlocked successfully message.
Skip the remaining steps in this procedure when using SDL Contenta Explorer.
The remaining steps in this procedure apply only to SDL Contenta Web clients.
- If you did not make any edits, you are prompted: The document was not modified. Do you want to undo checkout?
If you click
Yes, the module is not checked in to
SDL Contenta S1000D, and the lock is removed. Click
OK to acknowledge the
Object unlocked successfully message.
If you click No, nothing changes: The module remains in your checkout directory on the file system and it is locked in SDL Contenta.
- If you made edits, you are prompted if you want to Check in this document, Save this document and check it in later, or Discard edits and undo checkout.
If you click
Check in this document, the module is checked in to
SDL Contenta, the lock is removed, and the checkout directory is removed when possible. Click
OK to acknowledge the
Document is checked in successfully message.
If you click Save this document and check it in later, your module is saved in the checkout directory. Manually open Arbortext Editor to continue editing this module. The next time you save and exit, your web session may have timed out. If timed-out, SDL Contenta prompts for your credentials.
If you click Discard edits and undo checkout, the module is not checked in to SDL Contenta, and the lock is removed. Click OK to acknowledge the Object unlocked successfully message.
- If you see a Delete: remove_file path-of-checkout-directory: permission denied error, click OK to acknowledge the message.
This error may occur when it is not possible to remove the checkout directory on the client. For example, this directory cannot be removed if a user navigates to it, to open Arbortext Editor then subsequently selects either Check in this document or Discard edits and undo checkout.
Files to be deleted must be moved out of the document checkout directory before the directory can be removed. These files are moved to a folder named
S1000D_MarkedForDelete, located directly under the main checkout directory.
Tip: System administrators should periodically clean the S1000D_MarkedForDelete folder.