PMIS Website Repository Documentation

Objavite izbrane lokalne repozitorije in README-je njihovih dodatkov na spletnem mestu Odoo 18 Community. Noben repozitorij se ne objavi samodejno.

Funkcionalnosti

Javni seznam repozitorijev na /documentation.
Ločena izbira in objava repozitorijev za vsako spletno mesto.
README-ji Markdown, reStructuredText, HTML in navadnega besedila v postavitvi spletnega mesta.
Povezave med pregledi repozitorijev in README-ji dodatkov, vključno z lokalnimi slikami in značkami.
Prenosi povezanih priročnikov PDF in podpisanih vzorcev v .docs/media/pdf.
Povezani priročniki Markdown in reStructuredText v gnezdenih mapah repozitorija, prikazani z relativnimi povezavami, sidri in lokalnimi slikami.
Sprotno branje lokalnih datotek: posodobitve repozitorija se pokažejo ob naslednji zahtevi strani.
Ograjeni bloki kode Markdown ohranijo večvrstične ukaze pod elementi seznamov.
Naslovi in besedilo dokumenta zagotovijo privzete naslove strani in iskalne opise.
Optimize SEO prepozna ključne fraze prek prelomov izvornih vrstic in nedeljivih presledkov brez spremembe prikazanega besedila ali blokov kode.
Jeziki spletnega mesta izberejo prevedene sorodne datoteke Markdown in RST, z angleškim nadomestnim virom.
Objavljeni pregledi repozitorijev in README-ji dodatkov so na zemljevidu spletnega mesta Odoo. Iskalniki lahko odkrijejo povezane priročnike prek prikazanih povezav.

Nastavitve

Modul je odvisen od website ter paketov Python markdown in docutils. Manifest paketa deklarira, ne namesti.

Namestite pmis_website_readme.
Kot skrbnik Settings odprite Website > Configuration in v skupini menijev Configuration izberite Documentation Repositories.
Ustvarite zapis in izberite nastavljeno mapo dodatkov Odoo, sorodni repozitorij Git ali izrecno nastavljeni dodatni repozitorij. Mapa mora vsebovati korenski README, ki ga proces Odoo lahko bere.
Nastavite prikazno ime, identifikator URL in spletno mesto. Na primer izberite stock-accounting ali pmis-beta in uporabite isto ime za identifikator URL.

Za dostop iz glavne navigacije dodajte običajno menijsko povezavo spletnega mesta na /documentation. Namestitev ne spremeni obstoječih spletnih menijev.

Repozitorije zunaj drevesa dodatkov lahko dovolite s sistemskim parametrom pmis_website_readme.additional_source_paths pod Settings > Technical > Parameters > System Parameters v razvijalskem načinu. Vnesite absolutne poti map, ločene z vejicami ali novimi vrsticami. Namestitev ali nadgradnja na 18.0.1.0.1 vnese /srv/pmiverse/_pmiconfig; poznejše nadgradnje ohranijo skrbniške spremembe. Te poti ne omogočijo odkrivanja sorodnih repozitorijev in še zahtevajo izrecno objavo za vsako spletno mesto.

Uporaba

Pred javno objavo preglejte pregled repozitorija, README-je dodatkov, dokumente Markdown in RST ter povezane slike.
Na zapisu repozitorija omogočite Published in shranite.
Uporabite Open Website ali obiščite /documentation na izbranem mestu.
Odprite pregled repozitorija in pod Addon documentation izberite README dodatka.
Za odstranitev javnega dostopa izključite Published ali arhivirajte zapis.

Spremembe lokalnih datotek se pokažejo ob naslednji zahtevi strani; za osvežitev vsebine nadgradnja modula ni potrebna.

Prevodi dokumentov

Angleški vir in prevod hranite v isti mapi in formatu. Za slovenščino postavite README_si.md ob README.md ali usage_si.rst ob usage.rst. Obe kodi Odoo sl in sl_SI izbereta sorodno datoteko s pripono _si, tudi pri spletnih mestih s prevodi sl.po. Drugi jeziki uporabljajo osnovno kodo jezika, na primer usage_de.md za nemščino.

Izvirni URL dokumenta obiščite prek izbirnika jezika spletnega mesta. Če prevoda ni, se prikaže angleški vir. Angleščina vedno uporablja vir. Izbrani dokument zagotovi naslov strani, iskalni opis ter reference slik in prenosov PDF. Relativne povezave delujejo iz mape izbrane datoteke. Seznami dodatkov in zemljevid mesta ohranijo izvirne URL-je dokumentov; Odoo upravlja jezikovne predpone spletnega mesta.

