Struktura i elementy tekstów w serwisie komentarze online (komOn):openlaw ressources

Revision [47]

This is an old revision of KomentarzeOnline made by WojciechLisiewicz on 2006-04-08 18:27:12.

Struktura i elementy tekstów w serwisie komentarze online (komOn)

- tymczasowy projekt -

1. Słowniczek pojęć
autor = osoba zarejestrowana, która bierze udział w tworzeniu komentarzy; samodzielnie wprowadza teksty;
czytelnik = użytkownik, który czyta nasze komentarze; nie ma konieczności rejestracji (przynajmniej na początek)

2. Koncepcja wprowadzania tekstów
Tekst wprowadzany jest przy pomocy technologii WYSIWYG (what you see is what you get), czyli w taki sam sposób, jak robi się to w każdym nowoczesnym edytorze tekstu (np. OOo czy Word). Nie są potrzebne żadne umiejętności HTML a mimo to istnieje możliwość nadania pewnych formatów.
Różnica w stosunku do zwykłego edytora polega na tym, że:

istnieje tylko kilka możliwości formatowania,
formaty nie są związane z wyglądem, tylko z funkcją (zaznaczenie szczególnie ważnych wypowiedzi, cytaty, linki itp.); mimo to jakoś są one widoczne (szczegóły – patrz tabela w punkcie 5.).

3. Struktura tekstu jako całości
Tekst komentarza związany jest zawsze z przepisem, który jest komentowany. Oznacza to, że

1 przepis (Art., §) = 1 komentarz

Pozostałe reguły:

Komentarz podzielony jest na jednostki redakcyjne, które w oparciu o komentarze drukowane będą nazywane "numerami bocznymi" (nb.).
Każdy nb. będzie edytowany odrębnie (= w odrębnym okienku, przy każdym numerze bocznym pojawi się mały link “edytuj” - przynajmniej dla użytkowników zalogowanych...).
Każdy nb. ma również (jeszcze nie wiem czy obligatoryjnie czy fakultatywnie?) tytuł, czyli jest jednocześnie elementem struktury komentarza (Gliederung, konspekt) – przy czym struktura ta celowo jest bardzo uproszczona (tylko jeden poziom numeracji, i to właśnie w oparciu o tytuły numerów bocznych).

4. Cytowanie
Cytowanie naszego komentarza online powinno odbywać się mniej więcej tak:

komOn (trzeba jeszcze sprecyzować, jak będziemy się mianować) do (akt prawny), Art./§ (numer przepisu) w./wersja (numer wersji), nb. (kolejny numer boczny)

Cytowanie innych źródeł to cała filozofia. Jedno jest pewne: powinniśmy nakłaniać do jak najbardziej precyzyjnego cytowania.
Co do formatowania cytatów dosłownych oraz odnośników do źródeł - patrz pod punktem 5.

5. Poszczególne elementy tekstu i ich widok dla autora oraz dla czytelnika
Proponuję, abyśmy nie stosowali w tekstach formatów typu “wytłuszczone” czy “kursywa” lub “podkreślenie”, tylko abyśmy stosowali META-formaty, czyli klasyfikowali powód wytłuszczenia czy podkreślenia. Oznacza to, że użytkownik nie ma możliwości wprowadzenia kolorowych czy różnie sformatowanych tekstów (wszelkie próby system usunie). Powinien natomiast zastanowić się wyłącznie nad tekstem i ewentualnie stiwerdzić, czy chce coś przedstawić jako ważne czy jako cytat (tu oczywiście potrzebuję Waszej pomocy w ocenie, jakiego typu META-formaty powinniśmy w systemie uwzględnić). Wprawdzie te meta-formaty muszą być jakoś uwidocznione podczas wprowadzania tekstów jak i dla czytelnika (np. wytłuszczone), ale ta prezentacja wynika wyłącznie z tego, jak programy na serwerze działają – w banku danych zapisywane są tagi XML-a, które możecie zobaczyć w kolumnie “uwagi”.

element: normalny tekst

widok dla autora - również normalny tekst
widok dla czytelnika - normalny tekst
(brak jest specjalnych wymogów)

element: szczególnie ważny tekst (godny podkreślenia)

widok dla autora - tekst wytłuszczony
widok dla czytelnika - tekst wytłuszczony
tag widoku - <b>, tag xml - <wazne>

element: dosłowny cytat

widok dla autora - tekst pochylony (kursywa)
widok dla czytelnika - tekst pochylony (kursywa)
tag widoku - <i>, tag xml - <cytat>

element: źródło (które jest cytowane)

widok dla autora - żółte tło tekstu
widok dla czytelnika - wytłuszczone słówko (cytat), po najechaniu na nie myszką pojawia się “chmurka” z opisem źródła
tag widoku - <span style=””>, tag xml - <zrodlo>

element: tytuł akapitu (nb.)

widok dla autora - bez formatów (wpisany w odpowiednie pole)
widok dla czytelnika - Tłusty i powiększony tekst
tag widoku - <h3>, tag xml - brak (bo odrębne pole w bazie)

element: link do innych źródeł (obcych)

widok dla autora - standard jak wygląda link
widok dla czytelnika - standard jak wygląda link
tag widoku - <a href=””>, tag xml - <link adres=””>
(wprowadzanie przy pomocy funkcji w edytorze wstaw link)

element: link do naszych przepisów

widok dla autora - standard jak wygląda link o odpowiedniej strukturze Art./§ nr skrot)
widok dla czytelnika - standard jak wygląda link o odpowiedniej strukturze Art./§ nr skrot)
tag widowku - <a href=”przepis” nr=”nr” skrot=”skrot”>; tag xml - <przepis nr=”nr” skrot=”skrot”>
(wprowadzanie przy pomocy funkcji w edytorze Link do przepisu)

6. Zarządzanie wersjami
Kolejność nb. nie może się zmieniać, ponieważ uniemożliwiłoby to cytowanie wg nb (co do cytowania patrz punkt 4). Dlatego wprowadzamy zarządzanie wersji po to, aby od czasu do czasu móc zmienić strukturę każdego komentarza (do poszczególnego przepisu).
Oznacza to, że jeśli podczas zakładania komentarza do przepisu Art. 14 KSH powstanie struktura o numerach bocznych 1-16 (wersja 1), to gdy pojawi się konieczność wprowadzenia do komentarza tego przepisu między numerami bocznymi 7 a 8 dodatkowych uwag, które powinny otrzymać nowy numer boczny (jak gdyby 7a), wprowadzenie tych uwag jest możliwe dopiero po stworzeniu nowej wersji komentarza (wersja 2), która ma numery boczne 1-17.

openlaw ressources : KomentarzeOnline

Revision [47]

Struktura i elementy tekstów w serwisie komentarze online (komOn)