[PA1930]

Very nice idea indeed.

[James Ross]

edwardk, on 16 December 2015 - 03:52 AM, said:

I just completed the basis of the work. The button operation that I copied is the Tools button. I created a Documents folder under the program folder and I have been testing with pdf files. As far as other file formats, I would have to assume that the doc format will also be included. I am not sure how much further we want to take this concept, but what I am testing now is working well. I just need to make sure that the Documents naming convention for the folder is fine or should this be changed?

The build process creates a folder called Documentation and it only produces PDF files (it converts everything else to PDF) - so that's all we need to worry about. You can download the Testing Version from http://openrails.org/download/program/ to check your code works with what's generated if you like.

For localised versions, which I think we should add after the initial function is done, I think we'll need a naming convention to identify languages. I would recommend we name the files "Normal name with spaces (language-code).pdf". The button can then check the language code and decide what to do with it. We'll need to rename some of the existing files but that's fine.

[edwardk]

James Ross, on 16 December 2015 - 04:25 AM, said:

The build process creates a folder called Documentation and it only produces PDF files (it converts everything else to PDF) - so that's all we need to worry about. You can download the Testing Version from http://openrails.org/download/program/ to check your code works with what's generated if you like.

For localised versions, which I think we should add after the initial function is done, I think we'll need a naming convention to identify languages. I would recommend we name the files "Normal name with spaces (language-code).pdf". The button can then check the language code and decide what to do with it. We'll need to rename some of the existing files but that's fine.

The Documentation folder is found under the source directory, but not under the compiled Program folder. This is probably done to save space, but since this feature is being added, the Documentation folder must be included with the build process. I am talking about the experimental versions so I am guessing the stable version has the Documentation folder.

Edit: The documentation folder also includes the docx, and the pptx formats.

Edward K.

[edwardk]

The file formats found under the experimental Documentation folder are included. Everything is working well. If the Documentation folder is not included, then nothing will happen when the Documents button is clicked. Keep in mind that I am talking about the experimental builds.

James, do you want a test version uploaded here first for testing?

Edward K.

[James Ross]

edwardk, on 16 December 2015 - 01:01 PM, said:

The Documentation folder is found under the source directory, but not under the compiled Program folder. This is probably done to save space, but since this feature is being added, the Documentation folder must be included with the build process. I am talking about the experimental versions so I am guessing the stable version has the Documentation folder.

Edit: The documentation folder also includes the docx, and the pptx formats.

The "Source\Documentation" folder is the source of the documentation and "Program\Documentation" is the compiled (PDF) versions. Please download the Stable Version or Testing Version and see for yourself.

edwardk, on 16 December 2015 - 01:15 PM, said:

The file formats found under the experimental Documentation folder are included. Everything is working well. If the Documentation folder is not included, then nothing will happen when the Documents button is clicked. Keep in mind that I am talking about the experimental builds.

This sounds like you're talking about "Source\Documentation" which is not included in any downloads (except the actual source downloads) and is not useful. The Unstable (experimental) Version does NOT come with any documentation! Do not try and make it work in that situation because it can't.

As for what happens in the Unstable Version, when there is no documentation, please disable the button.

[James Ross]

edwardk, on 16 December 2015 - 01:15 PM, said:

James, do you want a test version uploaded here first for testing?

After you've updated it to work as I've described, please do so, thanks.

[edwardk]

James Ross, on 17 December 2015 - 09:21 AM, said:

The "Source\Documentation" folder is the source of the documentation and "Program\Documentation" is the compiled (PDF) versions. Please download the Stable Version or Testing Version and see for yourself.


This sounds like you're talking about "Source\Documentation" which is not included in any downloads (except the actual source downloads) and is not useful. The Unstable (experimental) Version does NOT come with any documentation! Do not try and make it work in that situation because it can't.

As for what happens in the Unstable Version, when there is no documentation, please disable the button.

Keep in mind James that developers also need easy access to documentation. Thanks for the disabling the button tip. This was something I was not thinking about.

Edward K.

[Genma Saotome]

Speaking of the documentation, is there someone tasked with adding more levels of detail to the Table of Contents? Or alternatively a comprehensive index?

[edwardk]

As of V3392, the feature to allow immediate access to documentation was added on the menu. If you are running the stable version, the Documentation folder will be present, but not present with the experimental versions that are downloaded. This folder can be found under the source directory if you are downloading via TortoiseSVN.

Edward K.

[Sid P.]

Genma Saotome, on 17 December 2015 - 01:50 PM, said:

Speaking of the documentation, is there someone tasked with adding more levels of detail to the Table of Contents? Or alternatively a comprehensive index?

Some thoughts:
Since the Manual is presented in a PDF (or Doc) viewer with all of the sub headings available in the "navigation" or "view" panel, I don't feel that much is to be gained by adding more levels to the "Table of Contents" page in the document itself.
Also, the search capability of the PDF viewer performs some of the function of an index, although a real index has the advantage of providing context to the entries. It is quite a job to develop a good index for a document.
(BTW, I would not recommend having the .doc version used as the reference, since unless you take care to open it in "read-only" mode in the reader, it's possible to mess it up accidentally.)