Egenverk Docs Viewer · Dokumentation

Felsökning

Läsvyn är tom

Står det No documentation yet under Verktyg → Docs Viewer:

• Klicka på Scan for docs.
• Står det Ask an administrator to run a scan. och syns ingen knapp saknar ditt konto behörigheten manage_options. Be en administratör köra skanningen.
• Hittar skanningen ändå inget har inget tillägg eller tema någon dokumentationsfil i roten eller i docs/.
• På multisite efter nätverksaktivering: varje webbplats bygger sitt index vid nästa besök i admin av en administratör.

En fil eller ett tillägg saknas

• Ändrade du filer via FTP eller git? Klicka på Scan for docs. Den automatiska omskanningen sker bara när ändringen görs genom WordPress.
• I roten av en mapp visas bara Markdown- och textfiler (.md, .markdown, .mdown, .txt). Andra format visas bara om de ligger i docs/.
• PHP-filer visas aldrig, och mapparna node_modules, vendor, .git, bin och build hoppas över.
• Tillägg som bara är en PHP-fil direkt i wp-content/plugins skannas inte, eftersom de saknar egen mapp. Detsamma gäller must-use-tillägg som inte ligger i en egen mapp under wp-content/mu-plugins.
• I docs/ går skanningen högst åtta nivåer ner i undermappar.
• Tilläggsmappar vars namn innehåller ett kolon hoppas över.

File could not be read

Filen fanns vid senaste skanningen men går inte att läsa nu, till exempel för att den har flyttats eller tagits bort. Klicka på Scan for docs.

Länkarna saknas på Tillägg-sidan

• Öppna tillägget i läsvyn och kontrollera att Show “View Docs” link on the Plugins page är påslagen. Är den avslagen visas varken View Docs, Changelog eller What’s new.
• Changelog visas bara när tillägget har en CHANGELOG eller readme.txt i roten.
• Länkarna visas bara för användare som får öppna läsvyn.
• Teman och must-use-tillägg har ingen rad på Tillägg-sidan och får därför inga länkar.
• Nätverksadminens Tillägg-sida har inga länkar; använd webbplatsens egen Tillägg-sida.

Changelog öppnas inte vid min version

Länken öppnar avsnittet vars rubrik är den installerade versionen. Saknas ett sådant avsnitt öppnas filen vid rubriken Changelog. Versionen matchas som hel version, så 2.2.1 träffar inte 2.2.10.

What’s new visas inte eller har försvunnit

• Bara tillägg följs, inte teman eller must-use-tillägg.
• Tillägget behöver en CHANGELOG i Markdown eller en readme.txt i roten. En CHANGELOG.txt i ren text räcker inte.
• Länken visas inte när länkarna är avslagna för tillägget.
• Länken försvinner för alla när en administratör har öppnat den, och annars efter 30 dagar. Den tas också bort om tillägget nedgraderas under den annonserade versionen.
• Hittar Docs Viewer inga versionsavsnitt att kapa visas hela ändringsloggen.

Sökningen hittar inget eller för mycket

• Skriv minst två tecken, annars står det Type at least 2 characters to search. Fältet tar högst 100 tecken.
• No documents match. betyder att inget skannat dokument innehåller frågan.
• Högst 100 filer listas. Gör frågan smalare om du får för många träffar.
• Sökningen går bara igenom skannade dokument, aldrig källkod utanför docs/ eller PHP-filer.
• Filer som inte är UTF-8 läses som ISO-8859-1.

En länk eller bild i ett dokument fungerar inte

• En relativ länk öppnas i läsvyn bara om den pekar på ett skannat dokument i samma tillägg, eller på en mapp med en README. Annars visas den som vanlig text.
• En relativ bild visas bara om den ligger inuti tilläggets egen mapp och har en bildfiländelse. Annars visas bildens alt-text.

Dokumentet ser inte ut som på GitHub

Formateraren täcker det som tilläggsdokumentation brukar använda, men inte allt. Rå HTML visas som text, och referenslänkar, fotnoter och understrukna rubriker stöds inte. Se Läsvyn.

Inga adminmeddelanden på läsvyns sida

Det är avsiktligt. Alla adminmeddelanden döljs på läsvyns sida så att de inte hamnar mitt i dokumentet. De visas som vanligt på övriga adminsidor.

Ett gammalt bokmärke till Docs Viewer

Läsvyn låg tidigare på admin.php?page=egenverk-docs-viewer. Den adressen skickas vidare till Verktyg → Docs Viewer med samma tillägg, fil och sökning. Uppdatera gärna bokmärket till den nya adressen, se Referens.

Fortfarande problem

Kontakta oss och berätta vilken version av Docs Viewer, WordPress och PHP du har.