WordPress.org

obecne wysiłki w zakresie dokumentacji inline WordPress naprawdę rozpoczęły się w cyklu wydania 3.7 i nabrały rozpędu wraz z postępem inicjatywy Hook docs. Dokumentacja inline lub inicjatywa “inline docs” jest projektem hybrydowym, raportowanie do rdzenia CoreCore to zestaw oprogramowania wymaganego do uruchomienia WordPress. Główny zespół programistów buduje WordPress., Zespoły dokumentacji i centrów programistycznych.

co to jest dokumentacja inline? # Czym jest inline documentation?

dokumentacja Inline dostarcza zarówno niezbędnych, jak i przydatnych informacji w postaci komentarzy inline, bloków doc i innych w kodzie źródłowym samego WordPressa.

dokumentacja inline jest parsowana z każdym wydaniem, a dokumentacja ta jest wyświetlana w odnośniku do kodu w developer.wordpress.orgWordPress.org witryna społecznościowa, w której kod WordPress jest tworzony i udostępniany przez użytkowników. To tutaj możesz pobrać kod źródłowy rdzenia WordPress, wtyczek i motywów, a także centralne miejsce do rozmów społecznościowych i organizacji. https://wordpress.org/.

Top

jak się zaangażować #jak się zaangażować

dokumentacja Inline jest uważana za dokumentację “techniczną”, więc konieczna będzie znajomość bazy kodu WordPress – musisz zrozumieć kod, aby o tym napisać.

1. Zapoznaj się ze standardem dokumentacji PHP, a także z wytycznymi formatowania i wskazówkami dokumentowania.

2. Skonfiguruj lokalną kopię wersji programistycznej bazy kodu WordPress przy użyciu różnych Vagrant Vagrants (VVV). WordPress jest wersjonowanie przy użyciu SVNSVN Apache Subversion (często w skrócie SVN, po nazwie komendy svn) jest wersjonowanie oprogramowania i system kontroli wersji. Twórcy oprogramowania używają Subversion do utrzymywania aktualnych i historycznych wersji plików, takich jak kod źródłowy, strony internetowe i dokumentacja. Jego celem jest być w większości kompatybilnym następcą powszechnie używanego systemu Concurrent Versions (CVS). Rdzeń WordPress i wordpress.org wydany kod jest centralnie zarządzany przez SVN. https://subversion.apache.org/., ale możesz także użyć GitGit Git to darmowy i open source rozproszony system kontroli wersji zaprojektowany do obsługi wszystkiego, od małych do bardzo dużych projektów z szybkością i wydajnością. Git jest łatwy do nauczenia i ma niewielki rozmiar z błyskawiczną wydajnością. Większość nowoczesnych plugin i rozwój motywu odbywa się z tego systemu kontroli wersji. https://git-scm.com/. (link VVV, jak to zrobić).

3. Przeczytaj otwarcie zgłoszenia, aby dowiedzieć się, jak utworzyć TracTrac Trac to miejsce, w którym współpracownicy tworzą problemy z błędami lub żądaniami funkcji, podobnie jak GitHub.https://core.trac.wordpress.org/. bilet.

4. Tworzenie łatek:

• zawsze aktualizuj lokalną kopię WordPress trunk przed edycją pliku i tworzeniem łatek. Stosować odpowiednio svn up lub git pull.
• Wygeneruj łatkę z katalogu głównego twojego WordPress SVN lub Git checkout. Na przykład svn diff dir/filename.php > function_name.diff.

5. Jak przesłać łatkę

istnieje jedna łatka do zgłaszania błędów dokumentacji inline i
na przykład #48303 jest taką łatką dla WordPressa 5.4.

• Dodaj komentarz i załącz plik łatki.

6. Możesz także przyczynić się do biletów Trac związanych z dokumentami inline, które wymagają iteracji.

• jeśli paragon jest oznaczony needs-patch lub needs-refresh, istnieje możliwość, że istniejąca łatka(E) może po prostu wymagać poprawek lub być odświeżona w najnowszym bagażniku. Każdy kawałek pomaga!

Top

punkty kontaktowe #punkty kontaktowe

w przypadku jakichkolwiek pytań, Pop przez kanały #docs lub #core-docs w Slack.

Top

zasoby #zasoby

• Standard dokumentacji PHP
• baza hooków Adama Browna (przydatna do podpowiedzi na temat @since wersji hooksHooks w motywie i rozwoju WordPress, Hooki są funkcjami, które można zastosować do akcji lub filtra w WordPress. Działania to funkcje wykonywane, gdy w WordPress wystąpi określone zdarzenie. Filtry pozwalają modyfikować niektóre funkcje. Argumenty użyte do zaczepiania filtrów i akcji wyglądają tak samo.)

Top

jak otworzyć nowy bilet dokumentu #Jak otworzyć nowy bilet dokumentu

zasadniczo istnieje jeden bilet, aby zgłosić błędy i ulepszenia dokumentacji wbudowanej. Ale jeśli z jakiegoś powodu potrzebujesz utworzyć nowy bilet, wykonaj poniższe kroki:

1. przeczytaj otwarcie paragonu, aby dowiedzieć się, jak utworzyć Paragon Trac.
2. Utwórz nowy bilet na Core Trac dla pliku:
   • sugerowane formaty tytułów mogą być ” korekta PHPDoc dla ścieżki / do / pliku.php “lub” popraw dokumentację dla ścieżki / do / pliku.php”.
   • Typ powinien być wadliwy (bug).
   • Przypisz paragon do komponentu, z którym skojarzony jest plik.
   • pozostaw wersję pustą.
   • Dodaj Fokus dokumentu, klikając na niego.
3. Prześlij swoją łatkę do utworzonego przez Ciebie paragonu Trac i dodaj słowo kluczowe has-patch.
4. pamiętaj, aby zostawić komentarz opisujący nowo przesłaną łatkę. Samo przesyłanie łatek nie wywołuje powiadomienia dla osób oglądających zgłoszenie.

Uwaga: zmiany w dokumentacji nie powinny łączyć się ze zmianami w kodzie (nawet spacjami), chyba że Paragon wyraźnie wymaga obu.

Ostatnia aktualizacja: 26 października 2019 r