Skip to content
This repository has been archived by the owner on Nov 13, 2022. It is now read-only.

Documentation Changes

David Hall edited this page May 3, 2015 · 1 revision

[Doc] Zomic explicit_size_expr.sizeRef=IDENT

[Doc] Document which zomic axes remain valid in octahedral symmetry system.

[Doc] Provide octahedral and similar version of vZomeKey.pdf for each symmetry system. Show the axes used by zomic as applied to each system. Provide stereograpic projections as well as the "net" view.

[Doc] Update ZomicReference to include some of the info in Zomod Manual (eg. basis for axis naming) and more sample scripts

[Doc] Privide a list of significant vectors for each axis (e.g. maybe blue +2 = 1,0,0 aka: "X-axis", black = midpoint of face, etc...)

[Doc] Document supported zomic aliases for red, blue and yellow axes. (e.g. tri, triangle, rect, rectangle, pent and pentagon)

[Doc] Document (or implement) the 'destroy' zomic command

[Doc] Start using Javdoc formatted comments to describe key or obscure methods. Eventually publish Javdoc for core API.

[DOC] If Zomic size_expr allows sizeRef then explain how it's implemented and used.

[DOC] Are scale statements cumulative or do they set an absolute scale? (e.g. Is scale 2 scale 3 the same as scale 6 or scale 3?) Can we restore scale to an absolute value if we haven't saved it?

[DOC] Verify then document that the Zomic Repeat command with a negative count is ignored so a negative sign can be used to comment out the repeat without changing the value (e.g. -3 acts the same as 0)

[Doc] Document the behavior when attempting to open the same file more than once. Can't do it. - Is this correct?

[Doc] Reflect, Destroy and Label statements are not documented in ZomicReference.rtf

[Doc] Optional "+|-" Handedness of axis_expr needs description and verify it is applicable for all 3 places used.

[Doc] Show examples of all variants of strut_stmt and the resultant lengths as formula.

[Doc] ZomicReference.rtf: from_stmt should contain stmt, not just strut_stmt

[Doc] Include original ZomicReference.rtf in vzome-core/docs for historical purposes, then update it to match current language specs.

[Doc] ZomicReference.rtf says FROM requires strut_stmt, but in fact allows any stmt. Clarify docs to explain usage and caveats and give examples. e.g. from_stmt { stmt } type of construct.

[Doc] Include vZomeKey.pdf in vzome-core/docs.

[Doc] Explain the difference between "all" directions and "predefined" in the context menu.

[Doc] Document the "Extract Parts Model" in the main window context menu.

[Doc] Explain "Open Deferred".

Clone this wiki locally