Jak powinien wyglądać dobrze sformatowany artykuł? Instrukcja dla autorów

[Treker (Damian Szymański)]

//Oto szablon formatowania tekstów dla osób, które chcą publikować artykuły i opis projektów na naszym forum. W poniższym szablonie chodzi jedynie o pokazanie sposobu formatowania. Cała treść, oprócz zaznaczonych na czerwono komentarzy, to tylko "wypełniacz", który ma demonstrować sposób formatowania tekstów. W razie wątpliwości zachęcam również do zapoznania się z instrukcją obsługi dostępnego na forum edytora.

//Uwaga: Pierwsze zdjęcie wgrane do edytora będzie używane automatycznie jako miniaturka artykułu (np. na Facebooku). Warto więc w pierwszej kolejności wgrać do edytora ogólne zdjęcie związane z omawianym zagadnieniem, a nie np. schemat, który nie jest czytelną i zachęcającą miniaturką. Liczy się kolejność wgrania do edytora, a nie kolejność umieszczenia grafiki wewnątrz tekstu!

----

//Na początku artykułu warto umieścić krótki wstęp. Opisz tematykę artykułu, nakreśl jego cel, wskaż używane technologie i opisz poziom trudności. Nie ma konieczności, aby na samym początku (jeszcze przed tekstem) umieszczać zdjęcie.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam venenatis at felis rutrum laoreet. Aenean dui ex, condimentum quis convallis quis, facilisis nec metus. Proin ultricies mauris in odio blandit, sit amet fringilla ante tincidunt. Praesent et placerat turpis. Ut facilisis ante eu neque sagittis egestas. Duis at semper magna, ac tempus tortor. Proin dictum faucibus vulputate. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque eget velit ex.

Etiam venenatis at felis rutrum laoreet //Podziel tekst na logiczne części stosując proste "nagłówki" (pojedyncze, pogrubione linie tekstu)

Phasellus pretium accumsan quam, sit amet auctor risus euismod a. Donec vel massa ex. Pellentesque nisi sem, pretium eget leo sed, ultricies dapibus nulla. Phasellus aliquam mollis nulla eget bibendum. Ut elit nibh, venenatis vestibulum commodo in, vestibulum at augue. Vivamus lectus nulla, vehicula in scelerisque gravida, porta non justo. Praesent elementum, risus non maximus malesuada, arcu turpis accumsan tortor, sed laoreet dolor purus non ex. Aliquam eu ligula felis. Proin et neque et neque posuere lacinia sit amet nec felis. Nunc iaculis vitae odio eget elementum. Mauris et nunc risus.

//Staraj się, aby grafiki umieszczane w artykule były czytelne. Miniatury wstawiaj w nowych, wyśrodkowanych liniach.

Phasellus pretium accumsan quam, sit amet auctor risus euismod a. Donec vel massa ex. Pellentesque nisi sem, pretium eget leo sed, ultricies dapibus nulla. Phasellus aliquam mollis nulla eget bibendum. Ut elit nibh, venenatis vestibulum commodo in, vestibulum at augue. Vivamus lectus nulla, vehicula in scelerisque gravida, porta non justo. Praesent elementum, risus non maximus malesuada, arcu turpis accumsan tortor, sed laoreet dolor purus non ex. Aliquam eu ligula felis. Proin et neque et neque posuere lacinia sit amet nec felis. Nunc iaculis vitae odio eget elementum. Mauris et nunc risus.

//Teksty publikowane w internecie powinny składać się z krótkich, prostych zdań, które tworzą krótkie akapity. Nie rób jednak sztucznych przejść do nowej linii po każdym zdaniu!

Praesent sed risus risus. Cras sed risus rutrum, aliquam urna ac, sodales justo. Etiam venenatis nibh velit. Vestibulum posuere venenatis urna, sit amet ultrices ante vestibulum sed. Vivamus ac purus augue. Morbi nec congue nisl. Cras tellus eros, sagittis non vestibulum eget, suscipit laoreet mi. Donec lacinia massa magna, in tristique diam suscipit non. Quisque a finibus metus. Nulla augue nisi, ornare vel risus at, facilisis faucibus sapien.

//Stosuj pogrubienia, ale tylko, gdy są faktycznie potrzebne (zbyt dużo pogrubień utrudnia czytanie).

Praesent elementum, risus non maximus

Cras diam lectus, finibus nec commodo nec, iaculis in turpis. Praesent sed risus risus. Cras sed risus rutrum, aliquam urna ac, sodales justo. Etiam venenatis nibh velit. Vestibulum posuere venenatis urna, sit amet ultrices ante vestibulum sed. Vivamus ac purus augue. Morbi nec congue nisl. Cras tellus eros, sagittis non vestibulum eget, suscipit laoreet mi. Donec lacinia massa magna, in tristique diam suscipit non. Quisque a finibus metus. Nulla augue nisi, ornare vel risus at, facilisis faucibus sapien.

1. Phasellus
2. Pretium
3. Accumsan
4. Pellentesque

//Do tworzenia list wypunktowanych wykorzystuj opcje dostępne w edytorze. Nie twórz list ręcznie (za pomocą myślników lub cyfr).

Donec interdum lobortis est, quis pretium elit euismod nec. Sed pellentesque venenatis dolor vel dapibus. Quisque egestas accumsan commodo. Proin et sem lacus. Nulla facilisi. Nam vitae molestie ante. Suspendisse malesuada urna eu molestie sodales. Sed malesuada ullamcorper imperdiet. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Morbi mattis augue bibendum diam tincidunt, eu auctor tellus vehicula.

//Jeśli umieszczasz kilka zdjęć to ustaw jego obok siebie (nie jedno pod drugim). Przy okazji warto zadbać o to, aby grafiki miały te same proporcje (najlepiej 3:2), dzięki temu całość będzie wyświetlana równo i czytelnie.

