filipedeschamps/tabnews.com.br

Exibir tabela de conteúdos (links para os títulos) na publicação

Opened this issue · 10 comments

Assunto

Contribuição

Dúvida

fiz uma parte de tópicos aonde cada titulo ficara como um tópico ao lado (no pc) do texto, isso ajudara a pessoa ir ao titulo q mais o chamou a atenção sem precisar scrolar a pagina, com um clique no tópico ele vai para o tópico, no modo celular adicionei os tópicos em cima ao botão de rolar para cima, assim ficando visualmente bonito e sem poluição na tela do usuário!

Modo Pc
image

Modo Celular
image
image

@wendesongomes obrigado pela sugestão! Me pareceu útil e interessante. Se não me engano, em 2022/2023 havia mais publicações contendo tabela de conteúdos, e sua sugestão realmente resolveria essa "dor".

Imagino que a solução possa até mesmo evoluir para algo como acontece em leitores de PDF, separando em níveis e permitindo esconder/exibir a árvore, por exemplo:

Tabela de conteúdos em um leitor de PDF na lateral esquerda, com diferentes níveis de título contendo diferentes tabulações.

Fonte.

@wendesongomes o teste que você fez foi "hard-coded" ou já é dinâmico, com base no conteúdo da publicação? Precisou criar um plugin do ByteMD?

@Rafatcb eu fiz dinâmico, quando a pessoa criar um post automaticamente detectar os títulos em markdown e assim já faz os tópicos, e reaproveitei tudo que já tinha no código não precisei adicionar nem um plugin.

Depois de ter feito varias opções de design a melhor q eu achei foi colocar ao lado direito como um botão, aonde a pessoa clica e abre um modal na direita.

O porque disto: porque colocando na tela teria que diminuir o tamanho da onde o texto esta e isso deixaria estranho para os usuários, colocando somente um botão, não causaria estranhamento nem descontentamento com algo a mais a tela do usuário.

image

@wendesongomes eu realmente gostei da sua sugestão, e apesar da sua publicação no TabNews não ter muitos comentários, não vi ninguém se opor. Na verdade, o comentário que parecia uma oposição, acredito ter sido um mal entendido, já que não temos essa funcionalidade. As tabelas de conteúdo existentes em algumas publicações foram feitas de forma manual.

PS: Só agora reparei que tem um índice no modo de edição do ByteMD, mas tenho quase certeza que não existe uma forma de inseri-lo como conteúdo sem ser digitando manualmente.

O índice no modo de edição fica ao lado direito do conteúdo que está sendo digitado.

Como você já fez a implementação, o que acha de abrir o PR para outras pessoas poderem avaliar e testar também?

Edit: Acho que pensar nisso agora pode complicar desnecessariamente a implementação, mas consigo imaginar esse menu funcionando também como um índice dos comentários, e talvez dos títulos em comentários.

@Rafatcb Boa noite, posso mandar um PR sim, qual branch eu coloco?

@wendesongomes vi que você já criou um fork do TabNews. O seu fork precisa estar atualizado (é possível atualizar pela própria interface do GitHub no seu repositório):

Exemplo para sincronizar

Depois disso, pode abrir um PR apontando do seu fork para o main deste repositório. No CONTRIBUTING.md temos algumas informações sobre o processo de PR, mas se surgirem dúvidas, pode falar aqui.

@Rafatcb eu fiz la, poderia ver se esta correto pfv?

Apenas para deixar uma referência histórica, descobri hoje que o GitHub também tem um tipo de tabela de conteúdos:

Na página principal do repositório, existe um link no canto superior direito, em cima do README, que exibe a tabela de conteúdos do README

@Rafatcb fiz uma besteira e acabei fechando o pr e ainda perdi o codigo, mas como tinha refeito a pouco tempo conseguir refazer o codigo, queria saber se tenho q fazer outro pr?

Pessoal, o PR #1686 foi fechado por inatividade, mas contém algumas informações relevantes a serem consideradas na implementação.

Caso alguém decida implementar, sugiro experimentar fazer como o GitHub, que mencionei no último comentário, pois é uma forma menos intrusiva do que o modal lateral, e é uma mecânica que já existe em outras partes do TabNews.