XML PUBLISHING SOLUTIONS FOR A COMPANY

The eXtensible Markup Language, or XML is a method to add structure and context to unstructured information This paper presents some of the latest issues in using XML as a standard for information publishing. We present XBRL (eXtended Business Reporting Language) and possible applications in elaborating financial documents. We also present DITA (Darwin Information Typing Architecture) as a new XML based standard developed by IBM DITA is used for technical information structuring and publishing. In the final part we present a DITA implementation of a procedures manual for a hypermarket.XBRL, XML, DITA, HTML, taxonomy, instance document

XML-Based Authoring: from Concepts via Compromises to Applications

Within the last couple of years, the competence centre for e-learning and multimedia at the Freie Universität Berlin (CeDiS) established a manufacture like production process for e-learning content, which is primarily targeted to large projects, i.e. projects with several authors and an arbitrary volume of content to produce. The most important cornerstones of the production process are an XML document format and an authoring tool for this document format. Unfortunately both were designed only to meet the requirements of two nation-wide projects, which were lead-managed by CeDiS.The work described in this paper is dedicated to the generalization of that manufacture like production process, especially the development of an adaptable XML document format for e-learning contents and the corresponding editor. The document format SCDL (Sharable Content Description Language) we specified as XML Schema, is a general document format for modular e-learning content. Besides common features like multimedia integration, it provides a mechanism for deriving project specific document formats from the general format by restriction and not by extension. This mechanism shall prevent that software solutions have to be adapted for any derived document format. Furthermore it fosters the possibilities of re-using and exchanging content.Based on Microsoft InfoPath we are developing an authoring tool for the SCDL document format. The currently available prototype already provides a comfortable user interface for the authors, which shows a structural, ‘semi-WYSIWYG’ view of the document. The features implemented so far are sufficient for simple applications, but important components like mathematical formulas and special media elements are still to add

Instructions on Small Screens : Analysing the Multimodality of Technical Communication Through a Design Experiment

Tässä tutkielmassa analysoin teknisen viestinnän multimodaalisuutta kokeellisen suunnittelun avulla. Kokeessani suunnittelen ja konvertoin älylasien pienelle näytölle kolme lyhyttä KONE Oyj:n asennus- ja huolto-ohjetta. Vaikka käytän kokeessani älylaseja, tutkimuksen näyttö voisi periaatteessa olla mikä tahansa pieni näyttö, esimerkiksi älypuhelin tai älykello, jonka ajantasainen sisältö on teoriassa helpommin kuljetettavissa mukana kuin paperille tulostettu perinteinen PDF-ohje. Konvertoin ohjeet käyttäen kahta teoriaa: visuaaliset ohjeet (Gattullo et al. 2019) ja minimalismiheuristiikka (van der Meij ja Carroll, 1998). Ymmärtääkseni paremmin ohjeiden koko käyttökontekstia, rakennan konversioiden testaamiseen yhteistyönä KONE Oyj:ssä käyttäjätestiympäristön simuloimaan ammattimaista hissin asennus- ja huoltoympäristöä. Vaikka nykytekniikka mahdollistaa digitaalisten, pienten näyttöjen käytön, ohjeiden tarkoitus ei muutu: niiden pitää ymmärrettävästi auttaa lukijaa suorittamaan tehtävänsä. Täten konversio- ja suunnitteluteorioiden vastapainoksi multimodaalisuuden teoriat (esimerkiksi, Bateman, Wildfeuer ja Hiippala, 2017) auttavat analysoimaan konversioiden ymmärrettävyyden eroja systemaattisesti. Käytän tutkielmassani multimodaalisuuden teorioita ymmärtääkseni konversioiden vaikutukset ohjeiden ymmärrettävyyteen. Multimodaalisuuden teorioiden avulla tunnistan ohjeiden käyttötilanteen, käytetyn median (älylasit) ominaisuudet, sekä rajaan varsinaiseksi tutkimuskohteekseni konvertoiduilta ohjenäytöiltä tunnistamani semioottiset moodit ja niiden vaikutukset konvertoitujen ohjeiden ymmärtämiseen. Johtopäätöksinä esitän, ettei yksittäisiä konvertoituja ohjenäyttöjä tutkimalla synny mimimalismiheuristiikan osalta ymmärrettävyyden kannalta merkittäviä eroja lähtötilanteen PDF-ohjeeseen nähden, lukuun ottamatta muutamien helposti pääteltävien kohtien poisjättämistä. Yleisesti ottaen molemmissa konversioissa älylaseille siirtyy multimodaalisesti samankaltainen, kaksiulotteista sivunäkymää hyödyntävä ohje kuin lähtötilanteen PDF. Koska toinen tutkimani teoria, visuaaliset ohjeet, perustuvat verbien korvaamiseen symboleilla, symbolien ymmärrettävyys korostuu merkittävänä erona visuaalisten ohjeiden käytettävyydessä. Johtopäätöksiä selventää, etten hyödynnä älylasien kaikkia ilmaisukeinoja, kuten liikkuvaa kuvaa ja ääntä, koska kokeessani huomioin kustannustehokkaan, teollisten ohjeiden tuotantoprosessin. Lopuksi ehdotan erityisesti teknisen viestinnän viitekehyksessä jatkotutkimuksen aiheiksi uusien digitaalisten medioiden kaikkien ominaisuuksien ja niiden multimodaalisten käyttötilanteiden tutkimista ja hyödyntämistä, pienien näyttöjen sisällöntuotannon standardisoinnin tutkimista ja kehitystä, sekä symbolien ymmärrettävyyden tutkimista

Un ventre di donna. Romanzo chirurgico. A co-authored novel in Italian Futurism

This essay focuses on 20th-century Italian co-authored literature. I define co-authored literature as a literary practice that entails the active and conscious co-operation of two or more authors. This approach leads to an innovative, argumentative and unpredictable interpenetration (compensation), which is the result of the various authorial contributions. In the first part of the seminar, I will analyze the ways in which co-authored writing practice affects the authors' choice of genre. In order to effectively investigate this issue, I survey a set of literary works published by two or more authors in Western context from 1700 to 2013. This quantitative research led me to highlight some significant recurrent characteristics. In the second part, I will focus my attention on a co-authored novel in Italian Futurism entitled Un ventre di donna: romanzo chirurgico, who can help me underline the relationship between the concept of multi-authorship and Modernity

Document Automation Architectures: Updated Survey in Light of Large Language Models

This paper surveys the current state of the art in document automation (DA). The objective of DA is to reduce the manual effort during the generation of documents by automatically creating and integrating input from different sources and assembling documents conforming to defined templates. There have been reviews of commercial solutions of DA, particularly in the legal domain, but to date there has been no comprehensive review of the academic research on DA architectures and technologies. The current survey of DA reviews the academic literature and provides a clearer definition and characterization of DA and its features, identifies state-of-the-art DA architectures and technologies in academic research, and provides ideas that can lead to new research opportunities within the DA field in light of recent advances in generative AI and large language models.Comment: The current paper is the updated version of an earlier survey on document automation [Ahmadi Achachlouei et al. 2021]. Updates in the current paper are as follows: We shortened almost all sections to reduce the size of the main paper (without references) from 28 pages to 10 pages, added a review of selected papers on large language models, removed certain sections and most of diagrams. arXiv admin note: substantial text overlap with arXiv:2109.1160

A framework for variable content document generation with multiple actors

