Est-il possible de fusionner deux pages créées par SandCastle en une seule page principale ?

Question

Pour chaque classe du projet, SandCastle crée (entre autres) deux pages :

• La page principale, appelée T_class_full_name avec la description, la syntaxe, la hiérarchie de l'héritage et la rubrique "Voir aussi".
• La page des membres, appelée AllMembers_T_class_full_name avec des constructeurs, des méthodes, des champs, etc.

Existe-t-il un moyen de fusionner ces deux éléments - avec les members page qui est ajouté à la page principale ?

Answer 1

Je ne peux pas fournir une réponse fonctionnelle à cette question, mais je peux proposer quelques idées qui pourraient fonctionner si quelqu'un est prêt à bricoler :

1. La configuration htmlBody.xsl définit une partie de la structure, notamment une section avec un test pour les membres : <xsl:if test="$subgroup='members'"> Si cette option était activée au niveau de la classe (ou simplement définie sur true), cela pourrait vous donner une idée de la manière dont cette sortie est produite. (Je ne pense pas qu'il y aura un paramètre magique ici).

2. C'est ici (je pense) que les liens vers les sous-groupes de membres sont ajoutés, je jouerais également avec cela :

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

3. J'ai d'autres idées en essayant de jouer avec la structure, mais il faudrait que je la pirate pour fournir une réponse claire. Je ne suis même pas sûr que le fichier htmlBody.xsl soit le bon endroit pour faire cela. Si j'avais vraiment un besoin ici, je pense que je pourrais atteindre votre objectif plus facilement en faisant ce qui suit :

• Générer la documentation de manière standard
• Analyser la documentation générée et fusionner les deux en utilisant un analyseur DOM / XML (c.-à-d. fusionner les deux dans le code et produire un nouveau document HTML à page unique avec les URL mis à jour en ancres sur la page actuelle)

L'avantage est qu'il existe un système de dénomination cohérent dans les fichiers et les liens générés. Je pense donc qu'il serait plus facile d'écrire ce processus et de mettre à jour tous les liens pour qu'ils soient des ancres que de s'embrouiller avec les modèles. Je pense en fait que ce serait assez facile à réaliser pour quelqu'un d'expérimenté dans ce type de manipulation de documents.

Avertissement : je suis loin d'être un expert de SandCastle, je ne l'ai utilisé que de façon minimale et il y a plus d'un an. Je n'ai pas non plus passé de temps avant aujourd'hui à réfléchir à la façon dont je le modifierais, je l'ai seulement utilisé tel quel. Je n'aurais même pas répondu à cette question si je n'avais pas eu d'autres réponses. Il y a peut-être une configuration supportée pour accomplir ceci, mais en tant qu'utilisateur occasionnel, je ne peux même pas penser à la façon de l'aborder.

Je fais également quelques suppositions sur l'aspect de la sortie HTML en me basant sur mon expérience avec le SHFB. Il se peut que j'aille trop loin là aussi. Je n'ai plus de projet à partir duquel je peux générer la documentation de SandCastle, mais si quelqu'un peut poster un lien vers une sortie HTML de SandCastle et est intéressé par cette approche, je serais heureux de l'aider.