MotławaWiki:Opis szablonów: Różnice pomiędzy wersjami

Z Motława
(→‎Informacja dla developera, administratora)
(→‎Wskazanie na zdarzenie z CRM)
 
(Nie pokazano 36 pośrednich wersji utworzonych przez tego samego użytkownika)
Linia 1: Linia 1:
 +
{{MotławaWiki}}
 +
== Metryczki ==
 +
=== Zobacz także ===
 +
Na dole strony należy dopisać kod:
 +
<pre><nowiki>{{ZobaczTakze|
 +
* [[TEST]]
 +
}}</nowiki></pre>
 +
W  efekcie da to:
 +
 +
{{ZobaczTakze|
 +
* [[TEST]]
 +
}}
 +
 +
 +
Moduł niezbędny do przekierowania do tematów pokrewnych !
 +
 +
=== Notka o wsparciu ===
 +
Wklejenie taga:
 +
<pre><nowiki>{{ProsbaOInfo}}</nowiki></pre>
 +
daje efekt:<br>
 +
{{ProsbaOInfo}}
 +
 +
=== Metryczka dla opisu tabel sql ===
 +
Tworząc hasło związane z opisem konkretnej tabeli SQL, prosimy o użycie poniższego szablonu na samej górze:
 +
<pre><nowiki>{{TabelaSQL
 +
|nazwa=osoby
 +
|opis=Tabela SQL przechowująca dane związane z osobą (pracownik, osoby kontrahenta, ...).
 +
|powiazania= [[osoby_cechy]], [[Pracownicy]]
 +
}}
 +
</nowiki></pre><BR>
 +
podgląd:<br>
 +
{{TabelaSQL
 +
|nazwa=osoby
 +
|opis=Tabela SQL przechowująca dane związane z osobą (pracownik, osoby kontrahenta, ...).
 +
|powiazania= [[osoby_cechy]], [[Pracownicy]]
 +
}}
 +
 +
=== Metryczka opisująca klucz [[IntNetCenter]] ===
 +
Tworząc hasło związane z opisem konkretnego klucza [[IntNetCenter]] prosimy na górze strony o użycie szablonu KluczIntNet z opisem - przykład:
 +
<pre><nowiki>{{KluczIntNet|
 +
nazwa=Zapraszamy
 +
|wartosc=Pole słowne
 +
|opis=Treść wyświetlana na dole tuż nad stopką dokumentów finansowych (np. faktur) przekaujący zwykle podziękowania za zakup.
 +
}}
 +
</nowiki></pre>
 +
 +
przykład:
 +
{{KluczIntNet|
 +
nazwa=Zapraszamy
 +
|wartosc=Pole słowne
 +
|opis=Treść wyświetlana na dole tuż nad stopką dokumentów finansowych (np. faktur) przekaujący zwykle podziękowania za zakup.
 +
}}
 +
 +
 +
dodatkowy parametr (niewymagany):
 +
IRegPath=sciezka w intnetcenter
 +
 +
=== Metryczka pliku systemowego ===
 +
Tworząc hasło związane z plikiem systemowym, prosimy w nagłówku zawrzeć metryczkę według poniższego przykładu:
 +
<pre><nowiki>{{FileInfo|nazwa=io_sendmail.dll
 +
|opis=biblioteka systemu ([[agent]]) [[Motława]] odpowiedzialna za wysyłkę poczty e-mail z programu.
 +
}}
 +
</nowiki></pre>
 +
przykład:
 +
{{FileInfo|nazwa=io_sendmail.dll
 +
|opis=biblioteka systemu ([[agent]]) [[Motława]] odpowiedzialna za wysyłkę poczty e-mail z programu.
 +
}}
 +
 +
dodatkowo można dodać parametr |ikona=<nowiki>[[image:xxx]]</nowiki>
 +
 +
== Symulacje przycisków itp.. ==
 +
=== Przyciski ===
 +
Symulacja przycisków (wizualna): <nowiki>{{Przycisk|Treść}}</nowiki> <br>
 +
daje wynik (przykłady): <BR>
 +
{{Przycisk|Treść}}
 +
{{Przycisk|Pomoc}}
 +
{{Przycisk|Drukuj}}
 +
 +
