[DOCU-112] Import and export Created: 21/Jan/11  Updated: 29/Aug/11  Resolved: 29/Aug/11

Status: Closed
Project: Documentation
Component/s: content
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Antti Hietala Assignee: Antti Hietala
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:

 Description   

Document import and export options:

  • Usage scenarios: migrating content and configuration from another system, deploying to another environment, importing custom taxonomies... come up with more examples.
  • Write procedures for XML import/export with right-click and with command button.
  • Write procedures for Tools > Import and Tools > Export.
  • What repositories can export/import content from with the above methods?
  • What schema does the exported XML adhere to?
  • Packager module. When to use?
  • Groovy script. Write example script.
  • Custom Java class. Write example class or point to examples in SVN.

Resources:



 Comments   
Comment by Suzanne Deprez [ 29/Jun/11 ]

Changes were activated.

Comment by Antti Hietala [ 01/Jul/11 ]

Feedback:

File Formats

  • Headings: sentence case
  • File extensions: lower case.
  • Write full product name Magnolia CMS, not just Magnolia. (When writing about the company, use Magnolia International.)
  • "name of the file containing the XML reflects the path". Add an example.

Methods

  • "If a node or data is specified..." Why distinguish between node or data? Aren't data items also stored in nodes?
  • The AdminCentral subheading seems unnecessary here. Remove it and promote children to level 2.

Context menu

  • Heading: sentence case
  • "Importing XML can be initiated on the Website screen, Documents screen". Don't use the term screen. Refer to workspaces.
  • Use active voice. Go through the whole article and change phrasing of type "Importing a zip file can be initiated on the Documents screen" to "You can import a zip file into the dms workspace."
  • "RSS Agreegator". Typo.
  • "Exporting XML can be..." The same options are already explained above. Is something different?
  • Info box "If right-click is not on a node or data". Try something more colloquial such as "If you right-click the white space, all nodes in the tree will be exported."
  • "See the procedure for exporting using Tools > Export". Link to procedure.

Import tool

  • Explain when to use this tool rather than context-menu.
  • In step 6, explain the UUID options. What's the difference between remove and replace?

Export tool

  • What does the Format XML option do?

Content Translation tool

  • Already documented in Content Translation module article. Explain in the Import and Export article when to use this tool and link to the module article for procedures. No need to duplicate. The Google Spreadsheet option is missing from the module article, please add.
  • "when exported spreadsheet is opened in Google Documentation." The product is Google Docs.

Packager

Scripting

  • Cool!
  • Link to Groovy module article.
  • Link to DataTransporter Javadoc. Use javadoc macro.

Programmatically

  • executeExport: use fixed-width font in method names
  • "The Data and Content Translation Support modules contain commands". Use normal font in module names.

Usage

  • Rename section to "Use cases"

Documentation transfer

  • Not sure if "documentation" is the right term here. It usually refers to user documentation (manuals, help). Is that what you have in mind? Maybe you mean DMS assets in general?

Site migration

  • Format as bulleted list.

Importing tags

  • "To easily add a tag..." This sounds like a more complicated way to add a tag than just adding it through the UI. What makes it easier is volume. Explain a scenario where the user might want to import a whole taxonomy, such as a controlled vocabulary.
Comment by Suzanne Deprez [ 07/Jul/11 ]

In the File Formats section I left the first character of a file extension as uppercase when it starts a sentence. Let me know if that needs to change.

I left XML uppercase in situation in which AdminCentral UI has it as uppercase for a selection.

Added anchor for export-tool section to get link to the procedure within page (under Context menu) to work.

With respect to the comment about Format XML, that is included in the Info below the procedure. Does that need more?

Did you want Google Spreadsheet added to Import and Export or to Content Translation Support documentation?

I made some modifications to the Packager module in order to insert procedures I moved from Import and export. Also moved images to Packager.

Comment by Antti Hietala [ 18/Jul/11 ]
  • File name extensions: Starting a sentence with upper case initial is correct. However, not all occurrences of three-letter abbreviations in that paragraph refer to file name extensions. For example, "When used to export data, the xml structure reflects the hierarchy of the data". Should write XML since you are writing specifically about the markup language structure.
  • AdminCentral unfortunately is not a great guide to spelling. Try to apply Documentation Style Guide conventions first and MSTP second.
  • "Added anchor for export-tool section". Great.
  • "Format XML". OK.
  • "Google Spreadsheet". Add to Content Translation Support module article. Screenshot there needs updating too.
  • "Packager". -I'm working on Packager article. Thanks.- Packager article revised
Comment by Suzanne Deprez [ 21/Jul/11 ]

I went through again and I believe all of the xml references are referencing the file format/structure/language including "name of the file containing the XML reflects the path". I changed most of them back to XML although there were a couple that I felt could be interpreted as an extension or were a different case in the UI.

Checked spellings mentioned in Documentation Style Guide and MSTP and made some changes. Let me know of any I missed.

Made and activated changes for Content Translation Support.

Comment by Suzanne Deprez [ 25/Jul/11 ]

Activated changes import-export and children. Created subpages for Methods and Use cases due to length of page.

Generated at Mon Feb 12 01:06:02 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.