[DOCU-205] Convert Technical Guide to wiki markup Created: 02/Sep/11  Updated: 29/Sep/11  Resolved: 29/Sep/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   

Convert Technical Guide chapters on documentation site from HTML paragraphs to wiki paragraphs.

Add {toc} to each chapter.

Download images from their Google Docs URLs and rename them so they are understandable. Upload the images to DMS, creating a DMS folder for each chapter.

These chapters are already converted to wiki markup:

  • Content storage and structure
  • Configuration mechanisms
  • Import and export

You won't be able to replicate every HTML formatting convention with wiki markup but use common sense and mimic what you can.



 Comments   
Comment by Ruth Stocks [ 19/Sep/11 ]

Notes:

  • General
    • On pages where the introductory paragraph ends with a bulleted list the toc looks a bit strange directly below it. Should I move it?
    • I have reduced the size of the very large images to 750px (width).
    • I can’t figure out how to include square brackets in the text (see points below).
  • templating page
    last line of page (table) ""Read on" message. i18n("key") should be ""Read on" message. i18n["key"]".
  • stk page
    • In the Contents section, the original text (last bulleted point) said "support for multilple site configurations". This is ETK and I replaced it with "Two fully functional demo sites". I have not changed any of the other content, but I think we should add an ETK page and make the distinction clearer.
    • In the Site Definition section, when you open the Demo features - Public instance link, the stage paragraph does not render correctly on a wide screen. Tested in Firefox and IE.
    • In the CSS configuration section, the bulleted list should ideally be a numbered list.
  • I18n page
    I think we should update to include a section on Content translation support.
  • Workflow page
    In the Accessing dialog fields section, the "test" example should ideally be a numbered list.
  • VirtualURIMapping page
    In the Classes - Regular expressions section, I removed square brackets in the text to facilitate rendering in two instances. The third paragraph should read "[0-9A-Z] in fromURI means "any single character in the range of 0-9 or A-Z". The plus character makes this a greedy pattern that matches one or more of the preceding token, and will match as many characters as possible before satisfying the next token. By enclosing the pattern in parentheses we create a capturing group ([0-9A-Z]+) which can be referenced in the toURI using $1.
Generated at Mon Feb 12 01:06:55 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.