Materiały do zajęć - Jak pisać opis modułu?
Uniwersytet Gdański - Instytut Matematyki - Zakład Informatyki - Strona domowaJak pisać opis modułu?
Aby ułatwić proces dodawania nowych materiałów do strony zalecam zachować opisany poniżej format dokumentów. Sprawi to, że wasze opisy pojawią się szybciej, i będą zawierały mniej błędów. Oto, jak należy przygotować tekst:
- Tylko część body w formacie HTML, kodowanie utf-8.
- Encje HTML takie jak <, & muszą być zakodowane jako < &, itp.
- Kod perla w tekście powinien być umieszczony w tagach <tt>...</tt>.
- Kod perla umieszczony w osobnym bloku ma być umieszczony w tagach <code>...</code>
- Nie umieszczaj tagów <tt> wewnątrz bloków <code>.
- NIE wstawiaj do dokumentu nowych wierszy przez wpisywanie <br>! Jeżeli twoje bloki <code> nie są czytelne, bo składają się jak jedna linia, użyj arkusza styli z mojej strony, i nie renderuj kodu w IE. Wybierz Firefoxa! :P
- Każdy akapit tekstu musi być umieszczony w tagach <p>...</p>.
- Dodatkowe obrazki lub inne pliki dołączane do źródła powinny być przesłane jakby znajdowały się w podkatalogu img (obrazki) lub files (inne pliki).
- Typowe tytuły mają poziom h2, jakieś rozdzialiki wewnątrz nich h3, itp.
- Można wykorzystać malutki szablon do pisania swoich własnych plików, do pobrania stąd:
O czym należy pamiętać
- Za jeden opracowany moduł jest jeden punkt. Dotyczy to oczywiście tych, którzy studiują pod moim kierunkiem, i mają obowiązek rozliczyć się z zajęć :)
- Opracowanie danego modułu może wykonać więcej osób pod warunkiem że ich opracowania nie bedą dotyczyły tego samego materiału. Innymi słowy - mogą się uzupełniać, nie mogą się zastępować. Proszę o skonsultowanie ze mną zamiaru rozwinięcia czyjegoś opisu.
- Zamiar opracowania lub samo opracowanie modułu warto zgłosić do mnie wcześniej, aby mógł umieścić na stronie listę. Wtedy łatwiej uniknąć powtórzeń i wynikającej z tego straty czasu.
- Każde opracowanie jest sprawdzane przeze mnie i trafi na stronę dopiero po wykonaniu wszystkich zalecanych przeze mnie poprawek i rozwinięć.
Co to za znaczek COOL ?
Jest to znaczek, który nadaję modułom, których opis bardzo mi się podoba, i który uznaję za szczególnie wartościowy. Można go traktować jak taką 'wirtualną' nagrodę. Liczba punktów za każdy moduł pozostaje stała.
Znaczek wygląda tak:
Jeżeli okaże się, że opisy modułów będą naprawdę dobrze zrobione i wartościowe, kto wie, może przyznam jakiś "bonus" za staranność i wysiłek :)
Lista opracowanych do tej pory modułów
- AI::Genetic
- AI::Genetic::OpCrossover
- AI::Genetic::OpMutation
- AI::Genetic::OpSelection
- Acme::Bleach
- Acme::Morse
- Acme::Morse::Audible
- Acme::Palindrome
- Acme::ScriptoPhrenic
- Acme::Void
- Algorithm::Munkres
- Archive::Tar
- Archive::Zip
- AutoSplit
- Benchmark
- CGI::Pretty
- CAD::Drawing
- Class::Struct
- Clone
- Compass::Bearing
- Config
- Convert::Morse
- Convert::Wiki
- Crypt::RSA
- Cwd
- DBI
- DBI::pg
- DBIx
- Data::Dumper
- Date::Simple
- Digest::MD5
- Digest::SHA1
- Dir::Handle
- Encode
- Fatal
- File::Attributes
- File::Basename
- File::Compare
- File::Handle
- File::NCopy
- File::Temp
- FindBin
- Flickr::API
- Flickr::API::People
- Flickr::Upload
- GD
- Games::Maze
- Geo::IP2Location
- GetOpt::Long
- Gtk2
- HTML::GoogleMaps
- HTTP::Daemon
- Heap
- IO::File
- Image::ExifTool
- Image::ImageShack
- Image::Size
- Imager
- Inline
- LJ::Simple
- LWP
- Lingua::EN::Sentence
- List::MoreUtils
- List::Util
- MIDI
- MP3::Tag
- MPEG::ID3v2Tag
- Mail::Mailer
- Mail::MboxParser
- Mail::Pop3Client
- Math::Complex
- Math::Fibonacci
- Math::Matrix
- Math::Roman
- Math::Round
- Math::Trig
- Module::Signature
- Net::FTP
- Net::Gadu
- Net::hostent
- Net::POP3
- Net::SCP
- Net::SFTP
- Net::SSH::Perl
- Net::Time
- PDF::Parse
- Perl6::Classes
- Perl6::Interpolators
- Perl6::Parameters
- Perl6::Subs
- Perl6::Variables
- Persistent::MySQL
- Pod::HTML2Pod
- Pod::Man
- Pod::Pdf
- Pod::Text
- Pod::Usage
- Proc::Fork
- Regex::presuf
- Scalar::Footnote
- Scalar::Numbers
- Servlet::Http::HttpServlet
- Shell
- Spiffy
- Storable
- Switch
- Symbol::Approx::Sub
- Sys::Lastlog
- Term::ANSIColor
- Term::Gnuplot
- Test::Builder
- Test::Harness
- Test::More
- Test::Simple
- Text::Sentence
- Text::Soundex
- Text::TypingEffort
- Text::Wrap
- Thesaurus
- Time::gmtime
- Time::Local
- Time::localtime
- WWW::Google::Calculator
- WWW::Google::Images
- WWW::Patent::Page
- WWW::Search::ISBNDB
- WWW::Yahoo::Movies
- Win32
- Win32::Mediaplayer
- X11::Protocol
- XML::DOM
- XML::Handler::EasyTree::Generator
- XML::TreeBuilder
- XML::Ximple
[c] Piotr Arłukowicz, materiały z tej strony udostępnione są na licencji GNU.