Obiekt deweloperski: Help object

Wprowadzenie

Aplikacja Obiekty deweloperskie pozwala na rejestrowanie i przeglądanie obiektów deweloperskich różnych typów. W niniejszym artykule opisany został obiekt o typie Help object.

Opis

Rejestrowanie plików pomocy, które są wyświetlane w pomocy Comarch ERP Enterprise. Obiekt programistyczny zawiera zarówno pliki źródłowe, jak i docelowe.

Zakładka Edytor składa się z kilku podzakładek:

Podzakładka Katalog pomocy online

Oznaczenie – opis pomocy w katalogu pomocy. Nazwa jest ograniczona do 80 znaków i może zostać przetłumaczona.

Poprzednik – pole określa poprzednika (węzeł) w drzewie pomocy. Obiekt pomocy jest zawarty na liście miejsc użycia poprzednika.

Typ węzła – pole określa typ węzła obiektu pomocy.

  • Widoczny – odwołanie do obiektu pomocy.
  • Link – obiekt pomocy jest linkiem, do którego nie są przypisane żadne pliki, należy określić powiązany obiekt. Link jest wyświetlany w pomocy.
  • Niewidoczny – brak odwołania do innego obiektu pomocy.

Obiekt docelowy – obiekt pomocy, do którego następuje odwołanie, jeśli obiekt pomocy jest obiektem łącza. Obiekt pomocy znajduje się na liście miejsc użycia obiektu łącza.

Typ – określa typ pliku źródłowego i docelowego:

  • doc->pdf – głównym plikiem źródłowym jest plik .doc. Głównym plikiem docelowym jest plik .pdf.
  • doc->doc – głównym plikiem źródłowym jest plik .doc. Głównym plikiem docelowym jest plik .doc.
  • brak pliku – dla obiektu pomocy nie wprowadzono pliku źródłowego ani docelowego.

System sprawdza, czy wprowadzono odpowiedni główny plik źródłowy i główny plik docelowy. Pliki docelowe są przechowywane w systemie plików po aktywacji zadania i mogą być wyświetlane w pomocy.

Sortowanie – określa kolejność obiektów pomocy na poziomie w drzewie pomocy. W obrębie poziomu obiekty pomocy są wyświetlane w kolejności rosnącej zgodnie z tą numeracją. Numeracja w standardowym rozwoju odbywa się w wystarczająco dużych krokach. Dzięki temu partner może stosunkowo łatwo wstawić swoje dokumenty do istniejącego sortowania.

Podzakładka Pliki

Zakładka Pliki pozwala na wprowadzanie plików źródłowych i docelowych. Dostępne są przyciski umożliwiające dodanie nowego wiersza, jak i skopiowania wpisu z pamięci podręcznej, dodatkowo dostępny jest przycisk:

[Zapisz wyświetlaną wersję] – zapisuje plik wybranej linii pod katalogiem roboczym.

W tabeli dostępne są poniższe kolumny:

Nazwa pliku musi zaczynać się od nazwy obiektu deweloperskiego obiektu pomocy, jest unikalna i  ograniczona do 256 znaków. Ścieżka nie jest wymagana.

Przykład
<nazwa obiektu rozwojowego>_<nazwa pliku>.<typ>)

Typ – określa typ pliku:

  • Dokument główny źródłowy – typ pliku zależy od typu pomocy (patrz karta Typ – Dane). Ten typ może być wprowadzony tylko raz na obiekt deweloperski.
  • Dokument główny źródłowy – typ pliku zależy od typu pomocy (patrz karta Dane). Ten typ może być wprowadzony tylko raz na obiekt deweloperski. Plik jest wyświetlany w drzewie pomocy.
  • Źródło– dowolny plik źródłowy, do którego odwołuje się dokument główny (np. grafika używana przez dokument Word).

Podzakładka Obiekty deweloperskie

Typ – pozwala na określenie typu obiektu deweloperskiego.

Obiekt deweloperski – nazwa obiektu deweloperskiego pobrana z pola Nazwa z nagłówka aplikacji.

Obiekty pomocy mogą być obecnie rejestrowane tylko w aplikacjach. Do każdej aplikacji powinien być przypisany tylko jeden obiekt pomocy. Help object jest zawarty na liście wykazów zastosowania określonego obiektu deweloperskiego.

Czy ten artykuł był pomocny?