Priročnike hranite v repozitoriju in jih povežite iz README-ja ali drugega dokumenta. V Markdown na primer uporabite [Setup](docs/setup.md#installation) ali v RST:

`Setup <docs/setup.rst#installation>`_

Oboje odpre prikazani priročnik na spletnem mestu. Povezave in slike se razrešujejo glede na mapo dokumenta; povezave v nadrejene mape delujejo, če ostanejo znotraj izbranega repozitorija.

Markdown znotraj samostojnih razkrivnih blokov <details> se samodejno izriše, vključno z lokalnimi značkami SVG. Izrecni markdown="0" ohrani vsebino bloka nerazčlenjeno. Lokalne slike Markdown in RST uporabljajo končno točko virov repozitorija; zunanje slike HTTP(S) ohranijo prvotne URL-je.

Podprte so slike in diagrami v .docs/images repozitorija. V korenskem README-ju ali priročniku uporabite relativno povezavo, npr. ![Site](.docs/images/site.png). Strežejo se samo povezane slike podprtih formatov. Podprti so tudi PDF-ji v .docs/media/pdf, npr. [Signed measurement](.docs/media/pdf/report.pdf). Prenosi ohranijo bajte datoteke, tudi obstoječa podpisna dokazila. Strežejo se samo PDF-ji, povezani iz dostopnega dokumenta; druge skrite datoteke in prenosi ostanejo izključeni.

Objava in dostop

Repozitorije lahko nastavljajo samo skrbniki Settings. Zaledni zapisi so omejeni na njihova dovoljena podjetja. Javni obiskovalci lahko berejo samo aktivne, objavljene zapise trenutnega spletnega mesta; ugibanje URL-ja drugega repozitorija omejitev ne obide. Umik objave ali arhiviranje odstrani javni dostop, tudi do slik.

Objava vključuje korenski README, README-je v neposrednih mapah dodatkov z __manifest__.py ter neskrite datoteke .md in .rst kjer koli v repozitoriju. Ti dokumenti so dosegljivi z neposrednim URL-jem tudi brez povezave iz README-ja. To ni odvisno od namestitve dodatkov. Pred objavo preglejte vso to vsebino. Zunanje povezave in slike ostanejo zunanje zahteve brskalnika; strežnik jih ne pridobiva.

Lokalne slike in prenosi PDF se strežejo samo ob sklicu iz dovoljenega dokumenta. Poti morajo ostati v izbranem repozitoriju, tudi po razrešitvi simbolnih povezav. Izvorna koda, poljubni prenosi, metapodatki Git in druge skrite mape so izključeni; .badges je dovoljen za dokumentacijske značke, podprte slike v korenskem .docs/images za zaslonske slike in diagrame ter PDF-ji v korenskem .docs/media/pdf za prenose. Skrite datoteke in podmape znotraj teh map ostanejo izključene, enako simbolne povezave na drugo skrito vsebino.

Izris onemogoči vključevanje datotek in direktive raw v RST, očisti HTML ter odstrani vgrajene sloge in skripte. Odgovori slik SVG uporabljajo omejujočo varnostno politiko vsebine. Brskalniki in posredniki odgovorov ne predpomnijo. Omejeni procesni predpomnilnik izrisa se razveljavi ob spremembi metapodatkov izvorne datoteke.

Znane omejitve

Viri morajo biti že lokalno uvedeni. Dovoljene so nastavljene poti dodatkov in neposredni sorodni repozitoriji Git, če ima nastavljena pot mapo ali datoteko .git. To vključuje repozitorije brez dodatkov, kot je pmis-i18n-extra, brez dodajanja na pot dodatkov Odoo. Izrecne dodatne poti podpirajo druge lokacije, npr. /srv/pmiverse/_pmiconfig. Odkrivanje ni rekurzivno in ne sledi sorodnim simbolnim povezavam zunaj skupne nadrejene mape. Skrite sorodne mape so izključene. Dodatek ne klonira repozitorijev, ne pridobiva sprememb Git in ne kliče API-ja gostovanja Git.
Izbira README daje prednost README.md, README.rst, README.html, README.txt in nato README. Imena datotek razlikujejo velike in male črke.
Dokumenti so omejeni na 2 MiB, lokalne slike na 5 MiB in prenosi PDF na 20 MiB.
Gnezdena dokumentacija podpira končnici .md in .rst z razlikovanjem velikosti črk. Za druge formate veljajo omejitve korenskih/dodatkovnih README-jev. Povezave do kode in poljubni prenosi niso izpostavljeni. Povezani PDF-ji v .docs/media/pdf so edina izjema. Nepodprte lokalne povezave so prikazane brez klikljivega cilja.
Objava velja za repozitorij in spletno mesto, ne za posamezen dodatek ali jezik. Prevodi delijo stanje objave vira.
Izvirni slogi strani HTML se nadomestijo s slogi spletnega mesta.