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

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

Question

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

  • La page principale, appelée comme T_class_full_name, avec la description, la syntaxe, Hiérarchie d'héritage et Voir aussi
  • La page membres, appelé AllMembers_T_class_full_name, avec les constructeurs, méthodes, champs, etc.

Est-il possible de fusionner ces deux ensemble - avec le members page étant associées à la page principale

Était-ce utile?

La solution

Je ne peux pas donner une réponse à travailler pour cela, mais je peux donner quelques idées qui peuvent travailler si quelqu'un est prêt à pirater avec elle:

1. Le htmlBody.xsl de configuration définit une partie de la structure comprenant une section avec un test pour les membres: <xsl:if test="$subgroup='members'"> Si cela a été activé au niveau de la classe (ou juste valeur true, il peut vous donner une idée sur la façon dont la sortie est produite (I. ne pense pas qu'il y aura un cadre magique ici).

2. voici (je crois) où des liens vers les sous-groupes membres sont ajoutés, je voudrais aussi jouer avec ceci:

<!-- 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 à essayer de jouer avec la structure, mais je aurais besoin de pirater à pour fournir une réponse claire. Je ne suis même pas proche de vous que le htmlBody.xsl est l'endroit pour le faire. Si je réellement eu un besoin ici, je pense que je pourrais atteindre votre objectif le plus facile en procédant comme suit:

  • Générer la documentation de façon standard
  • Parse la documentation générée et fusionner les deux en utilisant un analyseur DOM / XML (à savoir fusionner les deux dans le code et la sortie d'un nouveau document HTML page simple avec les URL mises à jour à des ancres sur la page en cours)

La bonne chose est qu'il ya un schéma de nommage cohérent utilisé dans les fichiers générés et des liens, donc je pense qu'il serait plus facile d'écrire ce processus et mettre à jour tous les liens pour être des ancres qu'il plût au mess trop avec les modèles. Je pense que ce serait assez facile à accomplir pour quelqu'un d'expérimenté avec ce type de manipulation de documents.

Caveat: Je ne suis pas encore près d'un expert SandCastle, ayant seulement utilisé au minimum et il y a plus d'un an. J'ai pas passé à tout moment avant d'envisager aujourd'hui comment je le pirater, en utilisant uniquement hors de la boîte. Je ne aurais même pas répondu à cette exception de l'absence d'autres réponses. Il peut y avoir un moyen de configuration pris en charge pour ce faire, mais je en tant qu'utilisateur occasionnel ne peut même penser comment l'aborder.

Je fais aussi quelques hypothèses ici sur la façon dont la sortie HTML regarderais basé sur mon expérience avec le SHFB. Je peux être plus grande portée là-bas aussi. Je n'ai plus un projet que je peux générer des documents à partir 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 d'aider.

Licencié sous: CC-BY-SA avec attribution
Non affilié à StackOverflow
scroll top