Doc-O-Matic

Doc-O-Matic Professionnel (anciennement Doc-O-Matic)

Doc-O-Matic Professionnel vous permet de développer, gérer et maintenir à la fois la documentation du code source et les projets de rédaction d’aide. Avec ses fonctionnalités avancées de gestion et de contrôle qualité et sa grande variété de formats de sortie, il convient à tout type de projet, quelle que soit sa taille.

Cette version prend en charge C/C++, C#, Delphi, VB.NET, IDL, Java, ASPX, JSP, JavaScript, Matlab et PHP. La documentation du code source peut être réalisée dans le code source et en dehors du code source, les fichiers source Unicode et ANSI sont pris en charge.

Doc-O-Matic Professionnel permet de créer de l’aide en ligne et des documents imprimables à partir d’une seule source. Il prend en charge les formats de sortie PDF, Aide Web/Aide basée sur le navigateur, Aide HTML, Aide 2, Aide Windows et XML. La rédaction de la documentation et la conception de la sortie sont complètement séparées, cibler différents publics avec plusieurs configurations et paramétrages n’a jamais été aussi facile.

Les fonctionnalités d’assurance qualité de Doc-O-Matic Professionnel vous aident à identifier facilement et rapidement les domaines pouvant être améliorés. Les projets peuvent être partitionnés en modules, les projets peuvent être interconnectés et les hiérarchies de classes vous aident à vous y retrouver.

Les fonctionnalités incluent :

Prend en charge C++, C#, VB.NET, Delphi, Java et IDL