“NOTICE: this is the author’s version of a work that was accepted for publication in Information and Software Technology. Changes resulting from the publishing process, such as peer review, editing, corrections, structural formatting, and other quality control mechanisms may not be reflected in this document. Changes may have been made to this work since it was submitted for publication. A definitive version was subsequently published in Information and Software Technology, Volume 56, Issue 9, September 2014, Pages 1101–1121 DOI10.1016/j.infsof.2013.12.006Context - Advances in customization have highlighted the need for tools supporting variable content document management and generation in many domains. Current tools allow the generation of highly customized documents that are variable in both content and layout. However, most frameworks are technology-oriented, and their use requires advanced skills in implementation-related tools, which means their use by end users (i.e. document designers) is severely limited. Objective - Starting from past and current trends for customized document authoring, our goal is to provide a document generation alternative in which variants are specified at a high level of abstraction and content reuse can be maximized in high variability scenarios. Method Based on our experience in Document Engineering, we identified areas in the variable content document management and generation field open to further improvement. We first classified the primary sources of variability in document composition processes and then developed a methodology, which we called DPL based on Software Product Lines principles to support document generation in high variability scenarios. Results - In order to validate the applicability of our methodology we implemented a tool DPLfw to carry out DPL processes. After using this in different scenarios, we compared our proposal with other state-of-the-art tools for variable content document management and generation. Conclusion - The DPLfw showed a good capacity for the automatic generation of variable content documents equal to or in some cases surpassing other currently available approaches. To the best of our knowledge, DPLfw is the only framework that combines variable content and document workflow facilities, easing the generation of variable content documents in which multiple actors play different roles.This work has been partially funded by the Spanish Ministerio de Economia y Competitividad under Grant TIPEx (TIN2010-19859-C03-03).Gómez Llana, A.; Penadés Gramage, MC.; Canos Cerda, JH.; Borges, MR.; Llavador Campos, M. (2014). A framework for variable content document generation with multiple actors. Information and Software Technology. 56(9):1101-1121. https://doi.org/10.1016/j.infsof.2013.12.006S1101112156

Enforcing Customization in e-Learning Systems: an ontology and product line-based approach

