Giter Site home page Giter Site logo

eclipse-capella / capella-xhtml-docgen Goto Github PK

View Code? Open in Web Editor NEW
10.0 15.0 13.0 98.82 MB

XHTML Documentation Generation AddOn provides output HTML files for Capella model

License: Eclipse Public License 2.0

HTML 7.66% Java 92.17% CSS 0.17%
capella-addon

capella-xhtml-docgen's People

Contributors

aliakar82 avatar arnauddieumegard avatar axelrichard avatar bzendagui avatar etraisnel2 avatar fabka avatar fabka4t3 avatar felixdo avatar flatombe avatar iulius3456 avatar j-barata avatar jaubry-obeo avatar pdulth avatar tguiu avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

capella-xhtml-docgen's Issues

The HTML generation process never finishes on the whole model

4cb18 - Capella.png
WSDD IDE screen capture of problem

The HTML generation process never finishes on my model root.

The model contains around 13500 elements. On it, the generation of the element pages seems to be ok but the "IndexingConceptsTask" blocks. We tried to let it run during some hours but nothing changes and the Windows task seems not to be doing anything.

When we use it on sub-parts of the model everything works but it's impossible to generate the full documentation.

πŸ†” ECLIPSE-554879 / POLARSYS-1625 πŸ‘· guillaume.doux πŸ“… 2017-06-02 πŸ”Ž 1.1.1

HTMLdump generated Logical LF page has non-clickable [LFCD]s

HTMLdump generates [LFCD] diagrams with an empty , it has no hyperlinks. So, we can’t go to the involved Functions nor to the involved FunctionalExchanges.

Reproduction procedure :

  • create a new model
  • in LogicalArchitecture, create a functional chain and it's [LFCD] diagram
  • generate the HTML dump of this model
  • The LFCD diagram of the HTML has no hyperlinks maped

πŸ†” ECLIPSE-554889 / POLARSYS-2172 πŸ‘· faycal.abka πŸ“… 2018-09-06 πŸ”Ž 1.2.0

Update build model

Related to Bug: 483 and Bugs: 488.
Also builds on Capella 0.8.3.

πŸ†” ECLIPSE-554857 / POLARSYS-569 πŸ‘· christophe.gatti πŸ“… 2015-10-13 πŸ”Ž 0.8.2

Add additional fields in HTML export

Add additional data in the following elements

  • Functional chains
  • involved functional exchanges
  • Logical physical function
  • involving functional chains
  • allocating component
  • direct incoming functional port
  • direct outgoing functional port
  • Logical functional exchange
  • fucntional chains involving
  • Function port
  • owner
  • logical / physical functional exchange
  • Component port
  • provider/required interface
  • component exchange
  • component delegation
    ** logical / physical component port
  • Exchange item
  • functional exchange referencing : crossReferencer

πŸ†” ECLIPSE-554880 / POLARSYS-1675 πŸ‘· marc.saguer πŸ“… 2017-07-06 πŸ”Ž 1.3.2

Fix export of images in description fields

Export of images into html generation folder is not performed if:

  • image is resized in the description editor

  • there is a space character in the path of the source file

To fix this, modifications need to be performed in the file org.polarsys.capella.docgen.util.StringUtil.java:

  • regular expression for images is modified

  • strings "%20" are replaced by " " in the path of the source image

Resulting file implementing this modification and the one related to the export of files is provided in copy

πŸ†” ECLIPSE-554892 / POLARSYS-2291 πŸ‘· faycal.abka πŸ“… 2018-11-27 πŸ”Ž 1.2.1

[XHTMLDocGen] Update of build model to match 0.8.2

Promotion of XHTMLDocGen addon 0.8.2 version.

Reflecting changes:

Bug: 297
Bug: 322
Bug: 327
Bug: 362

πŸ†” ECLIPSE-554850 / POLARSYS-369 πŸ‘· christophe.gatti πŸ“… 2015-06-18 πŸ”Ž 0.8.1

