8/8/2019 EDU020TR

1/18

Copyright Oracle Corporation, 2005. All rights reserved.

Tutor Method for Referring to OtherDocuments

8/8/2019 EDU020TR

2/18

2 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

8/8/2019 EDU020TR

3/18

3 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

8/8/2019 EDU020TR

4/18

4 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:

OtherProcedures from the Scope, Policy, ActivityPreface, or Tasks section

Help Files orNavigations from the Task section

only

Forms from the Policy, Activity Preface or Tasks

section

Reference documents from the Policy, Activity

Preface or Task section

8/8/2019 EDU020TR

5/18

5 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

8/8/2019 EDU020TR

6/18

6 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 beaccessed from:

Oracle Applications Online Help

8/8/2019 EDU020TR

7/18

7 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

8/8/2019 EDU020TR

8/18

8 Copyright Oracle Corporation, 2005. All rights reserved.

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 toC

reat

inga

Purcha

se Order [../FND

/@PR

O1182Y]

Format for referring to other Tutor documents

(for files residing in Online Help)

title of the other document Target = Directory/@Filename

8/8/2019 EDU020TR

9/18

9 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

8/8/2019 EDU020TR

10/18

10 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

the Oracle Module

e.g. AP, GL, PER...

Help Target

8/8/2019 EDU020TR

11/18

11 Copyright Oracle Corporation, 2005. All rights reserved.

Document Name DIR

always =../FND/

for Tutor docs

Document Target

Review - Linking Format and Syntax

Files residing OUTSIDE of the Online Help database

Use 'basic syntax', italicise and underline the reference

Refer to [Filename]

Files residing INSIDE the Online Help database: Use 'target syntax', italicise and underline the reference

Refer to [../DIR/@Filename/Target]

8/8/2019 EDU020TR

12/18

12 Copyright Oracle Corporation, 2005. All rights reserved.

HTML Links

8/8/2019 EDU020TR

13/18

13 Copyright Oracle Corporation, 2005. All rights reserved.

HTML Links to Non-Tutor Documents

It is possible to create links to non-Tutor documents

Examples:

8/8/2019 EDU020TR

14/18

14 Copyright Oracle Corporation, 2005. All rights reserved.

HTML Quick Links

8/8/2019 EDU020TR

15/18

15 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

8/8/2019 EDU020TR

16/18

8/8/2019 EDU020TR

17/18

17 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 documentor 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

8/8/2019 EDU020TR

18/18

18 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