Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unify documentation #11

Closed
JeroenDeDauw opened this issue Feb 4, 2015 · 8 comments
Closed

Unify documentation #11

JeroenDeDauw opened this issue Feb 4, 2015 · 8 comments

Comments

@JeroenDeDauw
Copy link
Member

Right now docs are duplicated between the readme and the MW.org page, with the readme being incomplete and MW.org being out of date

@kghbln
Copy link
Member

kghbln commented Feb 5, 2015

I just updated the extensions page on mw.o, meaning that I removed all the stuff there except for the "Getting started" section which still needs to be moved to the README here. The rest seem to already be in a file within this repo.

@kghbln
Copy link
Member

kghbln commented Feb 5, 2015

This is not just about unifying documentation but also about initially creating documentation. However, I cannot be of further help here. I am just getting the summary field when trying to use the {{#signupfields:}} parser function within a form. I will probably ask on the mailing list after the release and go from there.

@mwjames
Copy link
Contributor

mwjames commented Feb 5, 2015

@toniher Can you help out here with a simple form that you used to check the {{#signupfields:}} functionality?

@toniher
Copy link
Member

toniher commented Feb 6, 2015

Sure, below a simple example:

This is the "User" form.
To create a page with this form, enter the page name below;
if a page with that name already exists, you will be sent to a form to edit that page.
{{#forminput:form=User}}

{{#signupfields:}} {{{for template|Institution}}} {| class="formtable" ! Institution: | {{{field|Institution|rows=3|mandatory}}} |} {{{end template}}} {{{standard input|save}}}{{{standard input|cancel}}}

@kghbln
Copy link
Member

kghbln commented Feb 6, 2015

That's how you do it? I would probably never have guessed since this seem to be too simple. Will give it a shot later today.

@mwjames
Copy link
Contributor

mwjames commented Feb 6, 2015

OK, here is what I got (after 164576f):

$egSemanticSignupSettings['formName'] = 'UserSignupForm';
$egSemanticSignupSettings['botName'] = '...'; //Existing user with "createaccount" rights

Form:UserSignupForm

<includeonly>{{#signupfields:}}{{{for template|UserSignup}}}
{| class="formtable"
! Institution: 
| {{{field|Institution|rows=3|mandatory}}}
|}
{{{end template}}}

{{{standard input|save|label=Create account}}}{{{standard input|cancel}}}</includeonly>

Template:UserSignup

<includeonly>[[Institution::{{{Institution|}}}]]</includeonly>

then go to "Create account" and ...

@kghbln
Copy link
Member

kghbln commented Feb 6, 2015

As I realise now I had apart from incorrectly using the signupfields parser function another issue. There was a typo in the form's and template's name causing the failure on my side.

@kghbln
Copy link
Member

kghbln commented Feb 6, 2015

Done this commit ae00c94 to fluff things up. The rest would be tweaks I guess. Thanks to @mwjames and @toniher

@kghbln kghbln closed this as completed Feb 6, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants