Two issues with plugin framework handbook
Hi,
I have added a couple of pages to the handbook, namely the pages for Chord Object and Cursor Object (the latter has a few open points: filling in is welcome!).
Two points emerged:
1) The new pages are created in the http://musescore.org/handbook/ folder, while the Score Object
page originally created by Thomas is the main http://musescore.org/ root. Is this is a problem? Is it better to make them uniform?.
2) Page names probably need some qualification: for instance, a text page already exists for the main manual handbook; when the page for the scripting Text object will be created will it overwrite the current page? How can be made different? For the moment being, while referring to this (future) page I have used the "Text-plugin" name, but probably there is a better solution.
Thanks,
M.
Comments
1) When making a plugin development page, you need to select 'language independent' instead of 'English'. Otherwise, it's taken up in the translation workflow of the translators and we don't want this (yet). With the language independent setting, the right path is taken:
http://musescore.org/plugin-development/...2) overwriting will never happen since the path with use numbers to make distinction in case it has the same title. E.g.
http://musescore.org/handbook/textandhttp://musescore.org/handbook/text-0. But as long the name spaces do not clash, it's ok.Thanks.
1) I'm pretty sure I have selected "Language independent", unless it is not 'sticky' and need to be re-selected after the many previews the first redaction always needs. For the next, I'll double check.
2) Good. But: when I need to refer to the "Text" page (for instance, from withing the "Cursor" page), is any step needed to make sure the link will be to the scripting "Text" and not to the main handbook "Text"?
So far, I have used 'simple links' like "[ [score] ]" (without blanks between the brackets!). What happens is that, for instance in the "Cursor" page, "[ [chord] ]" is converted to
http://musescore.org/handbook/chordwhile "[ [score] ]" is converted tohttp://musescore.org/score(which in turn 'magically' resolves tohttp://musescore.org/plugin-development/score).Thanks,
M.
In reply to Thanks. 1) I'm pretty sure I by Miwarre
2) Ah, you're right about the quick links [ [ ] ]. So the titles must be different in order not to clash. Will that work out you think?
In reply to ok, title clash by Thomas
I made a few tests:
1) if the page
page-nameexists and exists only in/plugin-development/, the quick link [ [ page-name ] ] is converted tohttp://musescore.org/plugin-development/page-name, but2) if both
http://musescore.org/plugin-development/page-nameandhttp://musescore.org/handbook/page-nameexist, the quick link is converted into the latter (textpage, for instance, already exists in both).Not sure what to do:
1) Use page names like "Text (scripting)"? (this probably requires quick links like "[ [text%20%28scripting%29] ] !!)
2) Give up quick links and use hard coded paths
http:/musescore.org/plugin-development/text?3) Other alternatives?
Also, what if one needs to link to, say,
/plugin-development/textfrom within the manual handbook or from outside either handbook?M.
In reply to I made a few tests: 1) if the by Miwarre
Quick link swork as well like this [ [Link|Text]] .
We could call the page for plugin objects : Chord Object, Score Object etc...
Yes, I know about [ [Link|Text]]; I was worried about having to type non-obvious and error-prone links with codes.
"<Name> Object" sounds and looks fine to me.
Agreed? Shall we go on?
M.
In reply to Yes, I know about [ by Miwarre
Sure! Keep on the good work
OK, I have added pages for all the objects under the new "<Name> Object" names. A few of them are still empty, but at least the place holder is there.
Thomas:
1) could you please delete the old pages (the ones without the trailing "Object") and
2) ahem, I did it again: the page for "Chord Object" is labeled English instead of Language independent. But now I know why: when clicking "Preview", this setting is reset to the default and one has to remember to set it again before the final save (other pages are ok).
Everybody:
I'm not English mother-tongue and there are some open points here and there (marked in bold): any additional revision and editing is welcome.
Thanks,
M.
In reply to Most of the framework now in place. by Miwarre
1) I wonder why you made new pages. Did you try to edit the title of the old pages?
2) Ok, good to know. Let me check whether I can solve this issue.
In reply to Thx by Thomas
1) Errr... no... As in most other cases a post, once posted, cannot be renamed, I blindly assumed this was also the case. How silly of me!
Thanks for cleaning up my mess!
M.
In reply to Most of the framework now in place. by Miwarre
I think I fixed the problem. I can't reproduce it anymore. I hope I didn't introduce a new problem. So keep eyes open ;-)
In reply to Preview language independent child pages by Thomas
Yep! Everything looks fixed now. And new pages even default to "Language neutral": I appreciate!!
Thanks,
M.