Cras diam lectus, finibus nec commodo nec, iaculis in turpis. Praesent sed risus risus. Cras sed risus rutrum, aliquam urna ac, sodales justo. Etiam venenatis nibh velit. Vestibulum posuere venenatis urna, sit amet ultrices ante vestibulum sed. Vivamus ac purus augue. Morbi nec congue nisl. Cras tellus eros, sagittis non vestibulum eget, suscipit laoreet mi. Donec lacinia massa magna, in tristique diam suscipit non. Quisque a finibus metus. Nulla augue nisi, ornare vel risus at, facilisis faucibus sapien.

//Jeśli umieszczasz kod programu to koniecznie zadbaj o to, aby był on umieszczony za pomocą odpowiedniego narzędzia dostępnego w edytorze.

// the setup function runs once when you press reset or power the board
void setup() {
  // initialize digital pin LED_BUILTIN as an output.
  pinMode(LED_BUILTIN, OUTPUT);
}

// the loop function runs over and over again forever
void loop() {
  digitalWrite(LED_BUILTIN, HIGH);   // turn the LED on (HIGH is the voltage level)
  delay(1000);                       // wait for a second
  digitalWrite(LED_BUILTIN, LOW);    // turn the LED off by making the voltage LOW
  delay(1000);                       // wait for a second
}

Aliquam fringilla nisi vitae feugiat consectetur. Etiam at leo egestas est mattis facilisis consectetur non turpis. Aliquam sit amet nulla vel quam dignissim tincidunt. Aliquam nec orci lectus. Aenean et libero vel leo dapibus varius. Pellentesque a elit risus. Proin id dictum est. Pellentesque a orci justo. Phasellus sed aliquet velit, et pellentesque mi. In in mollis felis kurs Arduino. Fusce molestie tellus in ex interdum, nec elementum purus tempor. Curabitur ac lectus efficitur, placerat augue vel, aliquam libero. Mauris velit neque, posuere nec dapibus eu, finibus non nulla. Proin aliquet lacus sit amet nibh convallis, nec vehicula felis sagittis.

//Ewentualne linki należy osadzać pod konkretnymi słowami (jak wyżej), a nie wklejać bezpośrednio do tekstu. Warto również zwrócić uwagę, aby linki były osadzane pod konkretnymi frazami. Przykładowo link do kursu Arduino umieszczamy pod konkretnym hasłem czyli: "Więcej informacji na ten temat znaleźć można w kursie Arduino", a nie "Więcej informacji na ten temat znaleźć można w kursie Arduino, który dostępny jest tutaj" - tak nie należy robić.

Ut elit nibh, venenatis vestibulum commodo in, vestibulum at augue. Vivamus lectus nulla, vehicula in scelerisque gravida, porta non justo. Praesent elementum, risus non maximus malesuada, arcu turpis accumsan tortor, sed laoreet dolor purus non ex. Aliquam eu ligula felis. Proin et neque et neque posuere lacinia sit amet nec felis. Nunc iaculis vitae odio eget elementum. Mauris et nunc risus.

Nulla augue nisi, ornare vel risus at

Cras diam lectus, finibus nec commodo nec, iaculis in turpis. Praesent sed risus risus. Cras sed risus rutrum, aliquam urna ac, sodales justo. Etiam venenatis nibh velit. Vestibulum posuere venenatis urna, sit amet ultrices ante vestibulum sed. Vivamus ac purus augue. Morbi nec congue nisl. Cras tellus eros, sagittis non vestibulum eget, suscipit laoreet mi. Donec lacinia massa magna, in tristique diam suscipit non. Quisque a finibus metus. Nulla augue nisi, ornare vel risus at, facilisis faucibus sapien.

//Unikaj "ściany tekstu". Idealnie byłoby, gdyby co kilka akapitów pojawiały się powiązane tematycznie grafiki.

Ut elit nibh, venenatis vestibulum commodo in, vestibulum at augue. Vivamus lectus nulla, vehicula in scelerisque gravida, porta non justo. Praesent elementum, risus non maximus malesuada, arcu turpis accumsan tortor, sed laoreet dolor purus non ex. Aliquam eu ligula felis. Proin et neque et neque posuere lacinia sit amet nec felis. Nunc iaculis vitae odio eget elementum. Mauris et nunc risus.

//Jeśli chcesz dodać do artykułu film to osadź materiał z YouTube lub Vimeo bezpośrednio w poście (tak jak poniżej) - szczegóły w instrukcji do edytora.

Donec lacinia massa magna

//Na koniec warto podsumować artykuł i wskazać ewentualne zagadnienia dla osób, które chciałyby kontynuować zdobywanie wiedzy na dany temat

Phasellus pretium accumsan quam, sit amet auctor risus euismod a. Donec vel massa ex. Pellentesque nisi sem, pretium eget leo sed, ultricies dapibus nulla. Phasellus aliquam mollis nulla eget bibendum. Ut elit nibh, venenatis vestibulum commodo in, vestibulum at augue. Vivamus lectus nulla, vehicula in scelerisque gravida, porta non justo. Praesent elementum, risus non maximus malesuada, arcu turpis accumsan tortor, sed laoreet dolor purus non ex. Aliquam eu ligula felis. Proin et neque et neque posuere lacinia sit amet nec felis. Nunc iaculis vitae odio eget elementum. Mauris et nunc risus.

[Treker (Damian Szymański)]

Lista zmian i aktualizacji

• 02.01.2020: Publikacja pierwszej wersji szablonu.
• 13.01.2020: Dodano informację o sposobie ustawiania miniaturki dla Facebooka.
• 15.01.2020: Wydłużono treść i dodano nowe przykładowe grafiki.