Helpdesk‘s Adviser BlackBox Developers Meeting 12.10.2014Version: FinalPage 1 Helpdesk‘s Adviser...

11.04.23 Version: Final

Helpdesk‘s AdviserBlackBox DevelopBlackBox Developersers Meeting Meeting

Helpdesk‘s AdviserHelpdesk‘s Adviser

Helmut Zinn

IG-Metall

Abt. Informationssysteme

60519 Frankfurt am Main

Germany

Email: [email protected]



1.1 The 1.1 The SStarting tarting PPointoint

1. Questions and 1. Questions and AAnswersnswers

There are a lot of questions at the helpdesk

Most of them have already been solved in the past

Where are these solutions?

How can we find them quickly?



1.2 The 1.2 The CCollectionsollections


A document consists of one question and its answer

Documents are grouped by topic

Each group of documents is stored in a separate folder

A table of contents is created for each topic



1. Questions and answers 1. Questions and answers

1.3 And the Folder Structure1.3 And the Folder Structure

B a ck1B a ck2B a ck3

...

B a ckup

E m ail1E m ail2E m ail3

...

E m a il

N e tw 1N e tw 2N e tw 3

...

N e tw o rk

P r in t1P r in t2P r in t3

...

P rin te r

V m s1V m s2V m s3

...

V m s

U h lU sers H e lp L ine

Solutions

Topics



1.4 The 1.4 The SStarting tarting PPageage




1.5 The 1.5 The TToolsools

1.1. Questions and Questions and AAnswersnswers

BlackBox is used for document browsing & editing

It is extended with the following modules:

InfoCmds DesktopSetup

DosCmds

InfoRefIndex (build) & InfoRefLook (use) InfoSearch & InfoLinkCheck

HtmlExporter, HtmlImporter & HtmlTags HtmlTranslate (AllToHtml, AllToOdc, FixOdcLink)



2.1 Links2.1 Links

2. How to 2. How to OOrganize rganize IIt?t?

Links in BlackBox can be used to open documents in two different modes:

open a document in browser mode

