É possível mesclar duas páginas criadas pelo Sandcastle em uma única página principal?

StackOverflow https://stackoverflow.com/questions/2048687

Pergunta

Para cada aula do projeto, o Sandcastle cria (entre outros) duas páginas:

  • A página principal, chamada como T_class_full_name, com a descrição, sintaxe, hierarquia de herança e ver também
  • A página dos membros, chamada como AllMembers_T_class_full_name, com construtores, métodos, campos, etc.

Existe uma maneira de mesclar esses dois juntos - com o members page sendo anexado à página principal?

Foi útil?

Solução

Não posso fornecer uma resposta de trabalho para isso, mas posso oferecer algumas idéias que podem funcionar se alguém estiver disposto a invadir com isso:

1. O config htmlbody.xsl define parte da estrutura, incluindo uma seção com um teste para os membros: <xsl:if test="$subgroup='members'"> Se isso foi ativado no nível da aula (ou apenas definido como TRUE, pode dar uma idéia sobre como essa saída é produzida. (Não acho que haja uma configuração de bala mágica aqui).

2. Aqui está (eu acho) onde os links para os subgrupos de membros são adicionados, eu também brincaria com isso:

<!-- add a link to the member list section for this subgroup -->
<a href="#{$elementVisibility}Toggle" onclick="OpenSection({$elementVisibility}Toggle)">

3. Tenho outras idéias tentando brincar com a estrutura, mas eu precisaria invadi -la para fornecer qualquer resposta clara. Não estou nem perto de ter certeza de que o htmlbody.xsl é o lugar para fazer isso. Se eu realmente tivesse uma necessidade aqui, acho que poderia alcançar seu objetivo mais fácil, fazendo o seguinte:

  • Gerar a documentação da maneira padrão
  • Analise a documentação gerada e mescla os dois usando um analisador DOM / XML (ou seja, mescla os dois no código e produz um novo documento HTML de página única com os URLs atualizados para as âncoras na página atual)

O bom é que existe um esquema de nomeação consistente usado nos arquivos e links gerados, então eu acho que seria mais fácil escrever esse processo e atualizar todos os links para serem âncoras do que faria para mexer demais com os modelos . Na verdade, acho que isso seria muito fácil de realizar para alguém com experiência nesse tipo de manipulação de documentos.

Advertência: Eu não estou nem perto de um especialista em castelo de areia, tendo usado apenas o mínimo e mais de um ano atrás. Também não gastei a qualquer momento antes, considerando como o invadiria, apenas usando -o para fora da caixa. Eu nem teria respondido a isso, exceto pela falta de outras respostas. Pode haver uma maneira de configuração suportada para conseguir isso, mas eu, como usuário casual, não consigo pensar em como abordar.

Também estou fazendo algumas suposições aqui sobre como a saída HTML ficaria com base na minha experiência com o SHFB. Eu também posso estar em excesso por lá. Não tenho mais um projeto do qual possa gerar documentação de castelo de areia, mas se alguém puder postar um link para alguma saída HTML do Sandcastle e estiver interessada nessa abordagem, ficaria feliz em ajudar ainda mais.

Licenciado em: CC-BY-SA com atribuição
Não afiliado a StackOverflow
scroll top