[XHTML] no Realized/Realizing information for CE nor FE

HTML dump does not dump the following properties :
- on CE : Realized CE
- on CE : Realizing CE
- on FE : Realized FE
- on FE : Realizing FE

πŸ†” ECLIPSE-554890 / POLARSYS-2183 πŸ‘· faycal.abka πŸ“… 2018-09-13 πŸ”Ž 1.2.0

Fix TP of GenDoc xhtml to use Capella rather than Capella Studio

TP should be switched to Capella rather than Capella Studio when Capella-Master will uses Kitalpha_SDK_Master. "capellaStudioVersion" property should be deleted after that.

πŸ†” ECLIPSE-554868 / POLARSYS-960 πŸ‘· faycal.abka πŸ“… 2016-05-22 πŸ”Ž 1.1.0

[REGRESSION][AFM] Generation HTML in command line can use .afm file

When used in command line context, HTML gen doc will take the first semantic resource of the Sirius Session to launch the HTML generation.
Problem: the first semantic resource can be the .afm file (it is the case for example on new models).

πŸ†” ECLIPSE-554878 / POLARSYS-1513 πŸ‘· damien.filliat πŸ“… 2017-03-16 πŸ”Ž 1.1.0

HTML Area are generated on CombinedFragment in scenario diagram

Html areas are generated on combinedFragment. When edges are contained in the combinedFragment, the clickable area is confused with the edge area and combinedFragment. Plus, CombinedFragment are not exported.

πŸ†” ECLIPSE-554877 / POLARSYS-1331 πŸ‘· abka.faycal πŸ“… 2016-12-08 πŸ”Ž 0.8.4

Unable to complete installation of XHTMLDocGen with 1.2.0 (package is missing)

Capella version: capella-1.2.0.201711030906-win32-win32-x86_64.zip
Add-on version: CapellaXHTMLDocGen-updateSite-1.2.0.201801081314.zip

Install procedure through "Install New Software", "Add", "Archive" ...

Here is the error log :

Cannot complete the install because one or more required items could not be found.
Software being installed: Capella documentation generation - Package feature (Incubation) 1.0.0.201801081314 (org.polarsys.capella.docgen.package.feature.feature.group 1.0.0.201801081314)
Missing requirement: EGF Producer 1.5.0.v20180105-1651 (org.eclipse.egf.producer.feature.group 1.5.0.v20180105-1651) requires 'org.eclipse.emf.query.feature.group 0.0.0' but it could not be found
Cannot satisfy dependency:
From: EGF 1.5.0.v20180105-1651 (org.eclipse.egf.feature.group 1.5.0.v20180105-1651)
To: org.eclipse.egf.producer.feature.group [1.5.0.v20180105-1651]
Cannot satisfy dependency:
From: Capella documentation generation - Package feature (Incubation) 1.0.0.201801081314 (org.polarsys.capella.docgen.package.feature.feature.group 1.0.0.201801081314)
To: org.eclipse.egf.feature.group [1.5.0.v20180105-1651]

πŸ†” ECLIPSE-554887 / POLARSYS-2112 πŸ‘· flex πŸ“… 2018-06-27 πŸ”Ž 1.2.0

Capella - [XHTMLDocGen] static character encoding for the generated pages

From: ECLIPSE-550467

Turkish characters are missing while XHTML document generation using XHTMLDocGen add-on, even though I've changed Workspace text file encoding, Content Types and Globalization extensions to UTF-8 in Preferences, and all generated html files still start with encoding="ISO-8859-1" and include line: content="text/html;charset=ISO-8859-1"
How can I fix this?
Thanks,

Software environment:

  • Capella: 1.3.1
  • XHTMLDocGen addon: 1.3.1.201906140948
  • OS: Windows 10

I've got below answer from Arnaud when I reported this problem to polarsys.org/forums

