|
Re: New developer version V1.1.1 released [message #208 is a reply to message #207] |
Thu, 30 October 2008 09:45 |
Susanne Wunsch railML
Messages: 0 Registered: January 2020
|
|
|
|
Thanks Volker for starting documentation issues!
Dr. Volker Knollmann wrote:
> Dear friends of RailML,
>
> To give you an impression how a wiki-based RailML-documentation can look
> like, I linked and created four more documentation pages. You can find a
> list of all available pages here:
>
> http://wiki.railml.org/index.php?title=IS_Docu_Main
>
> Please provide some feedback on these pages because they will be the
> master for all subsequent documentation. Thanks!
For newbies, some "Examples" section per entry could be offered.
Changing "Elements and attributes that use xxx" to
"Elements, types and attributes that use xxx" because "tGeoCoord" is
used by type "tPlacesElement".
I don't want to discuss about translations, term "Boundary Conditions"
means "Constraints", doesn't it?
Why didn't you integrate "Notes" in the default template?
In which cases do you use <tt>...</tt>?
I mentioned, you put all railML-Elements in "<"...">". That's fine,
maybe additional <tt>...</tt> helps for recognizing the railML keyword?
Additional, they could be linked for further work on elements.
Maybe applying <tt>...</tt> to railML and XML types would do the same job.
Do we need such a template for elements, too? Why doesn't use it for
all, elements, types, attributes and attribute groups?
That's a nice template, if all keywords are described this way, we did a
great jump in acceptance of railML, I think!
Everybody can help, getting an Wiki-account and describing used keywords!
Best regards ...
Susanne
--
Susanne Wunsch
Schema Coordinator: railML.common
|
|
|
Re: New developer version V1.1.1 released [message #209 is a reply to message #208] |
Thu, 30 October 2008 17:46 |
Dr. Volker Knollmann
Messages: 17 Registered: September 2008
|
Junior Member |
|
|
On 30/10/08 09:45, Susanne Wunsch wrote:
> Changing "Elements and attributes that use xxx" to
> "Elements, types and attributes that use xxx" because "tGeoCoord" is
> used by type "tPlacesElement".
Ok, I'll insert the word "attribute" in the template.
> I don't want to discuss about translations, term "Boundary Conditions"
> means "Constraints", doesn't it?
Well, "Boundary conditions" is often used in a more mathematical sense,
i. e. "things that have to be true / fulfilled" ("Randbedingungen").
The meaning of "constraints" refers IMHO more to "things you have to be
aware of" ("Einschränkungen").
Discussing the difference here would end up in nit-picking, since both
words are semantically very close together. And since we're are not in a
mathematical context here, I don't mind changing the template from
"boundary conditions" to "constraints", since I'm going to edit it
anyway... ;-)
> Why didn't you integrate "Notes" in the default template?
>
> [...]
>
> Do we need such a template for elements, too? Why doesn't use it for
> all, elements, types, attributes and attribute groups?
The current version of our wiki software does not support the usage of
templates within templates. When I wrote the documentation, I tried to
create "mini-templates" for links, tags, elements, etc. Would
unfortunately, those references to templates are not interpreted when
using from within another template.
Another thing that does currently not work is the setting of default
values for template parameters. Imagine you don't have any "Notes" for
an entry. This is probably the usual case. Then you don't want to insert
"left blank" or "no entry" or something like that every time you create
a new page. But instead you want to have a default value like "n/a" for
ALL template parameters you don't set explicitly in your template
instance. And exactly this handling of default values doesn't work with
our quite old wiki version.
I asked our webmaster to update to a more recent version of the wiki
software, which should solve the problems. He promised to apply the
update within the next days.
After he applied the patches, I'll extend the documentation framework to
use default parameters and "templates in templates".
In fact I spent half a day trying to get these two features working with
our wiki version... but I failed... *sigh*
Best regards,
Volker
--
Dr. Volker Knollmann
RailML Infrastructure Coordinator
EMail: coord(at)infrastructurerailmlorg
Business contact:
Siemens AG
Industry Sector
I MO RA SPP SM21
Ackerstr. 22
38126 Braunschweig
Tel.: +49 (531) 226-2592
mailto:volkerknollmann(at)siemenscom
|
|
|
Re: New developer version V1.1.1 released [message #212 is a reply to message #209] |
Wed, 19 November 2008 18:17 |
Dr. Volker Knollmann
Messages: 17 Registered: September 2008
|
Junior Member |
|
|
On 30/10/08 17:46, Dr. Volker Knollmann wrote:
> I asked our webmaster to update to a more recent version of the wiki
> software, which should solve the problems. He promised to apply the
> update within the next days.
>
> After he applied the patches, I'll extend the documentation framework to
> use default parameters and "templates in templates".
A few days ago, Alex updated the wiki to a newer version and afterwards
I fixed the existing example documentation.
It now includes default parameters for template variables as well as
"templates in templates" e. g. to create links to other documentation
pages or to display nice <tags> etc.
Please take look at the wiki pages and comment on them!
Best regards,
Volker Knollmann
--
Dr. Volker Knollmann
RailML Infrastructure Coordinator
EMail: coord(at)infrastructurerailmlorg
Business contact:
Siemens AG
Industry Sector
I MO RA SPP SM21
Ackerstr. 22
38126 Braunschweig
Tel.: +49 (531) 226-2592
mailto:volkerknollmann(at)siemenscom
|
|
|