Tutor Method for Referring to Other

Documents

Copyright © Oracle Corporation, 2005. All rights reserved.

 Objectives

In this session you will learn how to:

• Format references to other documents
• Format links to other documents

2 Copyright © Oracle Corporation, 2005. All rights reserved.

 Agenda

• Referring to other documents

– External References for Publisher reports
• Links to Tutor documents
• Links to Application Help documents
– Basic Syntax
– Target syntax
• HTML links to non Tutor documents
• HTML quick links in Tutor documents
• HTML flowchart links

3 Copyright © Oracle Corporation, 2005. All rights reserved.

 Referring to Other Documents

As you create a procedure, you may wish to reference

other documents that may be useful to the actors
performing the tasks. Common references are to:
• Other Procedures from the Scope, Policy, Activity
Preface, or Tasks section
• Help Files or Navigations from the Task section
only
• Forms from the Policy, Activity Preface or Tasks
section
• Reference documents from the Policy, Activity
Preface or Task section

4 Copyright © Oracle Corporation, 2005. All rights reserved.

 Format for referring to other Tutor documents
(for Publisher Reports)
External references use the following format:
• List the document title followed by the filename
• Enclose the filename in brackets [ ]
• Italicize the document title, filename, and brackets [ ]

title of the other document Filename

5 Copyright © Oracle Corporation, 2005. All rights reserved.

 Linking to Other Tutor Documents

• Linking to other Tutor documents builds on the

external reference format for Publisher reports
• There are two ways to format links to other Tutor
documents.
– Use "basic syntax" if HTML documents will be
accessed from:
Oracle Files
Any web or file server
– Use "target syntax" if HTML documents will be
accessed from:
Oracle Applications Online Help

6 Copyright © Oracle Corporation, 2005. All rights reserved.

 Basic Syntax to Link External References

To create links to other Tutor HTML documents

• Use the same format and syntax as for Publisher reports
• Underline the entire “external reference”

title of the other document Filename

7 Copyright © Oracle Corporation, 2005. All rights reserved.

 Format for referring to other Tutor documents
(for files residing in Online Help)

External references to other Tutor HTML files in Online

Help use the following format:
• List the document title followed by the target
• Enclose the target in brackets [ ]
• Italicize the document title, target, and brackets [ ]
• Underline the entire reference

Refer to Creating a Purchase Order [../FND/@PRO1182Y]

title of the other document Target = Directory/@Filename

8 Copyright © Oracle Corporation, 2005. All rights reserved.

 Referring to Application Help Documents

References to Application Help documents

• Appear below a System Reference (Box Text)
• Begin with 'Refer to'
• Are formatted with the Note style

9 Copyright © Oracle Corporation, 2005. All rights reserved.

 Target Syntax to Link to Application Help
Files

If procedures are to reside inside the Help database,

you must use the following format and syntax for the
references and links to resolve properly:

Module Name

Menu Path

Screen Name

Help Document Title DIR for Help Target

the Oracle Module
e.g. AP, GL, PER...

10 Copyright © Oracle Corporation, 2005. All rights reserved.

 Review - Linking Format and Syntax

Files residing OUTSIDE of the Online Help database

• Use 'basic syntax', italicise and underline the reference
Refer to <DocTitle> [Filename]
Files residing INSIDE the Online Help database:
• Use 'target syntax', italicise and underline the reference
Refer to <DocTitle> [../DIR/@Filename/Target]

Document Name DIR Document Target

always =../FND/
for Tutor docs

11 Copyright © Oracle Corporation, 2005. All rights reserved.

 HTML Links

12 Copyright © Oracle Corporation, 2005. All rights reserved.

 HTML Links to Non-Tutor Documents

It is possible to create links to non-Tutor documents

Examples:

13 Copyright © Oracle Corporation, 2005. All rights reserved.

 HTML Quick Links

14 Copyright © Oracle Corporation, 2005. All rights reserved.

 HTML Flowchart Links

• Link to an external
Tutor document
• Link to an
internal task
• Link to an internal
system reference

15 Copyright © Oracle Corporation, 2005. All rights reserved.

 Review - External References and Links

For External References (for Publisher Reports)

• List the title and file name
• Put brackets [ ] around file name
• Italicize the document title, file name, and brackets [ ]
For links in HTML versions
• Underline the external reference (include the brackets)
Document Title [PRO12345] (basic
syntax)
OR
Document Title [../FND/@PRO12345]
(target syntax)

16 Copyright © Oracle Corporation, 2005. All rights reserved.

 Quick Quiz: True / False

1. External references are identified by Publisher

2. External references must show the file name in
parenthesis ( )
3. Tutor HTML documents can link to any document
or URL
4. Links are created by bolding the external reference
5. The HTML Quick Link list is based on the Qualifier
style
6. The HTML procedure flowchart hyperlinks to
internal text only

17 Copyright © Oracle Corporation, 2005. All rights reserved.

 Summary

In this lesson you should have learned how to:

• Format references to other documents
• Format links to other documents

18 Copyright © Oracle Corporation, 2005. All rights reserved.