View Issue Details

IDProjectCategoryView StatusLast Update
0024325Open CASCADEOCCT:Documentationpublic2013-12-21 13:19
ReporterabvAssigned Toibs 
PrioritynormalSeverityminor 
Status closedResolutionfixed 
Product Version6.7.0 
Target Version6.7.0Fixed in Version6.7.0 
Summary0024325: OCCT documentation -- todo list for OCCT 6.7.0
DescriptionThis issue collects points to be done to finalize the new OCCT documentation system before OCCT 6.7.0 release (apart of revising content).

1. Convert remaining documents to MarkDown format:

 * User Guides

   - OCAF white paper
   - OCAF
   - BREP format description

 * Developer Guides

   - Coding Rules
   - Contribution Workflow
   - OCCT Git Guide
   

2. Check that MATHJAX can be used in standalone installation (probably need to have copy of MatJax script in doc)

3. Enable full-text search using server-based (external) indexing

4. Generate CHM

5. Add links from overview to reference manual
TagsNo tags attached.
Test case number

Relationships

parent of 0024330 closedbugmaster Generate Overview documentation in CHM format 
parent of 0024332 closedysn Provide links from Overview HTML documentation to Reference Manual 
parent of 0024361 closedabv Enable brief documentation of class members in detailed description 
parent of 0024364 closedapn Document system should use local MathJax also 
related to 0024336 closedbugmaster Content of OCCT documentation should be updated. Iter 2 
child of 0024269 closedbugmaster Content of occt documentation should be updated 

Activities

apn

2013-11-08 13:06

administrator   ~0026512

Last edited: 2013-11-08 14:51

- Overview
http://sourceforge.net/projects/autoopencas/, - page not found
should be: http://sourceforge.net/projects/autoopencas/?source=directory

http://qt.digia.com/downloads
http://qt.nokia.com/downloads
link for QT should be: http://qt-project.org/downloads

- Developer Guides
  - Building OCCT from sources
    - Building 3rd-party libraries on Windows
      - Introduction
      - Building Mandatory Third-party Products
        - .1 VDrawSphere - should be deleted
        - Tcl/Tk 8.5
        - FreeType 2.4.10

- Extending Test Harness with custom commands is not available
  - Custom command implementation
  - Registration of commands in Test Harness
  - Creating a toolkit (library) as a plug-in
  - Creation of the plug-in resource file
  - Dynamic loading and activation

abv

2013-11-15 10:16

manager   ~0026642

Problem with Test Harness (".1 DrawSphere" in "Building 3rd-party on Windows" and missing end of TestHarness doc) is fixed in current master (it was a problem of using @subsubsection without @subsection in DRAW UG -- looks like bug in Doxygen).

Points 1, 4, 5 are done or being processed separately.

abv

2013-12-21 13:19

manager   ~0027291

I assume most items are fixed; remaining will be corrected separately

Issue History

Date Modified Username Field Change
2013-11-07 15:20 abv New Issue
2013-11-07 15:20 abv Assigned To => atp
2013-11-07 15:20 abv Relationship added child of 0024269
2013-11-07 16:40 abv Assigned To atp => ibs
2013-11-07 16:40 abv Status new => assigned
2013-11-08 11:34 abv Relationship added parent of 0024330
2013-11-08 12:09 abv Relationship added parent of 0024332
2013-11-08 13:06 apn Note Added: 0026512
2013-11-08 14:51 apn Note Edited: 0026512
2013-11-11 14:25 ibs Relationship added related to 0024336
2013-11-15 10:04 abv Relationship added parent of 0024361
2013-11-15 10:16 abv Note Added: 0026642
2013-11-15 15:09 ibs Relationship added parent of 0024364
2013-12-21 13:19 abv Note Added: 0027291
2013-12-21 13:19 abv Status assigned => closed
2013-12-21 13:19 abv Resolution open => fixed
2013-12-21 13:19 abv Fixed in Version => 6.7.0