Product Knowledge Base

Space shortcuts

Page tree

Versions Compared

Old Version 42

changes.mady.by.user Andreas Püschel

Saved on

compared with

New Version 43

changes.mady.by.user Andreas Püschel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Flowchart
XSDSchema [label="YADE XSD Schema\n(.xsd)",URL="YADE - XSD Schema Reference - XSD Schema Source",tooltip="XSD Schema Source for use with an XSD Editor",fillcolor="lightskyblue"]
XSDDocumentation [label="YADE XSD Schema Documentation\n(.html)",URL="JADEYADE - XSD Schema Reference - XSD Schema Documentation",tooltip="XSD Schema documentation in HTML format",fillcolor="lightskyblue"]
SourceCode [label="YADE Source Code\n(Java)",fillcolor="violet"]
APIReference [label="YADE API Reference\n(JavaDoc)",URL="YADE - Reference Documentation - API Reference",tooltip="API Reference in JavaDoc HTML format",fillcolor="violet"]
ParameterReference [label="YADE Parameter Reference\n(Wiki)",URL="YADE - Reference Documentation - Parameter Reference",tooltip="Parameter Reference in Product Knowledge Base",fillcolor="orange"]
#ParameterExplanations [label="YADE Parameter Explanations",fillcolor="white"]
ParameterDiagrams [label="YADE Parameter Diagrams",fillcolor="white"]
ParameterTables [label="YADE Parameter Tables",fillcolor="white"]
UserManual [label="YADE User Manual\n(Wiki)",URL="YADE - User Manual",tooltip="User Manual in Product Knowledge Base",fillcolor="palegreen"]
#UserManualExplanations [label="YADE User Manual Explanations",fillcolor="white"]
ParameterMappings [label="YADE Parameter Mapping\n(Wiki)",URL="YADE - Reference Documentation - Parameter Mapping",tooltip="Parameter Mapping in Product Knowledge",fillcolor="lightgrey"]
ParameterMappingTables [label="YADE Parameter Mapping Tables",fillcolor="white"]
 
XSDSchema -> XSDDocumentation
XSDSchema -> SourceCode
XSDSchema -> ParameterDiagrams
XSDSchema -> ParameterTables
XSDSchema -> ParameterMappingTables

SourceCode -> APIReference
ParameterDiagrams -> ParameterReference 
ParameterTables -> ParameterReference 
#ParameterExplanations -> ParameterReference 

#ParameterDiagrams -> UserManual
#ParameterTables -> UserManual
#ParameterExplanations  -> UserManual
#UserManualExplanations -> UserManual

ParameterMappingTables -> ParameterMappings
ParameterReference -> UserManual

Excerpt
Info
titleStatus of Documentation
  • The Parameter Reference explains the structure of configuration elements that is intended for future YADE releases.
    • Display feature availability
      StartingFromRelease1.11
    • YADE shifts from plain text configuration files (.ini format) to XML Configuration files.
      • For releases 1.9 and 1.10 the plain text configuration files are maintained.
      • For releases 1.11 and later XML Configuration will be available as documented.
  • The Parameter Reference for releases 1.10 and older is available for reference.
  • The Parameter Mapping is intended for users of YADE releases before 1.11 who want to benefit from the Parameter Reference documentation.
    • Mapping tables assist to identify XML configuration elements and plain text configuration items (.ini format).
  • The XML Editor is schema-aware and can be used to create valid XML configurations.
  • The YADE - User Manual is available and under continuous extension.

...