Subject: Re: [XHTMLDocGen] Some issues regarding the encoding
Author: arnaud.dieumegard.obeo.fr
Date: Thu, 22 August 2019 03:30
Hi,

The encoding for generated pages is static and thus cannot be modified easily on a user side.
Can you please file a bug about this so we can investigate further ?
A workaround would be to open the generated pages with your web navigator and to change the encoding of the navigator so it displays characters properly.

Regards
Arnaud

πŸ†” ECLIPSE-553980 / POLARSYS-2576 πŸ‘· webmaster πŸ“… 2019-08-27 πŸ”Ž 1.3.1

[Add-on] HTML export

Capella HTML export add-on features:

Generation of html documents from Capella models

with:

  • Structure: a page contains an header, a footer, a side-bar for element selection, and the description of an element
  • Diagrams are clickable
  • Html files conform to xhtml
  • Search index

πŸ†” ECLIPSE-554844 / POLARSYS-172 πŸ‘· christophe.gatti πŸ“… 2015-01-29 πŸ”Ž 0.8.0

XHtml addon installation fail

The dropin (and update site) installation of the XHtml addon leads to an error. It is not installed (whereas all the other addon are).

πŸ†” ECLIPSE-554869 / POLARSYS-1047 πŸ‘· florent.ripault πŸ“… 2016-06-29 πŸ”Ž 1.0.2

Export Failed for Empty constraint

Attachment: .log
US English snapshot of Filter dialog (correct spacing)

The HTML export leads to an error if there is an undifined constraint (empty name and empty opaque expression).

πŸ†” ECLIPSE-554870 / POLARSYS-1063 πŸ‘· florent.ripault πŸ“… 2016-07-12 πŸ”Ž 1.0.2

Capella HTML output does not contain description of function involvements

The existing HTML output does not shown the description text on Functional Chain Involvements.

Our proposal would be to extend the HTML to show a table containing the involved Function (1st column) (this information is currently present in the HTML output) and the description of the involvement (second column).

πŸ†” ECLIPSE-554875 / POLARSYS-1325 πŸ‘· abka.faycal πŸ“… 2016-12-06 πŸ”Ž 0.8.0

XHTML Documentation Generation : non-xHTML compliancies

When generating XHTML,
Some html pages are not XHTML compliant :
Multiple pages

Should be


should be
instead
Logical Functional Chain page

tag is not correctly closed

should be
instead (same as above?)

πŸ†” ECLIPSE-554888 / POLARSYS-2148 πŸ‘· faycal.abka πŸ“… 2018-08-21 πŸ”Ž 1.2.0

Description of the Sequence Message
(and not the one of the invoked exchange)

Fix feature version on 1.0.x

Fix feature version on 1.0.x rather then 1.0.x

πŸ†” ECLIPSE-554866 / POLARSYS-941 πŸ‘· faycal.abka πŸ“… 2016-05-13 πŸ”Ž 1.0.2

Addition of PVG in html exports

Current html docgen exports property values but do not take into account property value groups.

The idea is to add export of property value groups in html reports and their owned / applied property values.

The solution will be recursive: a property value group can have owned / applied property value groups.

The result will be displayed in the form of a table listing the pvg and their pv with indentation in order to show the different levels of pv / pvg.

πŸ†” ECLIPSE-554884 / POLARSYS-1884 πŸ‘· aurelien.pinsonneau πŸ“… 2018-01-02 πŸ”Ž 1.1.0

baselessness diagrams in session stops the HTML generation with a NullPointerException

Some times, a diagram in Capella session become without target object. In this case, the export HTML throw an NPE and stop the generation.

Add a check at the diagram export operation to verify if the target is not null. if it is, the diagram is not exported.

πŸ†” ECLIPSE-554876 / POLARSYS-1328 πŸ‘· abka.faycal πŸ“… 2016-12-07 πŸ”Ž 0.8.0

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.