In the era of e-Learning, educational materials are considered a crucial point for all the stakeholders. On the one hand, instructors aim at creating learning materials that meet the needs and expectations of learners easily and effec-tively; On the other hand, learners want to acquire knowledge in a way that suits their characteristics and preferences. Consequently, the provision and customization of educational materials to meet the needs of learners is a constant challenge and is currently synonymous with technological devel-opment. Promoting the personalization of learning materials, especially dur-ing their development, will help to produce customized learning materials for specific learners' needs. The main objective of this thesis is to reinforce and strengthen Reuse, Cus-tomization and Ease of Production issues in e-Learning materials during the development process. The thesis deals with the design of a framework based on ontologies and product lines to develop customized Learning Objects (LOs). With this framework, the development of learning materials has the following advantages: (i) large-scale production, (ii) faster development time, (iii) greater (re) use of resources. The proposed framework is the main contribution of this thesis, and is char-acterized by the combination of three models: the Content Model, which addresses important points related to the structure of learning materials, their granularity and levels of aggregation; the Customization Model, which con-siders specific learner characteristics and preferences to customize the learn-ing materials; and the LO Product Line (LOPL) model, which handles the subject of variability and creates matter-them in an easy and flexible way. With these models, instructors can not only develop learning materials, but also reuse and customize them during development. An additional contribution is the Customization Model, which is based on the Learning Style Model (LSM) concept. Based on the study of seven of them, a Global Learning Style Model Ontology (GLSMO) has been con-structed to help instructors with information on the apprentice's characteris-tics and to recommend appropriate LOs for customization. The results of our work have been reflected in the design of an authoring tool for learning materials called LOAT. They have described their require-ments, the elements of their architecture, and some details of their user inter-face. As an example of its use, it includes a case study that shows how its use in the development of some learning components.En la era del e¿Learning, los materiales educativos se consideran un punto crucial para todos los participantes. Por un lado, los instructores tienen como objetivo crear materiales de aprendizaje que satisfagan las necesidades y ex-pectativas de los alumnos de manera fácil y efectiva; por otro lado, los alumnos quieren adquirir conocimientos de una manera que se adapte a sus características y preferencias. En consecuencia, la provisión y personaliza-ción de materiales educativos para satisfacer las necesidades de los estudian-tes es un desafío constante y es actualmente sinónimo de desarrollo tecnoló-gico. El fomento de la personalización de los materiales de aprendizaje, es-pecialmente durante su desarrollo, ayudará a producir materiales de aprendi-zaje específicos para las necesidades específicas de los alumnos. El objetivo fundamental de esta tesis es reforzar y fortalecer los temas de Reutilización, Personalización y Facilidad de Producción en materiales de e-Learning durante el proceso de desarrollo. La tesis se ocupa del diseño de un marco basado en ontologías y líneas de productos para desarrollar objetos de aprendizaje personalizados. Con este marco, el desarrollo de materiales de aprendizaje tiene las siguientes ventajas: (i) producción a gran escala, (ii) tiempo de desarrollo más rápido, (iii) mayor (re)uso de recursos. El marco propuesto es la principal aportación de esta tesis, y se caracteriza por la combinación de tres modelos: el Modelo de Contenido, que aborda puntos importantes relacionados con la estructura de los materiales de aprendizaje, su granularidad y niveles de agregación, el Modelo de Persona-lización, que considera las características y preferencias específicas del alumno para personalizar los materiales de aprendizaje, y el modelo de Línea de productos LO (LOPL), que maneja el tema de la variabilidad y crea ma-teriales de manera fácil y flexible. Con estos modelos, los instructores no sólo pueden desarrollar materiales de aprendizaje, sino también reutilizarlos y personalizarlos durante el desarrollo. Una contribución adicional es el modelo de personalización, que se basa en el concepto de modelo de estilo de aprendizaje. A partir del estudio de siete de ellos, se ha construido una Ontología de Modelo de Estilo de Aprendiza-je Global para ayudar a los instructores con información sobre las caracterís-ticas del aprendiz y recomendarlos apropiados para personalización. Los resultados de nuestro trabajo se han plasmado en el diseño de una he-rramienta de autor de materiales de aprendizaje llamada LOAT. Se han des-crito sus requisitos, los elementos de su arquitectura, y algunos detalles de su interfaz de usuario. Como ejemplo de su uso, se incluye un caso de estudio que muestra cómo su empleo en el desarrollo de algunos componentes de aprendizaje.En l'era de l'e¿Learning, els materials educatius es consideren un punt crucial per a tots els participants. D'una banda, els instructors tenen com a objectiu crear materials d'aprenentatge que satisfacen les necessitats i expectatives dels alumnes de manera fàcil i efectiva; d'altra banda, els alumnes volen ad-quirir coneixements d'una manera que s'adapte a les seues característiques i preferències. En conseqüència, la provisio' i personalitzacio' de materials edu-catius per a satisfer les necessitats dels estudiants és un desafiament constant i és actualment sinònim de desenvolupament tecnològic. El foment de la personalitzacio' dels materials d'aprenentatge, especialment durant el seu desenvolupament, ajudarà a produir materials d'aprenentatge específics per a les necessitats concretes dels alumnes. L'objectiu fonamental d'aquesta tesi és reforçar i enfortir els temes de Reutilització, Personalització i Facilitat de Producció en materials d'e-Learning durant el procés de desenvolupament. La tesi s'ocupa del disseny d'un marc basat en ontologies i línia de productes per a desenvolupar objec-tes d'aprenentatge personalitzats. Amb aquest marc, el desenvolupament de materials d'aprenentatge té els següents avantatges: (i) produccio' a gran esca-la, (ii) temps de desenvolupament mes ràpid, (iii) major (re)ús de recursos. El marc proposat és la principal aportacio' d'aquesta tesi, i es caracteritza per la combinacio' de tres models: el Model de Contingut, que aborda punts im-portants relacionats amb l'estructura dels materials d'aprenentatge, la se-ua granularitat i nivells d'agregació, el Model de Línia de Producte, que ges-tiona el tema de la variabilitat i crea materials d'aprenentatge de manera fàcil i flexible. Amb aquests models, els instructors no solament poden desenvolu-par materials d'aprenentatge, sinó que també poden reutilitzar-los i personalit-zar-los durant el desenvolupament. Una contribucio' addicional és el Model de Personalitzacio', que es basa en el concepte de model d'estil d'aprenentatge. A partir de l'estudi de set d'ells, s'ha construït una Ontologia de Model d'Estil d'Aprenentatge Global per a ajudar als instructors amb informacio' sobre les característiques de l'aprenent i recomanar els apropiats per a personalitzacio'. Els resultats del nostre treball s'han plasmat en el disseny d'una eina d'autor de materials d'aprenentatge anomenada LOAT. S'han descrit els seus requi-sits, els elements de la seua arquitectura, i alguns detalls de la seua interfície d'usuari. Com a exemple del seu ús, s'inclou un cas d'estudi que mostra com és el desenvolupament d'alguns components d'aprenentatge.Ezzat Labib Awad, A. (2017). Enforcing Customization in e-Learning Systems: an ontology and product line-based approach [Tesis doctoral no publicada]. Universitat Politècnica de València. https://doi.org/10.4995/Thesis/10251/90515TESI

