Brändäys

​

Ylätunniste

Tässä osiossa käymme läpi, miten voit mukauttaa paikallisen instanssisi keskeisiä elementtejä. Voit mukauttaa sivuston otsikon, navigointilinkit, ylätunnisteen, alatunnisteen ja logon mieltymystesi mukaan.

​

Sivuston otsikko

Navigointipalkin otsikkoa voi mukauttaa ympäristömuuttujalla OVERLEAF_NAV_TITLE. Tätä tekstiä käytetään navigoinnin vasemmassa yläkulmassa, jos logoa ei ole asetettu.

# add to config/variables.env
OVERLEAF_NAV_TITLE=Our Overleaf Instance

​

Logo

Voit lisätä tekstin sijaan mukautetun logon asettamalla ympäristömuuttujan OVERLEAF_HEADER_IMAGE_URL. Arvon tulee osoittaa ulkoisesti isännöityyn kuvatiedostoon.

config/variables.env

# add to config/variables.env
OVERLEAF_HEADER_IMAGE_URL=https://mysite.somewhere.com/img/logo.png

​

Logot vaalealle ja tummalle teemalle

Versiosta 6.3.0 alkaen voit asettaa erilliset logot vaalealle ja tummalle teemalle ympäristömuuttujilla OVERLEAF_HEADER_IMAGE_URL_LIGHT ja OVERLEAF_HEADER_IMAGE_URL_DARK. Molempien arvojen tulee osoittaa ulkoisesti isännöityyn kuvatiedostoon.

# add to config/variables.env
OVERLEAF_HEADER_IMAGE_URL_LIGHT=https://mysite.somewhere.com/img/logo-light.png
OVERLEAF_HEADER_IMAGE_URL_DARK=https://mysite.somewhere.com/img/logo-dark.png

Jos jompaakumpaa muuttujaa ei ole asetettu, kyseinen teema käyttää muuttujassa OVERLEAF_HEADER_IMAGE_URL asetettua logoa.

​

Ylätunnisteen navigointilinkit

Navigoinnin ylätunnisteeseen voi lisätä ylimääräisiä kohteita asettamalla ympäristömuuttujan OVERLEAF_HEADER_EXTRAS arvoksi JSON-taulukon objekteja. Esimerkiksi:

[\
  {\
    "text": "Some link",\
    "url": "http://example.com/somelink",\
    "class": "subdued",\
    "only_when_logged_out": true\
  },\
  {\
    "text": "Help",\
    "class": "subdued",\
    "dropdown": [\
      {\
        "text": "Documentation",\
        "url": "/learn"\
      },\
      {\
        "text": "Contact Admin",\
        "url": "http://example.com/contact"\
      }\
    ]\
  }\
]

Lisää escapattu JSON-muoto tiedostoon toolkit/variables.env:

toolkit/variables.env

# add to toolkit/variables.env
OVERLEAF_HEADER_EXTRAS=[{"text":"Some link","url":"http://example.com/somelink","class":"subdued","only_when_logged_out":true},{"text":"Help","class":"subdued","dropdown":[{"text":"Documentation","url":"/learn"},{"text":"Contact Admin","url":"http://example.com/contact"}]}]

​

Alatunnisteet

Sekä vasenta että pienempää oikeaa alatunnistetta (jotka näkyvät esimerkiksi /project-sivulla) voi mukauttaa ympäristömuuttujilla OVERLEAF_LEFT_FOOTER ja OVERLEAF_RIGHT_FOOTER. Molemmat odottavat taulukkoa JSON-objekteja, jotka lisätään sivulle.

Molemmat odottavat JSON-taulukkoa, joka lisätään sivulle.

[\
  {\
    "text": "This is an example text footer entry!"\
  },\
  {\
    "text": "This is an example URL footer link!", "url" : "/my-first-link.htm"\
  }\
]

Kun käytät pelkkää text-kenttää, se ei saa sisältää HTML:ää, koska arvo näytetään raakatekstinä.

Tietojen on oltava kelvollista JSONia toimiakseen, ja lainausmerkit on escapattava, kun ne välitetään ympäristömuuttujana.

config/variables.env

# add to config/variables.env
OVERLEAF_LEFT_FOOTER=[{"text": "This is an example text footer entry!"}]
OVERLEAF_RIGHT_FOOTER=["text": "This is an example URL footer link!", "url" : "/my-first-link.htm"]

Kenttien text ja url lisäksi JSON-objekti hyväksyy myös ominaisuudet class ja label lisämukautusta varten.

​

Huoltosivu

Huoltosivulla näytettävää viestiä voi mukauttaa ympäristömuuttujalla OVERLEAF_MAINTENANCE_MESSAGE. Tämä teksti korvaa sivun otsikon alla näkyvän oletusviestin.

# add to config/variables.env
OVERLEAF_MAINTENANCE_MESSAGE=Our Overleaf Instance is down for maintenance and will be back shortly.

Jos haluat sisällyttää linkkejä tai muuta muotoilua, käytä sen sijaan muuttujaa OVERLEAF_MAINTENANCE_MESSAGE_HTML. Jos molemmat on asetettu, OVERLEAF_MAINTENANCE_MESSAGE_HTML on etusijalla.

# add to config/variables.env
OVERLEAF_MAINTENANCE_MESSAGE_HTML=Our Overleaf Instance is down for maintenance. For urgent requests, contact <a href="mailto:[e-mail]">[e-mail]</a>.

OVERLEAF_MAINTENANCE_MESSAGE näytetään pelkkänä tekstinä, joten se ei saa sisältää HTML:ää. OVERLEAF_MAINTENANCE_MESSAGE_HTML näytetään HTML:nä ilman escapausta.

Jos kumpaakaan ei ole asetettu, oletusviesti linkittää tilasivullesi, kun OVERLEAF_STATUS_PAGE_URL on asetettu, ja muussa tapauksessa näyttää ylläpitäjän sähköpostiosoitteen.