Identidade visual

​

Cabeçalho

Nesta seção, mostraremos como personalizar os principais elementos da sua instância on-premises. Você pode personalizar o título do site, os links de navegação, o cabeçalho, o rodapé e o logotipo de acordo com suas preferências.

​

Título do site

O título da barra de navegação pode ser personalizado com a variável de ambiente OVERLEAF_NAV_TITLE; esse texto é usado no canto superior esquerdo da navegação se nenhum logotipo estiver definido.

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

​

Logotipo

Você pode adicionar um logotipo personalizado em vez de usar texto definindo a variável de ambiente OVERLEAF_HEADER_IMAGE_URL. Esse valor deve apontar para um arquivo de imagem hospedado externamente.

config/variables.env

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

​

Logotipos para os temas claro e escuro

A partir da versão 6.3.0, você pode definir logotipos separados para os temas claro e escuro com as variáveis de ambiente OVERLEAF_HEADER_IMAGE_URL_LIGHT e OVERLEAF_HEADER_IMAGE_URL_DARK. Ambos os valores devem apontar para um arquivo de imagem hospedado externamente.

# 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

Se alguma das variáveis não estiver definida, o tema correspondente usará o logotipo definido em OVERLEAF_HEADER_IMAGE_URL.

​

Links de navegação do cabeçalho

Itens de navegação extras podem ser adicionados ao cabeçalho de navegação definindo a variável de ambiente OVERLEAF_HEADER_EXTRAS como um array JSON de objetos. Por exemplo:

[\
  {\
    "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"\
      }\
    ]\
  }\
]

Adicione a forma JSON escapada ao 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"}]}]

​

Rodapés

É possível personalizar tanto o rodapé esquerdo quanto o rodapé direito menor (encontrados em páginas como /project) usando as variáveis de ambiente OVERLEAF_LEFT_FOOTER e OVERLEAF_RIGHT_FOOTER. Ambas esperam um array de objetos JSON que será inserido.

Ambas esperam um array de JSON que será inserido.

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

Ao usar apenas text, ele não deve conter HTML, pois o valor será renderizado como texto bruto.

Esses dados precisam ser JSON válido para funcionar, com as aspas escapadas ao serem passados como variável de ambiente.

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"]

Além de text e url, o objeto JSON também aceita as propriedades class e label para personalização adicional.

​

Página de manutenção

Você pode personalizar a mensagem exibida na página de manutenção com a variável de ambiente OVERLEAF_MAINTENANCE_MESSAGE; esse texto substitui a mensagem padrão abaixo do título da página.

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

Para incluir links ou outra formatação, use OVERLEAF_MAINTENANCE_MESSAGE_HTML. Se ambas estiverem definidas, OVERLEAF_MAINTENANCE_MESSAGE_HTML tem prioridade.

# 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 é renderizada como texto simples, portanto não deve conter HTML. OVERLEAF_MAINTENANCE_MESSAGE_HTML é renderizada como HTML sem escape.

Se nenhuma delas estiver definida, a mensagem padrão contém um link para sua página de status quando OVERLEAF_STATUS_PAGE_URL está definida e exibe o endereço de e-mail do administrador quando não está.