Como criar MSDN como links no site de documentação do Sandcastle?

Question

Gerei uma documentação do meu projeto com o Sandcastle. Este site usa quadros; portanto, quando clico em sites, meu URL no navegador não muda.

Eu gostaria de mudar o URL no navegador quando navego pela documentação do site gerada com o Sandcastle. Por quê? Porque eu gostaria de vincular -se a subpagens concretas de documentação de outras partes do meu ambiente de desenvolvedor.

Além disso, gostaria de ter esses links permanentes. Portanto, quando eu gerar mais uma vez documentação a partir da nova versão do meu projeto, os links não serão alterados para que não precise alterar todos os links para novos.

Isso é possível e como comparar isso?

Answer 1

Para criar links corretos para subpáginas específicas da documentação, você pode usar uma solicitação semelhante: $ documentação_root $/index.aspx? Tópico = html/$ tópico_id $ .htm

Por exemplo http://www.ewoodruff.us/shfbdocs/index.aspx?topic=html/8dcbb69b-7a1a-4049-8e6b-2bf344efbbc9.htmao invés de http://www.ewoodruff.us/shfbdocs/html/8dcbb69b-7a1a-4049-8e6b-2bf344efbbc9.htm

Answer 2

Se você adicionar o código abaixo ao topo de SplitScreen.js O navegador "injetará" o quadro do TOC e se concentrará no conteúdo que você vinculou diretamente (usando o truque Vitaly Shibaev mostrou).

if (window==top) {
    window.location = "/?topic=" + (window.location.pathname.substring(1));
}

Este código funciona, a documentação é colocada na raiz do seu site-se você o tiver em um sub-folds, precisa expandir "/? Tópico" e remover a parte do sub-dobrador da parte do nome do caminho.

Com essa alteração, você pode usar os "links diretos". Eu também espero que as pessoas que o encontrem via Google obtenham uma experiência melhor (obtendo o conteúdo que procuraram e a barra do TOC).

Answer 3

Vitaliy e mawtex resolveu a parte 'Como vincular a documentação' parte da sua pergunta.

Os links "tornando os links permanentes para que não mudem ao regenerar a parte da documentação" de suas perguntas são resolvidos automaticamente, pois os nomes de arquivos HTML criados são baseados em um hash do nome do tópico por padrão. Ou seja, se você não alterar a parte do seu código que está documentando, ele usará o mesmo nome de arquivo.

Você pode alterar a maneira como os nomes de arquivos HTML são gerados, mas todos os métodos determinados são baseados no nome do membro ou em um hash do ID do tópico, para que os links não sejam quebrados se o código não tiver alterado.

Veja o Sandcastle Ajuda File Builder's NamingMethod documentação para mais informações.