Chapter Bibliography

authored support system; contextual machine translation; controlled document authoring; controlled language; document structure; terminology management; translation technology; usability evaluatio

Using and advancing DITA XML : A case study of evaluating DITA-authored customer documentation

In today’s world, customer documentation for products must comply with the changing needs of the users, who want to access and consume information effortlessly as soon as they need it. Traditional documentation strategies such as desktop publishing and linear writing have been challenged by the emerging technologies in technical communication that emphasize modularity, flexibility and efficiency from both the users and the technical writers’ perspectives. The Darwin Information Typing Architecture (DITA) is one of the most interesting technologies within the technical communication field. The theoretical framework of this study is based on markup languages – especially DITA – and various perspectives of technical writing, such as topic-based writing, single-sourcing and minimalism. The features of DITA and the best practices of structured writing offer a lucrative starting point for addressing the highly practical research question of this study, namely how DITA XML has been used. This thesis is done in collaboration with a large company’s business unit that produces highly complex products and whose technical documentation strategy includes writing use case-based DITA topics. Now, the unit has initiated a transformation project whose goal is to evolve the customer documentation, and this thesis is a part of this project. The research problem of this thesis was approached by conducting a heuristic evaluation by using the DITA heuristics that were created as a part of this study, as such heuristics did not exist yet. The heuristics are based on both literature and practical experience on authoring technical documentation in DITA, as well as the business unit’s internal guidelines and discussions with a senior documentation specialist with extensive knowledge and competencies of the themes of this thesis. The DITA heuristics will later serve as a basis for a tool for the technical writers at the unit. The research data comprises 80 DITA XML modules, 40 of which contain descriptive, conceptual information (DITA concept topics) while the remaining 40 guide the users on carrying out procedures (DITA task topics). The sample data dates to 2021, and it was collected from the customer documentation of four different software components. The research shows that DITA can be used in various ways to author technical documentation, but some practices conform better to the principles of the DITA standard as well as the guidelines of structured, modular documentation. The most central issues include semantic markup, information typing and minimalism, especially task-orientation. Moreover, conducting a heuristic evaluation with a customized heuristics list proved to be an effective method for assessing the practices of authoring customer documentation in DITA. The results of this thesis provide valuable information for the business unit’s endeavors in terms of evolving their customer documentation content and presentation as well as supporting technical writers. The results of this thesis can be used internally in the business unit as a part of their transformation project regarding the usability and user-centeredness of their customer documentation. As a continuum to this study, technical writers who use DITA could be researched in terms of how they perceive DITA and structured authoring to increase the knowledge of how these themes are regarded among technical documentation experts today.Asiakasdokumentaation käyttäjät sekä heidän tapansa ja tarpeensa ovat muuttuneet ajan saatossa, minkä seurauksena myös itse dokumentaatio on muuttunut. Teknisen viestinnän alalla on havaittu, että käyttäjät haluavat saada tarvitsemansa tiedon nopeasti juuri sillä hetkellä, kun he sitä tarvitsevat. Tästä syystä perinteinen lineaarinen dokumentaatio, jossa käyttöohjeet kirjoitetaan kokonaisuutena alusta loppuun sivu-sivulta-periaatteella on alkanut väistyä uusien metodien tieltä, jotka painottavat modulaarisuutta, joustavuutta ja tehokkuutta niin käyttäjien kuin informaatiota tuottavien teknisten kirjoittajienkin näkökulmasta. Yksi alan suosituimmista tähän tarkoitukseen sopivista metodeista on Darwin Information Typing Architecture eli DITA. Tämän pro gradu -tutkielman teoreettinen viitekehys rakentuu merkintäkielten (etenkin DITAn) ja teknisen viestinnän eri periaatteiden ja hyvien käytäntöjen ympärille, joihin sisältyvät modulaarisuus, yksilähteistäminen ja minimalismi. Tutkimuskysymys on hyvinkin käytännöllinen, nimittäin tässä tutkielmassa tarkastellaan DITA XML:llä tuotettua dokumentaatiota sen lähtöformaatissa. Tutkielma on tehty yhteistyössä erään suuren yrityksen kompleksisia tuotteita valmistavan liiketoimintayksikön kanssa, jossa olen ollut harjoittelussa teknisenä kirjoittajana. Yksikössä tuotetaan itse tuotteiden lisäksi myös niiden dokumentaatio, ja DITA on tämän dokumentointistrategian ytimessä. Yksikössä on käynnistetty transformaatioprojekti, jonka tarkoituksena on kehittää asiakasdokumentaatiota entisestään. Tämä tutkielma on osa tuota projektia. Tutkimuskysymystä lähestyttiin toteuttamalla heuristinen arviointi dokumentaatiolle. Tutkielmassa esitellyt ja käytetyt DITA-heuristiikat luotiin osana tutkimusta, sillä vastaavia heuristiikkoja ei ollut luotu aiemmin. Heuristiikat pohjautuvat teoreettiseen ja käytännön tuntemukseen dokumentoinnista DITAa käyttäen, minkä lisäksi niiden taustalla vaikuttavat yksikön sisäiset ohjeistukset ja käytänteet sekä keskustelut ja yhteistyö yksikön dokumentaatioasiantuntijan kanssa, jolla on kattava kokemus ja tietämys tutkielmaan liittyvistä aihepiireistä. Tutkimusaineisto kattaa 80 DITA-topiikkia eli yksittäistä moduulia neljästä eri ohjelmistotuotekomponentista. Topiikeista 40 käsittelee konseptuaalista informaatiota komponenteista, kun taas toiset 40 kuvailevat tehtäviä, joita komponenttien käyttäjät noudattavat. Aineisto on peräisin vuodelta 2021. Tutkimuksen tulokset osoittavat, että DITAa voidaan soveltaa monilla eri tavoilla dokumentaatiossa, mutta tietyt tavat toteuttavat DITAn arkkitehtuuria muita paremmin. Lisäksi tapojen välillä havaittiin olevan eroja sen suhteen, miten hyvin ne vastaavat rakenteisen ja modulaarisen tekstin kirjoittamisen konventioita. Olennaisimmat havainnot liittyvät semanttisen merkintäkielen käyttöön, minimalismiin ja informaatiotyypittelyyn sekä käyttäjän ydintehtävien korostamiseen tuoteominaisuuksiin keskittymisen sijaan. Tutkimuksen johtopäätökset tarjoavat käyttökelpoista tietoa yksikön transformaatioprojektin tarpeisiin, ja niitä tullaankin käyttämään osana asiakasdokumentaation kehittämistä. Tutkimuksen perusteella jatkotutkimuksen aiheena voisi olla esimerkiksi DITAa käyttävien teknisten kirjoittajien suhtautuminen tässä tutkielmassa käsiteltyihin rakenteellisen kirjoittamisen ja modulaarisuuden teemoihin. Näin olisi mahdollista saada ajankohtaista tietoa siitä, miten alan ammattilaiset näkevät DITAn ja sen käyttökelpoisuuden