<StdCmds.OpenBrowser(‘Uhl/Backup/Back1’, ‘Back1')>Device already allocated<>

open a document in edit mode

<StdCmds.OpenDoc(‘Uhl/Backup/Back1’)>Device already allocated<>

We would like to have both possibilities for the link of our helpdesk's adviser documents:

the browser mode for using it

the edit mode for inserting new solutions



2.2 Specification of InfoCmds2.2 Specification of InfoCmds


DEFINITION InfoCmds;

IMPORT Dialog;

VAR rootPath: ARRAY 256 OF CHAR;

PROCEDURE OpenDoc (IN file: ARRAY OF CHAR);

PROCEDURE SetBrowserMode;

PROCEDURE SetBrowserModeGuard (VAR par: Dialog.Par);

PROCEDURE SetEditMode;

PROCEDURE SetEditModeGuard (VAR par: Dialog.Par);

PROCEDURE OpenTopic (IN root: ARRAY OF CHAR);

END InfoCmds.



2.3 Implementation of InfoCmds2.3 Implementation of InfoCmds

2. How to organize it ?2. How to organize it ?

…

PROCEDURE OpenDoc* (IN file: ARRAY OF CHAR);

BEGIN

IF editable THEN

StdCmds.OpenDoc(file);

SetMarks;

ELSE

StdCmds.OpenBrowser (file, file);

END;

END OpenDoc;

…

and its use

<InfoCmds.OpenDoc(‘Uhl/Backup/Back1’)>Device already allocated<>



ServerBlackBox without the

development subsystem

ServerBlackBox without the

development subsystem Workstations

has only a shortcut to the program

BlackBox.exe on the server

Workstationshas only a shortcut to

the program BlackBox.exe on the

server

Master PCBlackBox including the development

subsystem

Master PCBlackBox including the development

subsystem

2.4 The 2.4 The LLocal ocal NNetworketwork

2. How to 2. How to OOrganizerganize I It?t?



2.5 Installations2.5 Installations


On the server BlackBox without the development subsystem Info subsystem Uhl folders Opens automatically the starting page

On the workstation Only a shortcut to the program BlackBox.exe on the server

On the master PC BlackBox including the development subsystem Info subsystem Uhl folders Persistent desktop



3.1 The World is always Changing3.1 The World is always Changing

3. Solution 3. Solution CChanges hanges aand nd UUpdates pdates

Every day there are a few new documents

Old documents are changing too

Some changes are not yet free for using

We need a program which find the change and can copy them



3.2 The 3.2 The UUpdate pdate PProgramrogram

3. Solution 3. Solution CChanges hanges aand nd UUpdatespdates



3.3 Sample 3.3 Sample OutputOutput of of CCompareompare




3.4 Sign3.4 Signss and and SSwitcheswitches


Compare builds a list of differences. The result is marked with a sign:+ more (new in the source)

- less (missing in the source)

# changed (new version in the source)

! changed (old version in the source)

% changed (but file length and date are equal) only possible if not quick compare

Update goes through the list and takes the following actions depending on the sign:+ copy the file from source to destination

- delete the file at destination only if the switch delete/remove is set

# copy the file from source to destination

! copy the file from source to destination only if overwrite is set

% copy the file from source to destination



3.5 The 3.5 The RRules of ules of UUpdatingpdating


The source is never changed. Update always changes the destination. Update works only with files/directories which are in the list and have a sign.

Black files and blue directories are always copied from source to destination. Red files and red directories are copied or deleted only if the switch is on.

The signs determine the actions (copy or delete).

If there is no sign then there is no action. The colour is just for survey. Red means dangerous.

Be careful. Something could be destroyed.

If the switches "Always Overwrite" and "Remove File/Directory" are both on, then the destination is equal the source after the update. Assumption: Long list used.



4.1 Build a 4.1 Build a CCross-ross-RReference eference LListist

4. Where 4. Where AAre the re the DDocuments?ocuments?

Advantage Find the solution quickly

Disadvantages One word only

After changes in documents the reference list is obsolete. A new one should be created.

Stichwortverzeichnis



4.2 What 4.2 What IIs a s a WWord?ord?


word = {letter | digit}2..32

List of exception

STRINGS

ab .

aber .

all .

alle .

Should these be words?

cross-reference

ora-01556

sys$user1:[neumann.a1.pc]



4.3 Search 4.3 Search TTrough rough AAll ll DoDocumentscuments


Advantage More than one word possible

Result is always up to date

Disadvantage It is slowly



4.4 Is 4.4 Is EEvery very DDocument ocument RReachable?eachable?


Did a link fail? Is there a link to a document which does not

exist?

Is a link missing? Is there a document which is not pointed out

by a link?

Is there a link outside? Is there a link to document which is outside

the start directory tree?



5.1 Html 5.1 Html IImport and mport and EExportxport

5. Html 5. Html CConverteronverter

PROCEDURE ImportText* (f: Files.File; OUT s: Stores.Store);

PROCEDURE ExportText* (s: Stores.Store; f: Files.File);

Both commands have the same structure: they loop over all characters in a text and translate and write them to a text or file.

Registration in System/Mod/Config.odcConverters.Register(“HtmlImporter.ImportText", "HtmlExporter.ExportText",

"TextViews.View", "htm", {});

After registration the converter can be used with the [File][Open] and [File][Save] commands.



5.2 Link 5.2 Link FFixix


There are different approaches to relative addressing odc: relative to the BlackBox starting directory

Html: relative to the current document directory

Example: Document Back05 has a link to document Back07 <InfoCmds.OpenDoc(‘Uhl/Backup/Back07.odc’> … <>

<a href="Back07.htm"> … </a>



5.3 Tag 5.3 Tag VViewsiews


<html>

<head>

<title> … </title>

</head>

<body>

…

…

</body>

</html>

<LI>

[Html][Create Tag]

[Html][Expand Tag]

<LI>



5.4 What 5.4 What IIs s MMissing?issing?


Translating tables

Translating rulers

Translating images and graphics



The EndThe End

Helpdesk‘s Adviser BlackBox Developers Meeting 12.10.2014Version: FinalPage 1 Helpdesk‘s Adviser...

Documents

Transcript of Helpdesk‘s Adviser BlackBox Developers Meeting 12.10.2014Version: FinalPage 1 Helpdesk‘s Adviser...