Jak pisać artykuły?

Jeżeli wiesz coś czym chciałbyś podzielić się z resztą czytelników pisz do nas - my to z chęcią opublikujemy. Poniżej postaramy się opisać w jaki sposób należy pisać artykuły dla naszego wortalu. Stosując się do poniższego tekstu przyspieszysz proces publikacji swojego tekstu na naszej stronie.

Strona ta kierowana jest głównie do osób, które mają w planach rozpocząć współpracę z naszym serwisem. Artykuły można do nas przysyłać w różnej formie (np. dokument programu OpenOffice.org, plain text, czy też zupełnie dowolnie sformatowany dokument HTML), jednak proces publikacji takiego dokumentu będzie znacznie wydłużony, ponieważ musimy go przerobić dostosowując do wymogów CMSa.

Proces publikacji

Nim Twój artykuł znajdzie się na naszym wortalu musi przejść kilka etapów. Poniżej lista czynności przez jaką przejdzie Twój tekst.

1. Po dodaniu newsa, artykułu w systemie CMS lub wysłaniu go na maila przystępujemy do pracy nad daną publikacją.
2. Artykuł jest weryfikowany pod względem merytorycznym. Sprawdzamy również poprawność pisowni, styl. W przypadku jakiś braków, dużej liczbie błędów, artykuł odsyłany jest do autora z prośbą o dodanie poprawek.
3. Na końcu, artykuł poprawiany jest pod względem poprawności składniowej (XHTML), o ile zachodzi taka potrzeba.
4. Po wszystkich korektach czekamy na akceptację artykułu ze strony autora.
5. Artykuł klasyfikowany jest do odpowiedniej kategorii i następuje jego publikacja.
6. O publikacji informujemy autora.

W taki mniej więcej sposób przebiega proces publikacji artykułu, newsa lub felietonu na łamach naszego serwisu.

Formatowanie artykułu

Artykuły, newsy czy felietony zamieszczamy w serwisie w formacie XHTML (w wersji 1.0 Transitional). W odróżnieniu od ,,zwykłego" HTML-a (który jest aplikacją SGML), dokumenty pisane w XHTML są zgodne z oficjalną specyfikacją XML (to znaczy, że dokumenty w XHTML są poprawnymi dokumentami XML) i dzięki temu można je łatwo generować z innych dokumentów XML przy pomocy np. transformacji XSLT, a także automatycznie przekształcać w inne formy XML-a.

Obecnie nowe przeglądarki, takie jak Firefox czy Opera, praktycznie w pełni obsługują XHTML, lecz przeglądarka mająca ciągle największy udział w rynku – Internet Explorer – w ogóle nie obsługuje XHTML-owego typu zawartości. W praktyce zmusza to webmasterów do stosowania dla dokumentów XHTML starego HTML-owego typu zawartości – dzięki temu, że XHTML w wersji 1.0 ,,symuluje" HTML 4 (tzn. posiada praktycznie taki sam zestaw elementów i atrybutów), wyświetlanie XHTML jako HTML nie sprawia większych problemów w żadnej przeglądarce.

Podstawowe znaczniki XHTML służące do formatowania artykułów:

• Nagłówki: <h2>Nagłówek</h2> - takimi elementami oznaczamy kolejne nagłówki w danym artykule.
• Paragraf: <p>Paragraf</p> - tym elementem oznaczamy wszystkie akapity. Oznacza to, że każdy tekst, który nie jest nagłówkiem, wypunktowaniem, bądź tabelą, powinien znaleźć się w paragrafie.
• Wytłuszczenia: <strong>Wytłuszczenia</strong> - takimi znacznikami formatujemy wszelakie istotne zdania, słowa kluczowe dla danego paragrafu. Podkreślamy nim ważne rzeczy, na które warto zwrócić uwagę.
• Kod, polecenie, listing: <code>tail -f /var/log/auth.log | grep Failed</code> - wszelkie wstawki w tekście będące listingami kodu lub kolejnymi poleceniami, jakie należy wykonać w konsoli.
• Tekst preformatowany: <pre>ps -efww | grep httpd</pre> - stosujemy również do poleceń, kodów, logów konsoli w przypadku kiedy chcemy zachować oryginalne formatowanie tekstu, np. zwielokrotnione spacje.
• Tekst pochylony: <i>Tekst pochylony<i> - tekstem pochylonym (italikiem, kursywą) formatujemy wszelkie ksywy, wyrażenia obcojęzyczne, które nie mają polskich odpowiedników lub z jakiegoś powodu chcemy z nich skorzystać np. portage, target.
• Linki: <a href="http://google.pl/">google.pl</a>" - w artykule, newsie lub dowolnej publikacji warto dodać linki, które pokierują czytelnika do innych stron internetowych, które powiązane są z naszą publikacją. Głównie chodzi tutaj o linki kierujące do definicji, stron danego projektu, linki do Wikipedii, strony domowe autorów, źródła itp. Duża ilość linków wzbogaca artykuł o kolejne źródła wiedzy.
• Cytaty: <blockquote>Cytat</blockquote> - w taki sposób formatujemy wszelkiego rodzaju cytaty z innych stro, wypowiedzi użytkowników itp.
• Skrót: <abbr title="File Transfer Protocol">FTP</abbr> - w ten sposób formatujemy wszystkie skróty, akronimy.
• Obrazki: <img src="obrazek.png" align="right" alt="Obrazek" /> - obrazki jakie załączamy do tekstu powinny mieć odpowiednią wielkość. Obrazek powinien być tak dopasowany, aby nie rozjeżdżał strony. Zalecana maksymalna szerokość obrazka to 500px. Wysokość obrazka nie jest ograniczona, jednak należy zachować zdrowy rozsądek. W przypadku większych obrazków jak np. screenshot ekranu, aplikacji w tekście zamieszczamy jego miniaturkę, która po kliknięciu kieruje do oryginalnego obrazka. Pliki graficzne możemy przesyłać na serwer przy pomocy funkcji uploadu w CMS, która dostępna jest z poziomu tworzenia artykułu. Obrazki zostaną zapisane na serwerze w katalogu wp-content.
• Listy: <ul><li>Element listy</li></ul> - wszystkie wypunktowania w tekście zawieramy w listach. W zależności od rodzaju wypunktowania (z oznaczeniem kolejności, bądź z kolejnością dowolną) używamy odpowiedniego znacznika.
• Tabele: <table><tr><td>Komórka</td></tr></table> - tabele służą do prezentacji danych tabelarycznych.

Poprawność pisowni

Przed wysłaniem tekstu prosimy sprawdzić czy nie zawiera błędów ortograficznych lub literówek. Można to zrobić korzystając z gotowych programów np: aspel lub innych. Wystarczy wydać proste polecenie aspell -c news.html. Poprawność pisowni można sprawdzać również za pomocą przeglądarki np. Firefox, lub pakietu biurowego OpenOffice. Tekst bez literówek oraz błędów ortograficznych znacznie skraca czas jaki musimy poświęcić na dopracowanie nadesłanej wiadomości.

Walidacja XHTML

Staramy się, aby nasz serwis był napisany w poprawnym XHTMLu, dlatego bardzo istotne jest dla nas, aby nadsyłane informacje nie zawierały błędów składni XHTML. Poprawność składni możemy sprawdzać różnymi narzędziami. Jednym z nich jest validator.w3.org. Jeżeli korzystamy z przeglądarki Firefox możemy skorzystać z wtyczki HTML VALIDATOR (based on Tidy and OpenSP).

Większe publikacje

Większe publikacje prosimy przesyłać w spakowanych plikach najlepiej tar.gz, które będą zawierać wszystkie teksty, załączniki oraz obrazki. Wszystkie dołączone załączniki zostaną umieszczone na naszych serwerach. Artykuły zostaną dostosowane do struktury serwisu, a po akceptacji autora zostaną opublikowane w serwisie.