Page 1 of 1
| New Manual 31/12/2011 at 22:06 #26546 | |
Steamer
3984 posts |
I've written a new manual for Exeter, which is hopefully more detailed and more helpful. Everything that was in the old one is still in the new one, but might be in a diffrent place- the Hot Keys, multiplay and hints and tips are now listed in the contents. Feedback/proof readers appreciated! {Direct link added for convenience - mod} "Don't stress/ relax/ let life roll off your backs./ Except for death and paying taxes/ everything in life.../ is only for now." (Avenue Q) Last edited: 01/01/2012 at 01:07 by AndyG Log in to reply The following users said thank you: Peter Bennet, AndyG, headshot119, welwyn |
| Re: New Manual 31/12/2011 at 22:19 #26547 | |
Peter Bennet
5402 posts |
Looks great- thanks. Peter I identify as half man half biscuit - crumbs! Log in to reply |
| Re: New Manual 01/01/2012 at 01:16 #26552 | |
headshot119
4869 posts |
Just one thing Quote: EJ25 and EJ28 set warner routes only.Shouldn't that be "EJ25 and EJ28 are approached controlled." But apart from that mate it's a fantastic bit of work, and really helps get the features and quirks of the sim worked out. Now where is the Karma button. "Passengers for New Lane, should be seated in the rear coach of the train " - Opinions are my own and not those of my employer Last edited: 01/01/2012 at 01:17 by headshot119 Log in to reply |
| Re: New Manual 01/01/2012 at 12:28 #26559 | |
maxand
1637 posts |
Great work, Steamer. The extra detail you included will be very helpful. Some minor feedback as requested: 1) On the Version Control page, the most recent version is listed as Version 2.201 released 16/11/09 , whereas the current version (taken from the Download page) is v2.227. This begs the question: Who takes responsibility for the version control page? The problem here is the age-old one that duplication of data leads to one or the other getting out of sync. The solution might be NOT to duplicate the current version number in the manual but simply to refer the reader to the download page, where the latest version is sure to be available. The problem with this is that for sims such as Edinburgh, available to registered users only, the download page is unavailable. Since registration is free, I can't see the continuing need for this dichotomy, but maybe there is some reason for it to be preserved that I've overlooked. On the other hand, the Known Issues material is useful, provided that it refers to the current version (2.227) and not an earlier one. Conversely, what's missing here is an entry saying when the manual was last updated. This is for people who don't know about, can't or don't wish to access the "Recent Changes" section of the Wiki to find out. I would like to see a "Last updated: [date]" entry at the top of the Contents page of the manual, also preferably a second line listing the version number of the sim to which the manual refers, so we can all be sure the manual is up to date. As a minor point, the "Version History and Known Issues" page is a good thing to have, but in fact there is no version history here. A true Version History is quite an informative document, listing all the versions and the dates they were published, along with a list of changes which a savvy user could cross-check against statements made in the manual. I believe only Geoff Mayo, the author of the Exeter sim, is in a position to provide this. I don't know whether this information is available elsewhere in the Wiki, or privy only to other developers (more likely), but if it's not publicly available, this page should be renamed "Known Issues" and limited to those issues relating to the current sim. 2) I notice that in the Exeter Multiplay and Chaining, the link to the Next page is a red dotted underlined link, meaning the page hasn't been created. Fair enough, but a problem with this is that a newcomer to this manual may think this this end of the unfinished manual, missing further pages with useful stuff, such as Hot keys. To guard against this it's probably a better decision to create these pages anyway so all the links work, and include "To be completed" on them till you have time to finish them. Another term for these dummy pages is "stub pages". 3) In the Exeter Overview, Exeter Operation and Exeter Level Crossings pages you have misspelt Paignton as Paington, which is easy to do but makes searching for "Paignton" harder! 4) My understanding of Panel Views are that these are what an individual operator might see on his workstation screen, but what's the significance of the green rectangles with the four vertical bars, labelled Panel? I tried to look up the Wiki on this one but as the word "panel" occurs so frequently all I got was a time-wasting flood of false positives. So can someone please explain what to do about them and/or point me to a Wiki page where this symbol is explained? Thanks. Last edited: 01/01/2012 at 12:29 by maxand Log in to reply |
| Re: New Manual 01/01/2012 at 12:29 #26560 | |
|
Steamer
3984 posts |
" said:Shouldn't that be "EJ25 and EJ28 are approached controlled."I don't think so- if you set a route from EJ25>EJ27>Exmouth, the signals will clear. If EJ25 were approach controlled, it would still wait at red until the train got there. "Don't stress/ relax/ let life roll off your backs./ Except for death and paying taxes/ everything in life.../ is only for now." (Avenue Q) Log in to reply |
| Re: New Manual 01/01/2012 at 12:44 #26561 | |
|
maxand
1637 posts |
I'm glad you included on the Exeter Operation page a note about signals 5, 200, 90, 190 and 13, which were the subject of a recent forum thread. I took the liberty of adding a "See this forum thread" link here as the thread contains a lot of informative extra material. Hope you don't mind. I'm getting into the habit of including links in the Wiki back to significant forum threads, as these too easily get buried by later threads and can be hard to find again. Last edited: 01/01/2012 at 12:45 by maxand Log in to reply The following user said thank you: Steamer |
| Re: New Manual 01/01/2012 at 12:46 #26562 | |
|
Steamer
3984 posts |
" said:1) On the Version Control page, the most recent version is listed as Version 2.201 released 16/11/09 , whereas the current version (taken from the Download page) is v2.227. This begs the question: Who takes responsibility for the version control page? Not me- that's the one page I didn't mess about with! " said: I believe only Geoff Mayo, the author of the Exeter sim, is in a position to provide this. Didn't Peter Bennet write Exeter? " said: 4) My understanding of Panel Views are that these are what an individual operator might see on his workstation screen, but what's the significance of the green rectangles with the four vertical bars, labelled Panel? I tried to look up the Wiki on this one but as the word "panel" occurs so frequently all I got was a time-wasting flood of false positives. So can someone please explain what to do about them and/or point me to a Wiki page where this symbol is explained? Thanks.Panel is another term for Workstation. The rectangular bars are where the user name in control of that panel goes in multiplayer. " said: 2) I notice that in the Exeter Multiplay and Chaining, the link to the Next page is a red dotted underlined link, meaning the page hasn't been created. Fair enough, but a problem with this is that a newcomer to this manual may think this this end of the unfinished manual, missing further pages with useful stuff, such as Hot keys. To guard against this it's probably a better decision to create these pages anyway so all the links work, and include "To be completed" on them till you have time to finish them. Another term for these dummy pages is "stub pages".Done. The reason these weren't created is that I don't have the information to fill them with- help appreciated! " said: 3) In the Exeter Overview, Exeter Operation and Exeter Level Crossings pages you have misspelt Paignton as Paington, which is easy to do but makes searching for "Paignton" harder!**Insert expletive of choice here**! Now corrected, thanks for pointing it out! EDITED TO ADD: Version control- added latest release to list. Bugs- Removed ones for the old version, none that I am aware of in the new version. "Don't stress/ relax/ let life roll off your backs./ Except for death and paying taxes/ everything in life.../ is only for now." (Avenue Q) Last edited: 01/01/2012 at 12:58 by Steamer Log in to reply |
| Re: New Manual 01/01/2012 at 13:29 #26563 | |
|
Peter Bennet
5402 posts |
" said:I think Geoff (or maybe Mike) wrote the original paged Sim but I took on the roll of refreshing it in recent years. The version control thing is where I tend to write the changes I've made since the previous release as much as reference for myself as anything else. I'd not really come to any conclusion as to how to then incorporate the changes into the main text - to just rewrite so it's current or highlight the changes which can get messy. I'm reasonably relaxed as to how others wish to take this forward- writing the manuals is not my favourite activity- I tend to provide the bones and as things arise they can be included. Peter I identify as half man half biscuit - crumbs! Log in to reply The following users said thank you: maxand, Steamer |
| Re: New Manual 01/01/2012 at 13:30 #26564 | |
|
maxand
1637 posts |
Steamer wrote: Quote: Didn't Peter Bennet write Exeter?Didn't know that. I just took my info from the Exeter Download page, where it says v2.227 was submitted by Geoff Mayo on 21 Aug 2011. This must refer to the latest version. I can't see Peter Bennet's name anywhere on this page. This is where a proper Version History page might be useful, giving credit where credit's due. Maybe your Acknowledgment page, when completed, could include some authorship details. I'm sure interested members would appreciate this. Thanks for explaining the significance of the Panel Box. So as a solo player I shouldn't need to take any notice of it. I thought for a moment it had something to do with lever frames, but they have larger icons. Last edited: 01/01/2012 at 13:32 by maxand Log in to reply |
| Re: New Manual 01/01/2012 at 13:51 #26566 | |
|
Steamer
3984 posts |
" said:I think Geoff (or maybe Mike) wrote the original paged Sim but I took on the roll of refreshing it in recent years. OK. " said: I just took my info from the Exeter Download page, where it says v2.227 was submitted by Geoff Mayo on 21 Aug 2011. Geoff or admin submits all the Simulations to the Downloads area- for example, he submitted South Humberside, which was written by Chris Lord. " said: This is where a proper Version History page might be useful, giving credit where credit's due. The clue's in the name! Acknowledgements will be found in the acknowledgements section! I didn't fill this page in because I don't know who to thank- that's a job for developers/testers who know these things. "Don't stress/ relax/ let life roll off your backs./ Except for death and paying taxes/ everything in life.../ is only for now." (Avenue Q) Log in to reply |
| Re: New Manual 01/01/2012 at 14:02 #26568 | |
|
Peter Bennet
5402 posts |
Added as much as I know to that page. Peter I identify as half man half biscuit - crumbs! Log in to reply The following user said thank you: Steamer |
| Re: New Manual 01/01/2012 at 14:31 #26570 | |
|
headshot119
4869 posts |
" said:" said:Having just gone and tested it I see your point. It's not something I've actually noticed before.Shouldn't that be "EJ25 and EJ28 are approached controlled."I don't think so- if you set a route from EJ25>EJ27>Exmouth, the signals will clear. If EJ25 were approach controlled, it would still wait at red until the train got there. "Passengers for New Lane, should be seated in the rear coach of the train " - Opinions are my own and not those of my employer Log in to reply |