Markdown: mudanças entre as edições

De BIS Wiki
Ir para navegação Ir para pesquisar
Criou página com 'Markdown é uma linguagem de marcação baseada no Wikipédia ou na Markdown Language que permite que o BIS tenha um padrões de marcação...'
 
Sem resumo de edição
Linha 1: Linha 1:
Markdown é uma linguagem de marcação baseada no Wikipédia ou na [[https://www.markdownguide.org/|Markdown Language]] que permite que o BIS tenha um padrões de marcação de formatação do texto que possa ser convertido para outros formatos, como HTML, POSTSCRIPT, RichText, Console, etc.
Markdown é uma linguagem de marcação baseada no Wikipédia ou na [https://www.markdownguide.org/ Markdown Language] que permite que o BIS tenha um padrões de marcação de formatação do texto que possa ser convertido para outros formatos, como HTML, POSTSCRIPT, RichText, Console, etc.
 
Exemplos de aplicação:
* Ao escrever relatórios de Log, podemos ter um conteúdo único e será formatado adequadamente em HTML quando exibido na Web, ou formatado adequadamente quando impresso dentro de um PDF;
* Escrever mensagens de notificação que podem ir por e-mail, por texto SMS, por WhatsApp, etc.
* Converter um texto de colunas para uma impressora térmica, ou para gerar um PDF, ou exibir o mesmo conteúdo na tela.
 
 
{{nota|Diversidade e Compatibilidade|Devido aos diversos destinos que um mesmo texto de marcação pode ser convertido, é importante que ao escrever o texto se tenha alguma noção dos destinos que a mensagem será utilizada. Pois além da formatação temos questões como tamanhos e fontes de textos e efeitos que sejam ou não suportados.
 
Por exemplo, um destino aceita a configuração de fonte de largura fixa e outro não, fazendo com que o texto não fique formatado em colunas. Outro destino aceita uma fonte destacada ou em negrito e em outro apenas uma fonte normal.
 
De forma geral as formatações de Markdown não especificam atributos exatos como tamanho de texto, negrito e etc.. Mas sim efeitos como "título de nível 1", "nível 2", texto destacado, centralizado, etc. Assim, uma marcação pode ter resultado diferentes em cada destino mas de forma geral causar a mesma impressão/efeito. Quando não é possível criar o efeito, a marcação é simplesmente ignorada.}}
 


= Funcionamento =
= Funcionamento =


# Cada linha deve ser separada com os caracteres "\r\n".
# A classe utilitária BUMarkdown contém os métodos de '''convert...(...)''' que farão a conversão de um texto de Markdown para o formato escolhido.
#: ''Estes métodos já tomam cuidado para não permitirem códigos nocívos, como em casos de HTML e JavaScript''.
# O markdown pode inclusiver ser ensinado e utilizado pelo usuário para gerar conteúdos.




= Tabela de Marcações e Conversões =
= Tabela de Marcações e Conversões =

Edição das 19h59min de 31 de outubro de 2020

Markdown é uma linguagem de marcação baseada no Wikipédia ou na Markdown Language que permite que o BIS tenha um padrões de marcação de formatação do texto que possa ser convertido para outros formatos, como HTML, POSTSCRIPT, RichText, Console, etc.

Exemplos de aplicação:

  • Ao escrever relatórios de Log, podemos ter um conteúdo único e será formatado adequadamente em HTML quando exibido na Web, ou formatado adequadamente quando impresso dentro de um PDF;
  • Escrever mensagens de notificação que podem ir por e-mail, por texto SMS, por WhatsApp, etc.
  • Converter um texto de colunas para uma impressora térmica, ou para gerar um PDF, ou exibir o mesmo conteúdo na tela.


Diversidade e Compatibilidade
Devido aos diversos destinos que um mesmo texto de marcação pode ser convertido, é importante que ao escrever o texto se tenha alguma noção dos destinos que a mensagem será utilizada. Pois além da formatação temos questões como tamanhos e fontes de textos e efeitos que sejam ou não suportados.

Por exemplo, um destino aceita a configuração de fonte de largura fixa e outro não, fazendo com que o texto não fique formatado em colunas. Outro destino aceita uma fonte destacada ou em negrito e em outro apenas uma fonte normal.

De forma geral as formatações de Markdown não especificam atributos exatos como tamanho de texto, negrito e etc.. Mas sim efeitos como "título de nível 1", "nível 2", texto destacado, centralizado, etc. Assim, uma marcação pode ter resultado diferentes em cada destino mas de forma geral causar a mesma impressão/efeito. Quando não é possível criar o efeito, a marcação é simplesmente ignorada.


Funcionamento

  1. Cada linha deve ser separada com os caracteres "\r\n".
  2. A classe utilitária BUMarkdown contém os métodos de convert...(...) que farão a conversão de um texto de Markdown para o formato escolhido.
    Estes métodos já tomam cuidado para não permitirem códigos nocívos, como em casos de HTML e JavaScript.
  3. O markdown pode inclusiver ser ensinado e utilizado pelo usuário para gerar conteúdos.


Tabela de Marcações e Conversões