Inną opcją są skróty klawiszowe - wystarczy wtedy dodać kolejne klawisze po "|" np.
 +
<nowiki>{{Przycisk|Ctrl|Alt|Del}}</nowiki> <br>
 +
wynik: {{Przycisk|Ctrl|Alt|Del}}
 +
 +
=== Informacja uszczegóławiająca ===
 +
Jeśli jakaś opcja wymaga podkreślenia, że np. istnieje od danego momentu zalecane jest podanie tego faktu w opisie z wykorzystaniem szablonu <nowiki>{{Info|Opis}}</nowiki>.<br>
 +
Przykład:
 +
<code><nowiki>
 +
  {{Info|Opcja dostępna od 23 listopada 2009r.}}
 +
</nowiki></code> da wynik:<br>
 +
{{Info|Opcja dostępna od 23 listopada 2009r.}}
 +
 +
=== Symulacja okien błędów ===
 +
Odwzorowanie z grubsza:
 +
<code><nowiki>
 +
  {{ShowError|Komunikat=wystąpił błąd<br>#42000PROCEDURE ... does not exist &nbsp; &nbsp; &nbsp;}}</nowiki></code>
 +
daje wynik:
 +
{{ShowError|Komunikat=wystąpił błąd<br>#42000PROCEDURE ... does not exist &nbsp; &nbsp; &nbsp;}}
 +
 +
Jest to zaleta ponieważ błąd zapisany jest słownie i w przeciwieństwie do jpg podlega jego treść wyszukiwarce
 +
 +
=== Symulacja okien informacyjnych ===
 +
Odwzorowanie z grubsza:
 +
<code><nowiki>
 +
  {{ShowMessageInfo|Komunikat=Dzień dobry!}}</nowiki></code>
 +
daje wynik:
 +
{{ShowMessageInfo|Komunikat=Dzień dobry!}}
 +
 +
Jest to zaleta ponieważ błąd zapisany jest słownie i w przeciwieństwie do jpg podlega jego treść wyszukiwarce
 +
 +
=== Symulacja okien ostrzeżeń ===
 +
Odwzorowanie z grubsza:
 +
<code><nowiki>
 +
  {{ShowMessageWar|Komunikat=Dzień dobry!}}</nowiki></code>
 +
daje wynik:
 +
{{ShowMessageWar|Komunikat=Dzień dobry!}}
 +
 +
Jest to zaleta ponieważ błąd zapisany jest słownie i w przeciwieństwie do jpg podlega jego treść wyszukiwarce
  
 
== Informacja o niejasnym opisie ==
 
== Informacja o niejasnym opisie ==
 
* W przypadku natrafienia na hasło, z którym nie jesteś w stanie dać sobie rady ('''napisane jest niejasno''') prosimy na górze jego strony dopisać szablon: <nowiki>{{PisaćJaśniej}}</nowiki> da to efekt:
 
* W przypadku natrafienia na hasło, z którym nie jesteś w stanie dać sobie rady ('''napisane jest niejasno''') prosimy na górze jego strony dopisać szablon: <nowiki>{{PisaćJaśniej}}</nowiki> da to efekt:
 
{{PisaćJaśniej}}
 
{{PisaćJaśniej}}
 +
 +
== Hasła wymagające aktualizacji ==
 +
Jeśli jakieś hasło wymaga zaznaczenia informacji o wymogu aktualizacji danych (treści, ...) należy wpisać:
 +
<nowiki>{{Zaktualizować}}</nowiki> co zaskutkuje :
 +
 +
{{Zaktualizować}}
 +
 
== Hasło wymagające dopracowania ==
 
== Hasło wymagające dopracowania ==
 
* W przypadku natrafienia na hasło wymagające '''dopracowania''' prosimy na górze jego strony dopisać szablon: <nowiki>{{Dopracować}}</nowiki> da to efekt:
 
* W przypadku natrafienia na hasło wymagające '''dopracowania''' prosimy na górze jego strony dopisać szablon: <nowiki>{{Dopracować}}</nowiki> da to efekt:
Linia 15: Linia 138:
 
* Jeśli zawartośc danej strony jest przeklejana z automatu (nie edytowania/pisana ręcznie) to proszę dodać na górze strony przypis: <nowiki>{{automat}}</nowiki> - niech inni wiedzą że to nie jest finalna wersja. Po zakończeniu prac wystarczy usunąć podany znacznik. Wynik dodania znacznika da efekt:
 
* Jeśli zawartośc danej strony jest przeklejana z automatu (nie edytowania/pisana ręcznie) to proszę dodać na górze strony przypis: <nowiki>{{automat}}</nowiki> - niech inni wiedzą że to nie jest finalna wersja. Po zakończeniu prac wystarczy usunąć podany znacznik. Wynik dodania znacznika da efekt:
 
{{automat}}
 
{{automat}}
 +
 +
== Dubel ==
 +
* Jeśli spotkasz 2 lub wiecej hasel zawierających praktycznie to samo należy je ujednolicić lub oznaczyć je tagiem.
 +
<nowiki> {{Dubel|[[Haslo]]}} </nowiki>
 +
Da to wynik:
 +
{{Dubel|[[Haslo]]}}
  
 
== Informacja dla developera, administratora ==
 
== Informacja dla developera, administratora ==
 
Jeśli w haśle chcesz przekazać specyficznym językiem informację dla osób współtworzących system (tzw. developerów) możesz dodać znacznik poszerzony o opis: <br>
 
Jeśli w haśle chcesz przekazać specyficznym językiem informację dla osób współtworzących system (tzw. developerów) możesz dodać znacznik poszerzony o opis: <br>
−
<nowiki>{{Szablon:DevelInfo|opis=tu opis}}</nowiki><BR>
+
<pre><nowiki>{{Szablon:DevelInfo|opis=tu opis}}</nowiki></pre><BR>
 
efektem czego będzie dodanie w treści tabeli o następującym wyglądzie:
 
efektem czego będzie dodanie w treści tabeli o następującym wyglądzie:
 
{{Szablon:DevelInfo|opis=tu opis}}
 
{{Szablon:DevelInfo|opis=tu opis}}
  
  
−
== Metryczka dla opisu tabel sql ==
 
−
Tworząc hasło związane z opisem konkretnej tabeli SQL, prosimy o użyczie poniższego szablonu na samej górze:
 
−
<nowiki>{{TabelaSQL
 
−
|nazwa=osoby
 
−
|opis=Tabela SQL przechowująca dane związane z osobą (pracownik, osoby kontrahenta, ...).
 
−
|powiazania= [[osoby_cechy]], [[Pracownicy]]
 
−
}}
 
−
</nowiki><BR>
 
−
podgląd:<br>
 
−
{{TabelaSQL
 
−
|nazwa=osoby
 
−
|opis=Tabela SQL przechowująca dane związane z osobą (pracownik, osoby kontrahenta, ...).
 
−
|powiazania= [[osoby_cechy]], [[Pracownicy]]
 
−
}}
 
  
 
== POMOCY!!! ==
 
== POMOCY!!! ==
−
Jeśli w danym haśle potrzebujesz pomocy osób trzecich to dopisz do kodu na górze znacznik: <nowiki>{{Szablon:HELP!}}</nowiki><br>
+
Jeśli w danym haśle potrzebujesz pomocy osób trzecich to dopisz do kodu na górze znacznik: <nowiki>{{HELP!}}</nowiki><br>
 
dodana zostanie ramka:
 
dodana zostanie ramka:
−
{{Szablon:HELP!}}
+
{{HELP!}}
  
 +
== Hasła/strony  do usunięcia ==
 +
Jeśli dana strona ma zostać usunięta przez administratora systemu to prosimy w jej treści wpisać tag: <nowiki>{{Usuń}}</nowiki>
 +
Na stronie pojawi się treść (administrator będzie wiedział że ta strona kwalifikuje się do usunięcia):
 +
{{Usuń}}
  
  
−
{{MotławaWiki}}
+
== Link do rozszerzonego opisu ==
 +
Jeśli w treści chcemy wtracić link do hasła rozszerzającego opis danej części strony wystarczy dodać:
 +
<nowiki>
 +
  {{main|[[Haslo]]}}
 +
</nowiki><BR>
 +
Da to wynik: <BR>
 +
{{main|[[Haslo]]}}
  
 +
<BR>
 +
Definicja hasła jest podawana analogicznie do definiowanego linku normalnie tj działają składnie <nowiki>[[Hasło|Opis]]</nowiki> itp.
 +
 +
== IFDEF ==
 +
Jeśli jakieś hasło dotyczy konkretnego IFDEFA systemowego nalezy dodac : <nowiki>{{Szablon:TylkoIFDEF|ALAMAKOTA}}</nowiki>
 +
<BR>
 +
Da to wynik:<br>
 +
{{Szablon:TylkoIFDEF|ALAMAKOTA}}
 +
 +
== Wskazanie na zdarzenie z CRM ==
 +
<nowiki>{{crmid|numer}}</nowiki>:
 +
<br>
 +
{{crmid|numer}}
 +
 +
== Info o dostępności od wersji ==
 +
<nowiki>{{OdWersji|4 października 2013}}</nowiki>:
 +
<br>
 +
{{OdWersji|4 października 2013}}
 +
 +
 +
{{MotławaWiki}}
 
[[Kategoria: MotławaWiki]]
 
[[Kategoria: MotławaWiki]]

Aktualna wersja na dzień 11:10, 4 paź 2013

MotlawaWiki.jpg

Dokumentacja systemu MotławaWiki:
Spis treści • Wprowadzenie • Zanim zaczniesz edycję • Opis szablonów • Hasła specjalne • Znaki specjalne

Metryczki

Zobacz także

Na dole strony należy dopisać kod: 

{{ZobaczTakze|
* [[TEST]]
}}

W efekcie da to:

  Zobacz także:
Seealso.jpg


Moduł niezbędny do przekierowania do tematów pokrewnych !

Notka o wsparciu

Wklejenie taga: 

{{ProsbaOInfo}}

daje efekt:
Prośba o wsparcie przy rozwoju
Staramy się zawrzeć w niniejszym serwisie maksymalną ilość wiedzy pomocnej przy użytkowaniu naszego oprogramowania. Biorąc pod uwagę mnogość dostępnych konfiguracji oraz różnorodność wprowadzanych danych przez naszych klientów nie jesteśmy w stanie przewidzieć wszystkich kombinacji więc bardzo prosimy o zgłaszanie nam wszelkich problemów celem ich usuwania oraz aktualizowania niniejszej bazy wiedzy.

Metryczka dla opisu tabel sql

Tworząc hasło związane z opisem konkretnej tabeli SQL, prosimy o użycie poniższego szablonu na samej górze: 

{{TabelaSQL
|nazwa=osoby
|opis=Tabela SQL przechowująca dane związane z osobą (pracownik, osoby kontrahenta, ...). 
|powiazania= [[osoby_cechy]], [[Pracownicy]]
}}

podgląd:

Sql-icon.jpg Tabela MySQL:
osoby
opis skrócony: Tabela SQL przechowująca dane związane z osobą (pracownik, osoby kontrahenta, ...).
powiązania: osoby_cechy, Pracownicy

Metryczka opisująca klucz IntNetCenter

Tworząc hasło związane z opisem konkretnego klucza IntNetCenter prosimy na górze strony o użycie szablonu KluczIntNet z opisem - przykład: 

{{KluczIntNet|
nazwa=Zapraszamy
|wartosc=Pole słowne
|opis=Treść wyświetlana na dole tuż nad stopką dokumentów finansowych (np. faktur) przekaujący zwykle podziękowania za zakup.
}}

przykład:

IntNetKey ico.jpg Klucz IntNetCenter (jak edytować klucze, FAQ):
Zapraszamy
wartość klucza: Pole słowne
opis klucza: Treść wyświetlana na dole tuż nad stopką dokumentów finansowych (np. faktur) przekaujący zwykle podziękowania za zakup.


dodatkowy parametr (niewymagany): IRegPath=sciezka w intnetcenter

Metryczka pliku systemowego

Tworząc hasło związane z plikiem systemowym, prosimy w nagłówku zawrzeć metryczkę według poniższego przykładu: 

{{FileInfo|nazwa=io_sendmail.dll
|opis=biblioteka systemu ([[agent]]) [[Motława]] odpowiedzialna za wysyłkę poczty e-mail z programu.
}}

przykład:

Unknown file ico.jpg io_sendmail.dll
biblioteka systemu (agent) Motława odpowiedzialna za wysyłkę poczty e-mail z programu.

dodatkowo można dodać parametr |ikona=[[image:xxx]]

Symulacje przycisków itp..

Przyciski

Symulacja przycisków (wizualna): {{Przycisk|Treść}}
daje wynik (przykłady):
 Treść   Pomoc   Drukuj 

Inną opcją są skróty klawiszowe - wystarczy wtedy dodać kolejne klawisze po "|" np. {{Przycisk|Ctrl|Alt|Del}}
wynik:  Ctrl +  Alt +  Del 

Informacja uszczegóławiająca

Jeśli jakaś opcja wymaga podkreślenia, że np. istnieje od danego momentu zalecane jest podanie tego faktu w opisie z wykorzystaniem szablonu {{Info|Opis}}.
Przykład: {{Info|Opcja dostępna od 23 listopada 2009r.}} da wynik:

Znak info.jpg Opcja dostępna od 23 listopada 2009r.

Symulacja okien błędów

Odwzorowanie z grubsza: {{ShowError|Komunikat=wystąpił błąd<br>#42000PROCEDURE ... does not exist      }} daje wynik:

border=0
  Error
Biseptol.jpg wystąpił błąd
#42000PROCEDURE ... does not exist      

   OK   

Jest to zaleta ponieważ błąd zapisany jest słownie i w przeciwieństwie do jpg podlega jego treść wyszukiwarce

Symulacja okien informacyjnych

Odwzorowanie z grubsza: {{ShowMessageInfo|Komunikat=Dzień dobry!}} daje wynik:

  Informacja
Information.gif Dzień dobry!

   OK   

Jest to zaleta ponieważ błąd zapisany jest słownie i w przeciwieństwie do jpg podlega jego treść wyszukiwarce

Symulacja okien ostrzeżeń

Odwzorowanie z grubsza: {{ShowMessageWar|Komunikat=Dzień dobry!}} daje wynik:

border=0
  Ostrzeżenie
Warning.gif Dzień dobry!

   OK   

Jest to zaleta ponieważ błąd zapisany jest słownie i w przeciwieństwie do jpg podlega jego treść wyszukiwarce

Informacja o niejasnym opisie

  • W przypadku natrafienia na hasło, z którym nie jesteś w stanie dać sobie rady (napisane jest niejasno) prosimy na górze jego strony dopisać szablon: {{PisaćJaśniej}} da to efekt:
Book.png
 Ten artykuł wymaga opisania w sposób jasny dla ludzi z zewnątrz zgodnie z zaleceniami edycyjnymi.
Po wyeliminowaniu wskazanych powyżej niedoskonałości prosimy usunąć szablon {{PisaćJaśniej}} z kodu tego artykułu.


Hasła wymagające aktualizacji

Jeśli jakieś hasło wymaga zaznaczenia informacji o wymogu aktualizacji danych (treści, ...) należy wpisać: {{Zaktualizować}} co zaskutkuje :

Wiki update.jpg
 Ten artykuł wymaga uaktualnienia.
Po wyeliminowaniu wskazanych powyżej niedoskonałości prosimy usunąć szablon {{Zaktualizować}} z kodu tego artykułu.


Hasło wymagające dopracowania

  • W przypadku natrafienia na hasło wymagające dopracowania prosimy na górze jego strony dopisać szablon: {{Dopracować}} da to efekt:
Szczotka.png
 Ten artykuł wymaga dopracowania zgodnie z zaleceniami edycyjnymi.
Po wyeliminowaniu wskazanych powyżej niedoskonałości prosimy usunąć szablon {{Dopracować}} z kodu tego artykułu.


Zaznaczenie hasła jako "przeładowanego treścią"

  • Jeśli dane hasło jest przeładowane i lepszym rozwiązaniem by było utworzenie haseł pokrewnych to możesz zaproponować aby dana sekcja hasła stała się osobnym pojęciem poprzez dodanie {{Podziel sekcję}}, da to efekt:

Wikikopiuj.png

Zasugerowano, aby ta sekcja została przeniesiona do nowego artykułu.



Hasło w fazie budowy

  • Jeśli dane hasło jest placem budowy to wpisz koniecznie na górze: {{PracaWre}} - niech inni wiedzą że to nie jest finalna wersja. Po zakończeniu prac wystarczy usunąć podany znacznik. Wynik dodania znacznika da efekt:
Inprogress.png
 Ten artykuł jest w trakcie tworzenia, nie wszystkie odnośniki mogą działać poprawnie lub być rozwinięte
Możesz nam pomóc przy rozbudowie dokumentacji systemu - zobacz jak możesz tego dokonać


Hasło utworzone z "automatu"

  • Jeśli zawartośc danej strony jest przeklejana z automatu (nie edytowania/pisana ręcznie) to proszę dodać na górze strony przypis: {{automat}} - niech inni wiedzą że to nie jest finalna wersja. Po zakończeniu prac wystarczy usunąć podany znacznik. Wynik dodania znacznika da efekt:

Strona wygenerowana automatycznie - jeśli widzisz jakieś nieścisłości to popraw!

Dubel

  • Jeśli spotkasz 2 lub wiecej hasel zawierających praktycznie to samo należy je ujednolicić lub oznaczyć je tagiem.

{{Dubel|[[Haslo]]}} Da to wynik:

 

Niniejsza strona zawiera prawie te same wiadomości co strona Haslo.
 Skoryguj obie lub ujednolić do jednej całkowitej !

Informacja dla developera, administratora

Jeśli w haśle chcesz przekazać specyficznym językiem informację dla osób współtworzących system (tzw. developerów) możesz dodać znacznik poszerzony o opis: 

{{Szablon:DevelInfo|opis=tu opis}}

efektem czego będzie dodanie w treści tabeli o następującym wyglądzie:

Developer-icon.jpg Przypis dla developera
tu opis


POMOCY!!!

Jeśli w danym haśle potrzebujesz pomocy osób trzecich to dopisz do kodu na górze znacznik: {{HELP!}}
dodana zostanie ramka:

Wikihelp.png
 Tu potrzebujemy pomocy ;-)
Możesz nam pomóc przy rozbudowie dokumentacji systemu - zobacz jak możesz tego dokonać


Hasła/strony do usunięcia

Jeśli dana strona ma zostać usunięta przez administratora systemu to prosimy w jej treści wpisać tag: {{Usuń}} Na stronie pojawi się treść (administrator będzie wiedział że ta strona kwalifikuje się do usunięcia):

TO HASŁO BĘDZIE USUNIĘTE!


Link do rozszerzonego opisu

Jeśli w treści chcemy wtracić link do hasła rozszerzającego opis danej części strony wystarczy dodać: {{main|[[Haslo]]}}
Da to wynik:
       Info.png Osobny artykuł: Haslo


Definicja hasła jest podawana analogicznie do definiowanego linku normalnie tj działają składnie [[Hasło|Opis]] itp.

IFDEF

Jeśli jakieś hasło dotyczy konkretnego IFDEFA systemowego nalezy dodac : {{Szablon:TylkoIFDEF|ALAMAKOTA}}
Da to wynik:

Ifdef.jpg Element systemu Motława o ograniczonym dostępie (IFDEF).
Opcja dostępna tylko w wersjach z wkompilowanym modułem ALAMAKOTA

Wskazanie na zdarzenie z CRM

{{crmid|numer}}:
CRM id powiązane bezpośrednio z kluczem:numer

Info o dostępności od wersji

{{OdWersji|4 października 2013}}:

Znak info.jpg Opcja dostępna w wersjach przygotowanych po dacie 4 października 2013


MotlawaWiki.jpg

Dokumentacja systemu MotławaWiki:
Spis treści • Wprowadzenie • Zanim zaczniesz edycję • Opis szablonów • Hasła specjalne • Znaki specjalne

Źródło „https://wiki.int.com.pl/index.php?title=MotławaWiki:Opis_szablonów&oldid=11100”