Encyklopedia, ew. zmiany

0

Dobiera zabieram sie za encyklopedie (w koncu ;)) i czekam na jakies propozycje. Czy zostawic tak jak jest teraz. Dryobates cos mowil, ze ma jakas koncepcje, ale nie powiedzial w koncu jaka ;)

0

Ja chciałbym aby encyklopedia zawierała tyle informacji co help albo więcej. Dlatego przydałoby się zrobić coś takiego jak:

  • znacznik, czy dana własność jest tylko do odczytu, czy jest w sekcji protected itd.
  • przy liście metod etc. pokazywać jaka pochodzi z jakiego obiektu (hierarchia).
0

Co prawda nie korzystam z encyklopedii, ale jak już robicie taką wypaśną, to może coś takiego jak w dokumentacji Javy.
Nie tylko link do klasy bazowej, ale także do znanych klas dziedziczących z aktualnie opisywanej.

0

Dryobates cos mowil, ze ma jakas koncepcje, ale nie powiedzial w koncu jaka ;)

Z tego co ja kombinowałem to byłoby za dużo przeróbek z tego co już mamy, a nie jestem też pewien czy ew. zyski zrównoważyłyby to.
Tak więc jedynie poprawki do tego co jest:

  1. Jak już Marooned wspomniał przydałoby się automatyczne dodawanie listy klas dziedziczących. Jeżeli dodaję do encyklopedii jakąś klasę i zaznaczam, że dziedziczy ona np. z TComponent to w TComponent przydałaby się lista (być może taka sama jak z metodami) z klasami dziedziczącymi. To jest wyjście poza help Delphi/BCB
  2. Oczywiście trzeba naprawić znany błąd z usuwaniem dziedziczonych metod (moderatorzy i admini wiedzą o co chodzi). Ponadto powinno być chyba analogicznie do helpa Delphi. Jeżeli metoda: Test jest dziedziczona w klasie Kl2 z klasy Kl1 to przy wyświetlaniu tej metody powinna być wyświetlana klasa Kl1, aby użytkownik wiedział, że zmienia metodę tej klasy i podrzędnych, a nie np. tylko podrzędnej (już mi się coś takiego zdarzyło).
  3. Tak jak Szymek powiedział przydałob się oznaczenie czy to jest metoda protected i read-only. Ponieważ jednak dziedziczone metody nie są kopiowane (co zresztą nie miałoby sensu) to potrzebny jest chyba znacznik już w klasie która odziedziczyła (nie pamiętam w tej chwili jak wygląda tabela z klasą i metodami...)
  4. Przydałyby się pola wydzielone na nagłówek funkcji, opis, przykład, linki itp. Dzięki temu możnaby zachować jednolity wygląd całej encyklopedii, a ponadto możnaby mieć dwa pola: Delphi i BCB z nagłówkami zależnymi od obydwu i w zależności czy to jest Encyklopedia Delphi czy BCB (tzn. skąd kliknięto) wyświetlałby się odpowiedni opis (przypominałoby także o tym, by BCB także uzupełniać). Opis generalnie jest identyczny dla jednego i drugiego.
    To niestety wiąże się z odrobiną pracy ludzkiej. Ale od lipca oddaję się do dyspozycji serwisu :)
  5. W nawiązaniu do wcześniejszego punktu: mając już te pola muszą one być uzależnione od typu wyświetlaniej strony(metoda/właściwość/zdarzenie czy opis klasy czy może zmiennych globalnych lub typów).
  6. Modyfikowalna lista przykładów. Tzn. aby przykłady mógł dopisywać nie tylko autor i moderatorzy. Najlepiej, żeby przykłady nie były od razu wyświetlane, ale jedynie jako linki. Dzięki temu możnaby jeden przykład do wielu metod/klas użyć (jak to mam miejsce w helpie). Ponadto możnaby użyć linków zewnętrznych do FAQ lub artykułów (a w FAQ przydałaby się możliwość użycia taga 'link' działającego analogicznie jak w encyklopedii, aby można było wygodnie sprawdzić co dana funkcja robi).
  7. Informowanie o zmianach w podanym temacie encyklopedii dla osób, które zaznaczą taką chęć. Czasem przydaje się śledzić zmiany w ciekawych fragmentach encyklopedii (np. nieudokumentowane elementy pomocy Delphi lub WinAPI).
  8. Możliwość usuwania komentarzy przez moderatorów (i to już nie tylko chodzi o encyklopedię). Nie chce mi się męczyć LKSa za każdym razem jak komentarz jest błędny lub nieaktualny (rozmowa Kapustka vs. Marooned :-D )

Troszkę dużo próśb, a najważniejsze z mojego punktu widzenia to te wymagające największego wkładu pracy ludzkiej :(

0

Mysle, ze wiekszosc tego da sie zrobic :)
I chyba jeszcze tabele z typami danych? Np. TShiftState itp... ?

1 użytkowników online, w tym zalogowanych: 0, gości: 1