Jump to content
Hash, Inc. Forums

Archived

This topic is now archived and is closed to further replies.

robcat2075

How to add to AMA documentation?

Recommended Posts

Most of the things I do RMB>Display help for current property on just have "Not documented yet" appear.

 

How do we fix that?

Share this post


Link to post
Share on other sites

Unless something has changed...

 

The AMA Documentation is stored in your installation folder in a text file named AMAindex.txt

(Example: C:\ProgramFiles\Hash Inc\v17.0g\AMAindex.txt)

 

This file can be updated and those updates shared with the community.

Understand that the A:M installer will likely replace this file upon re-installation so if you personalize the AMA documention make sure you keep a backup.

 

Edit: I've added the text file in the attached.

 

You can quickly add new AMA documentation simply by editing the text inside A:M or via the text file itself.

The entries adhere to the following XML formatting:

 

<ama_entry>
  <index_name>
  Chor|File Info
  </index_name>
  <property_name>
  File Info
  </property_name>
  <auto_doc>
  See File Info property.<br><i>Visible: Cache Only</i><br>
  </auto_doc>
  <data_link>
  NOLINK
  </data_link>
</ama_entry>

 

Note that Steffen maintains the master AMA document that gets published with each new update of the software.

To be effectively distributed any update must be synchronized with that master document.

AMAindex.txt

Share this post


Link to post
Share on other sites
To be effectively distributed any update must be synchronized with that master document.

 

That's the problem. There is no way synchronize these. We don't have any process for doing that.

Share this post


Link to post
Share on other sites
That's the problem. There is no way synchronize these. We don't have any process for doing that.

 

There was a brief discussion on this in the early v17 Alpha phase.

If I recall correctly my suggestion was to dedicate a place on the forum where a file would be hosted that would periodically be updated and made available for download. I believe Fuchur created a temporary webpage that would allow uploading of locally edited AMAindex files but anyway we cut it there is some manual effort involved in the process of sorting and sychronizing.

 

Background

There is a problem with this however in that the actual source of the core AMA data is in Animation:Master itself.

It consists of the documentation the programmers placed with the code. For the initial AMAindex.txt file Steffen tapped into that data.

As Steffen no longer has access to the program used for documentation the code base documentation itself is likely static and will not be updated in the near term.

 

This takes us back to creating a shared location where folks can share their local documentation in order to build a secondary master AMAindex.txt file.

This file would then be downloaded and either replace or be appended to the AMAindex file installed in current release folder.

Someone like me would then append all of the files together to create an updated AMAindex file.

 

In the end this largely gets back to that old bugbear problem of documentation.

Everyone wants documentation but few have the time or inclination to support the effort required in documentation.

 

Without another workable approach offered I can only suggest using the forum as an option.

If a master AMAindex file is maintained in the forum folks could upload their own files to add to the documentation.

 

The longer term solution is likely along the lines of a SVN repository maintaining all of the communities common resources (AMA documentation, tutorials, projects, models, etc.).

Share this post


Link to post
Share on other sites
Most of the things I do RMB>Display help for current property on just have "Not documented yet" appear.

 

How do we fix that?

 

Robert

Although working on a Mac, I use a PC mouse, simply because I prefer the RMB option. I miss the help option, it would be very helpful if it was there ( understatement ). Is there any news do you know on when it might be available for the Mac?

regards

simon

Share this post


Link to post
Share on other sites

Is there not a "Display help for Property" in the menu when you right-click on a property?

Share this post


Link to post
Share on other sites
Is there not a "Display help for Property" in the menu when you right-click on a property?

 

Robert

Thank you for your reply.

I tried, may be clicking on the wrong thing (?) but, there doesn't appear to be that option available.

Tried clicking in the model window and in the PWS but to no avail. I remember Help being available in the windows versions ( F13 ? ) but have never managed to find it in the OSX versions, possibly not ask as many questions if I had !

regards

simon

Share this post


Link to post
Share on other sites

Simon,

This is not the standard help (F13) but rather a Properties help that when you RMB on a Drop Down Menu's Property there is an option to display (and edit) the documentation (if any) for that Property. A link to another location (local or internet) can also be added to the Help dialog.

 

See attached for an example of what the menu looks like on a PC (when Right Clicking on Render Options under a Camera in the Project Workspace):

PropertiesDocumentation.jpg

Share this post


Link to post
Share on other sites

Here's what it should look like after clicking the Edit button to edit the help documentation:

(Note: This time I right clicked on the Quality setting under Render Options and the Help Properties (aka AMA documentation) displays what each of the Quality Settings are and provides information related to those options. Each user can personalize this help documentation... but note that Robert is currently interested in how we can share our personalized documentation with each other)

AMAnswers_edit.jpg

Share this post


Link to post
Share on other sites
Here's what it should look like after clicking the Edit button to edit the help documentation:

(Note: This time I right clicked on the Quality setting under Render Options and the Help Properties (aka AMA documentation) displays what each of the Quality Settings are and provides information related to those options. Each user can personalize this help documentation... but note that Robert is currently interested in how we can share our personalized documentation with each other)

 

Rodney

Thank you very much for your replies. I was unaware of that option and will be keen to explore it in the coming work.

Nb

I tried to RMB the properties in the render option on the menu bar ( render to file ) a couple of times and it crashed the program.

I looked more closely at your illustrations and it worked without fault when I tried it in the properties panel.

regards

simon

Share this post


Link to post
Share on other sites
it worked without fault when I tried it in the properties panel.

 

Outstanding. :)

 

I tried to the properties in the render option on the menu bar ( render to file ) a couple of times and it crashed the program.

If it's something that happens consistently every time you do it then report it to A:M Reports.

You just never know when you might help squash a bug that is causing everyone on a Mac problems.

Share this post


Link to post
Share on other sites

×