• Générer de l’aide en ligne, des documents imprimables et de la documentation portable à partir de la même source.
• Aidez votre public à mieux comprendre le code source en fournissant automatiquement et sans effort des informations telles que les hiérarchies de classes et les aperçus de navigation.
• Intégrez la documentation générée dans d’autres systèmes comme Microsoft MSDN et l’aide de Borland, en garantissant le même aspect et la même convivialité que l’original.
• Gérer de grands projets et des clusters de projets avec des fonctionnalités comme les projets principaux, les bases de données de projets
  • Contrôlez la qualité de la documentation en utilisant le gestionnaire de contrôle qualité et en ligne de commande.
  • Offrez aux rédacteurs techniques un accès facile au code source et à sa documentation en fournissant un outil avec lequel ils peuvent travailler.
  • Utilisez la documentation existante avec le plus haut degré de flexibilité d’importation possible.
  • Tirez parti de la puissance et du savoir-faire de l’outil commercial leader de l’industrie.

  Retour en haut

  Doc-O-Matic SRC

  Doc-O-Matic SRC est l’outil de choix pour les projets de documentation de code source et le développement d’aide à l’application. Doc-O-Matic SRC prend en charge nativement les langages de programmation C/C++, C#, Delphi, VB.NET, IDL, Java, ASPX, JSP, JavaScript, Matlab et PHP.

  Il génère une aide en ligne en HTML/Web Help, HTML Help, Help 2 et Windows Help prête à être intégrée dans d’autres systèmes d’aide tels que Microsoft MSDN et l’aide de l’IDE Borland.

  Doc-O-Matic SRC est le successeur combiné des produits précédemment vendus Doc-O-Matic pour C++, Doc-O-Matic pour .NET, Doc-O-Matic pour Delphi et Doc-O-Matic pour Java. Toutes ces éditions ont été fusionnées en Doc-O-Matic SRC, ajoutant une grande valeur car elles apportent un support pour des langages de programmation précédemment non pris en charge. Toutes les éditions précédentes peuvent être mises à niveau vers Doc-O-Matic SRC ou Doc-O-Matic Professional.

  Les fonctionnalités incluent :

  Prise en charge des projets C++, C++ .NET, Developer Studio et C++ Builder

  • Générer une aide en ligne pour vos composants, bibliothèques et applications.
  • Intégrer votre aide dans d’autres systèmes d’aide sans effort.
  • Produire une documentation qui s’intègre parfaitement dans des systèmes d’aide populaires tels que MSDN ou Borland Help en utilisant le même style de sortie.
  • Documenter du code source dans une grande variété de langages de programmation.
  • Créer une documentation dans le code source et hors du code source, selon vos préférences.

  Doc-O-Matic pour l’auteur

  Doc-O-Matic pour l’auteur

  Doc-O-Matic for Authoring est l’outil idéal de création d’aide (HAT) pour le développement d’aides en ligne générales, d’aides d’application, de manuels et de documentation de tout type.

  Il s’agit d’un HAT à source unique proposant une aide Web/HTML basée sur un navigateur, une aide HTML, une aide 2, un PDF, une aide Windows et une sortie XML. Il est doté d’un ensemble de fonctionnalités riches pour la création et la gestion de projets de toute taille.

  Les fonctionnalités de gestion de projet comprennent un concepteur de TOC visuel qui vous donne un contrôle total sur les sujets exportés, plusieurs configurations par projet avec différents ensembles de sujets ainsi qu’un éditeur de sujet intégré entièrement développé.

  Les fonctionnalités d’auteur et de réutilisation de texte comprennent des extraits, des libellés, des variables de texte, l’insertion automatisée d’extraits, du texte conditionnel aux niveaux des caractères, des sections et des sujets, et bien d’autres encore.

  Les fonctionnalités incluent :

  Prise en charge de Delphi et des projets Delphi

  • Rédiger une aide en ligne, des manuels d’utilisation et toutes sortes de documentation, y compris des pages Web.
  • Rédiger toute la documentation de l’entreprise, des fichiers read me et des dépliants aux grands systèmes d’aide composés de milliers de sujets avec le même outil.
  • Générer une documentation entièrement interconnectée dans une aide Web personnalisable, une aide HTML, une aide MS Help 2, une documentation imprimée en PDF et une sortie XML, le tout à partir d’une seule source.
  • Importer des informations existantes à partir de fichiers HTML, de fichiers texte et de documents XML.
  • Réutiliser le texte avec des fonctionnalités telles que des extraits, des variables de texte et des libellés.
  • Séparer complètement le processus de rédaction de la conception de l’aspect et de la convivialité de la documentation.
  • Aborder des projets de toute taille avec une interface utilisateur claire, professionnelle et facile à utiliser qui ne vous décevra pas.
  • Travailler comme vous en avez l’habitude avec l’éditeur de sujet intégré.

  Nouvelles fonctionnalités de la version 6.5

  Il s’agit d’une mise à jour majeure de la version 6, une mise à jour vers cette version est fortement recommandée. Les anciennes versions 6.x ne sont plus prises en charge à partir de la version 6.5. Les mises à niveau sont gratuites pour les clients existants en 6.x.

  Nouveau

  • Doc-O-Matic prend désormais en charge les extensions de syntaxe de langage générique CodeGear Delphi 2009.
  • Ajoute la base de données de liens Delphi 2009 pour un lien automatique avec le système d’aide Delphi 2009.

  Modifié

  • Les préfixes d’index plus longs sont désormais préférés aux courts. Cela signifie que le préfixe le plus long disponible qui correspondra sera utilisé pour la suppression du préfixe d’index.

  Corrigé

  • Corrige un problème avec les catégories d’index dans les sorties basées sur HTML et PDF qui fait que les caractères non-ASCII ne commencent pas une catégorie et sont plutôt ajoutés à la dernière catégorie.
  • Corrige un problème causant des sujets qui utilisent des sujets de copie qui ne sont pas exportés à apparaître avec des pages vierges.

  Retour en haut

  Fonctionnalités de la version 6.1

  Mises à jour et nouvelles fonctionnalités

  • Les dictionnaires coréen et japonais ont été mis à jour. Merci à Kim SungDong pour l’excellente aide !
  • Ajout et mise à jour de tous les dictionnaires pour de nouvelles traductions.
  • Filtres Help 2 : Une nouvelle page d’options a été ajoutée à [Configuration]->Fichiers & Formats->Help 2->Enregistrement->Filtres où vous pouvez définir des filtres qui seront enregistrés dans le processus d’enregistrement (uniquement pour TFHxReg).
  • Un nouveau modèle de projet a été ajouté pour créer une aide ressemblant à CodeGear Delphi 2007 et RAD Studio 2007.
  • Une nouvelle fonctionnalité a été ajoutée au système de modèle HTML qui permet l’insertion dynamique de code CSS et JavaScript dans l’en-tête du modèle. Cela facilite l’intégration de la sortie de Doc-O-Matic avec des fonctionnalités dynamiques comme la recherche d’index dynamique.
  • Sortie HTML : Nouvelle option HTML Imprimer au-dessus de l’en-tête pour le lien Tout réduire/Tout développer. Activé par défaut pour les nouveaux projets et désactivé pour les projets existants.
  • Sortie XML : Ajout d’une nouvelle option Voir la documentation comme pour les autres formats de sortie qui vous permet de c

    Contrôler si le fichier XML généré est affiché après la construction est terminée.

    • L’aide en ligne a été mise à jour.
    • Doc-O-Matic est maintenant livré avec des schémas pour le format XML qu’il prend en charge. Les schémas sont copyright de Borland Corporation, ils sont installés dans supportschemas.
    • La base de données du projet Delphi 5-7 contient désormais des informations sur la hiérarchie des classes qui sont nécessaires pour déterminer les types d’événements.
    • Doc-O-Matic démarre maintenant l’Explorateur de documents Help 2 installé avec Visual Studio 2005/2008 et CodeGear Studio 2007 de manière à ce que la page d’accueil soit affichée.

    Visual Studio 2008

    • Doc-O-Matic utilise désormais le nouveau style d’aide de Visual Studio 2008 par défaut. Le modèle Visual Studio 2008 a été ajusté pour correspondre au nouveau style de documentation MSDN.
    • Doc-O-Matic crée désormais une sortie qui ressemble à la documentation MSDN de Visual Studio 2008 (lors de l’utilisation du modèle Visual Studio 2008). Des fonctionnalités ont été ajoutées pour prendre en charge ce style de sortie (voir ci-dessous).
    • Doc-O-Matic détecte désormais automatiquement les emplacements de Visual Studio 2008 pour le visualiseur Help 2 et le compilateur Help 2.
    • Une nouvelle option a été ajoutée pour imprimer un lien Envoyer des commentaires en tant que partie de la liste des liens de titre. Cela peut être contrôlé via la page de paramètres de configuration [Configuration]-> Fichiers et format-> Mise en page-> En-tête de page-> Commentaires. Les projets existants ne sont pas affectés par ce changement si aucun code de lien d’en-tête n’a été saisi sur cette page (par défaut).

    Doc-O-Matic Express Version Finale

    • Il s’agit de la première version officielle de Doc-O-Matic Express (la version précédente était marquée bêta).
    • L’aide en ligne de Doc-O-Matic Express pour l’utilitaire de configuration ainsi que l’aide pour l’outil en ligne de commande, la documentation du code, les FAQ et plus encore.
    • Outil de vérification des mises à jour de Doc-O-Matic Express (Aide-> Vérifier les mises à jour).
    • Génère automatiquement du contenu dans le nouveau style Visual Studio 2008.

    Corrigé

    • Le correcteur orthographique est maintenant fermé.
    • Résolution d’un problème de vérification orthographique pour les propriétés du sujet qui ne s’arrêtait pas toujours lors de l’annulation de la vérification orthographique.
    • Résolution d’un problème de vérification orthographique pour les propriétés du sujet qui entraînait l’annulation des modifications manuelles apportées à une valeur pendant que le correcteur orthographique vérifiait la valeur, dès que le champ suivant était vérifié ou que le processus était arrêté.
    • Résolution d’un problème qui empêchait les paramètres de vérification orthographique individuels d’être enregistrés correctement entre les sessions.
    • Résolution d’un problème avec l’inspecteur qui empêchait les valeurs d’être mises au premier plan dans certaines conditions.
    • Lors du collage d’images différentes dans l’Éditeur, parfois la vue dans la boîte de dialogue de l’image n’était pas rafraîchie et montrait la dernière image collée au lieu de l’image actuelle.
    • Aucun avertissement n’était donné en cas d’écrasement d’un fichier image existant lors de l’enregistrement d’une nouvelle image collée. Doc-O-Matic empêche désormais l’enregistrement d’images collées avec des noms existants sur le chemin de l’image.
    • Résolu : Un problème dans l’éditeur d’éléments qui faisait que les changements de police n’étaient pas appliqués correctement lors du changement de polices alternatives pour les éléments HTML.
    • Résolu : Un problème avec l’enregistrement et la restauration de certains paramètres de programme vers et depuis le registre, ce qui pouvait entraîner des noms de fichiers corrompus dans la liste des projets récents et d’autres problèmes non critiques similaires.
    • Résolu : Un problème pour les utilisateurs de langues asiatiques qui faisait que les tables qui étaient agencées manuellement (sans utiliser l’Éditeur) n’étaient pas lues correctement. Cette correction améliore la compatibilité avec les versions précédentes de Doc-O-Matic qui utilisaient un mécanisme de disposition de table différent. Les tables rédigées par l’Éditeur de Doc-O-Matic 6 n’étaient pas affectées par ce problème.
    • Éditeur : La fonction de recherche ne fonctionnait pas dans certains cas.
    • Expansion de macros C++ : Un bogue a été corrigé qui pouvait entraîner des effets secondaires graves si une macro sans arguments était utilisée avant un terme entre parenthèses, comme STDCALLTYPE (* fptr)(), auquel cas le terme entre parenthèses complet serait ignoré par le p
      • UI: Corrige un problème qui provoquait l’affichage de caractères indésirables dans la liste des langues dans la boîte de dialogue Changer de langue lors de l’exécution dans certains paramètres régionaux.
      • UI: Corrige un problème qui faisait parfois afficher rien pour les titres des éditeurs pour certains sujets dans certains paramètres régionaux.
      • Interprétation : L’emplacement de l’implémentation (void) en C++ des listes de paramètres qui différaient de la déclaration pouvait entraîner l’ignorance du commentaire d’emplacement de l’implémentation.
      • Traitement de texte : La balise compatible XML n’était pas correctement traitée lors de la génération de sortie, de sorte que le texte des fichiers inclus n’était pas utilisé.
      • Sortie HTML : Les sujets contenant le caractère % dans leur ID produisaient des noms de fichiers incompatibles avec l’aide HTML. WebHelp et Help 2 fonctionnaient correctement. La génération de noms de fichiers a été ajustée pour ne pas produire de noms de fichiers contenant ces caractères. Le pourcentage % sera transformé en tiret bas _.
      • Noyau : Correction d’un bogue dans le moteur de coloration syntaxique qui pouvait causer un certain nombre de problèmes : La traduction du code ne traitait pas les conversions de noms de méthode, cela causait des balises déséquilibrées dans la sortie HTML et une duplication des balises dans la sortie XML.
      • Définitions en double corrigées dans eventtypes.pas.

      Fonctionnalités de la version 6

      • Gestion de projet : Projets principaux, possibilité de stocker les informations de la TOC dans des fichiers externes, plus de contrôle sur la sortie en ligne de commande et amélioration de la gestion en ligne de commande, pour n’en citer que quelques-uns.
      • Éditeur et rédaction : Extraits de code, libellés avec mise en forme et fonctionnalités de texte conditionnel, variables de texte avec mise en forme automatisée, accès rapide CTRL pour insérer des libellés, des variables et des extraits de code, et plus encore.
      • Unicode : Doc-O-Matic fonctionne désormais en interne avec Unicode et prend en charge les fichiers source et de documentation Unicode, les identifiants Unicode ainsi que la conversion à la volée de la documentation HTML externe en utilisant n’importe quelle page de code installée. Doc-O-Matic est désormais indépendant du système actuel.
      • Code source: Ajout du support PHP, amélioration de l’impression de syntaxe avec une coloration syntaxique et une sortie multilingue considérablement améliorée. Doc-O-Matic est maintenant livré avec un nouvel outil de traduction de code qui aide à maintenir la matrice de traduction de syntaxe.
      • Outils: Doc-O-Matic est maintenant livré avec des outils pour gérer la matrice de traduction de code, HxBrowse pour parcourir le registre de l’espace de noms Help 2 et tfhxreg pour enregistrer les fichiers Help 2, les espaces de noms et les plug-ins.
      • Localisation: La localisation des projets Doc-O-Matic peut désormais être gérée depuis un seul endroit central, le dictionnaire de localisation. Toutes les chaînes du projet contenant éventuellement un contenu traduisible sont traitées par le dictionnaire lors de la génération de la sortie. De plus, Doc-O-Matic est livré avec de nouveaux graphismes de boutons localisés pour HTML et il y a un nouvel outil qui aide à changer facilement la langue actuelle.
      • Interface utilisateur: De nouveaux éléments d’interface utilisateur comme la barre d’onglets aident à gérer le projet plus rapidement.

      Matrice des fonctionnalités

      Pour consulter la matrice des fonctionnalités, veuillez cliquer ici.

      Retour en haut

      Doc-O-Matic – Configuration requise

      Exigences

      • Microsoft Windows XP, 2000, ME, NT 4.0 ou 98
      • 20 Mo d’espace disque dur supplémentaire
      • 64 Mo de mémoire (128 Mo recommandés).

      Un support direct est fourni pour les IDE suivants :

      • Microsoft Visual Studio .NET
      • Microsoft Visual Studio 4.0 – 6.0
      • Microsoft Visual Studio 97
      • Microsoft Visual Studio 2008
      • Microsoft Visual Basic .NET
      • Microsoft Visual C++ .NET
      • Microsoft Visual C# .NET
      • Borland C++ 5.0
      • Borland C++
      • Borland C++ Builder 3 – 6
      • Borland Delphi1.0 – 7.0.