Wikifab Developers - User contributions [en]

Main Page

2016-11-21T09:44:09Z

Pierre:

Find here all development projects for Wikifab.

= Projects =

=== [[Internationalisation]] ===

Wikifab want to have one unique website, which supports all languages. Mediawiki already has extensions to supports this : https://www.mediawiki.org/wiki/Extension:Translate But this is not supported by the SemanticForms extensions.

The goal of this project is to make SemanticsForm compatible with extension Translate

Click here for more details : [[Internationalisation]]

=== [[Mobile App]] ===

Let's make a mobile app for Wikifab!

The main goal is to make it easier to take and upload pictures to tutorials.

=== [[Synchronisation of wikifabs]] ===

Many organizations have installed their own wikifab-based-site on their own server.

Today, they would like to publish some of their tutorials (created on their wikifab) to www.wikifab.org (or to another wikifab instance)

= Outils =

=== Documentation ===

Before coding on mediawiki, here is some doc you may read :
* https://www.mediawiki.org/wiki/Manual:Developing_extensions
* https://www.mediawiki.org/wiki/Manual:Coding_conventions

=== Gestion de Ticket ===

Mediawiki utilise Phabricator pour la gestion de ticket, nous vous invitons à y créer les ticket correspondant au feature que vous developpez, vous pouvez le lier au projet Wikifab en les taggant :

* https://phabricator.wikimedia.org/tag/wikifab/
* https://www.mediawiki.org/wiki/How_to_become_a_MediaWiki_hacker

Main Page

2016-11-21T09:35:54Z

Pierre:

Find here all development projects for Wikifab.

= Projects =

=== [[Internationalisation]] ===

Wikifab want to have one unique website, which supports all languages. Mediawiki already has extensions to supports this : https://www.mediawiki.org/wiki/Extension:Translate But this is not supported by the SemanticForms extensions.

The goal of this project is to make SemanticsForm compatible with extension Translate

Click here for more details : [[Internationalisation]]

=== [[Mobile App]] ===

Let's make a mobile app for Wikifab!

The main goal is to make it easier to take and upload pictures to tutorials.

=== [[Synchronisation of wikifabs]] ===

Many organizations have installed their own wikifab-based-site on their own server.

Today, they would like to publish some of their tutorials (created on their wikifab) to www.wikifab.org (or to another wikifab instance)

= Documentation =

Before coding on mediawiki, here is some doc you may read :
* https://www.mediawiki.org/wiki/Manual:Developing_extensions
* https://www.mediawiki.org/wiki/Manual:Coding_conventions
* https://www.mediawiki.org/wiki/How_to_become_a_MediaWiki_hacker

Main Page

2016-11-21T09:35:28Z

Pierre:

Find here all development projects for Wikifab.

= Projects =

=== [[Internationalisation]] ===

Wikifab want to have one unique website, which supports all languages. Mediawiki already has extensions to supports this : https://www.mediawiki.org/wiki/Extension:Translate But this is not supported by the SemanticForms extensions.

The goal of this project is to make SemanticsForm compatible with extension Translate

Click here for more details : [[Internationalisation]]

=== [[Mobile App]] ===

Let's make a mobile app for Wikifab!

The main goal is to make it easier to take and upload pictures to tutorials.

=== [[Synchronisation of wikifabs]] ===

Many organizations have installed their own wikifab-based-site on their own server.

Today, they would like to publish some of their tutorials (created on their wikifab) to www.wikifab.org (or to another wikifab instance)

= Documentation =

Before Code on mediawiki, here is the doc you may read :
* https://www.mediawiki.org/wiki/Manual:Developing_extensions
* https://www.mediawiki.org/wiki/Manual:Coding_conventions
* https://www.mediawiki.org/wiki/How_to_become_a_MediaWiki_hacker

Mobile App

2016-11-18T10:59:34Z

Pierre:

Mobile App

2016-11-18T10:58:35Z

Pierre:

=== Context ===

Today wikifab works on desktop only.

Users have to transfer their pictures from a camera to a laptop. This is very boring and time consuming.

We want to make an app to take pictures and transfer them automatically to tutorials.

=== State of the art ===

Mediawiki comes with a bunch of APIs that could be used to send pictures from the app to wikifab, and update turorials.

You can find the API documentation here: https://www.mediawiki.org/wiki/API:Main_page

There is also the [https://play.google.com/store/apps/details?id=net.r401.mediawiki.browser M2Wiki Browser] project, an app to browse any Mediawiki site on mobile. This app uses the MediaWiki API.

=== Features ===

==== Log in from mobile ====

To use the app, user needs to log in to wikifab from his mobile phone.

==== Browse tutorials ====

User can search for an existing tutorial from his mobile phone.

==== Create a new tutorial ====

User can create a new tutorial from his mobile phone.

The created tutorial should respect the Wikifab syntax defined in templates (available here : http://en.wikifab.org/index.php/Form:Tutorial?action=edit )

The templates has also html formating, but essentials information are found in tgas {{{....}}} such as :
{{#forminput:form=Tutorial|button text=Create or modify|placeholder=Enter the name of your tutorial}}
{{{field|Type|mandatory|class=form-dropdown}}}
{{{field|Area|mandatory|class=form-checkbox}}
{{{field|Description|input type=textarea|mandatory|rows=3|maxlength=4000|class=form-textarea|placeholder=Describe your tutorial in a few sentences.}}}
{{{field|Difficulty|input type=dropdown|mandatory|class=form-dropdown}}}
{{{field|Cost|mandatory|class=form-duration}}}
{{{field|Currency|mandatory|input type=dropdown|class=form-dropdown-2}}}
{{{field|Duration|mandatory|class=form-duration}}}
{{{field|Duration-type|mandatory|input type=dropdown|class=form-dropdown-2}}}
{{{field|Licences|input type=dropdown|class=form-dropdown-3}}}
{{{field|Main_Picture|default=No-image-yet.jpg|uploadable|size=25|class=form-picture|image preview}}}

{{{for template|Introduction}}}
{{{field|Introduction|input type=textarea|rows=5|maxlength=10000|class=form-textarea|placeholder=Describe your project in detail in this area (context, trials, etc.)}}}

{{{field|Material|input type=textarea|rows=8|placeholder=List the materials required to make your creation/product/object.
{{{field|Tools|input type=textarea|rows=8|placeholder=List the tools required to make your creation/product/object.
{{{field|Step_Picture_00|size=32|class=form-picture|default=|uploadable|image preview}}}
{{{field|Step_Picture_01|size=32|class=form-picture|default=|uploadable}}}
{{{field|Step_Picture_02|size=32|class=form-picture|default=|uploadable}}}
{{{field|Step_Picture_03|size=32|class=form-picture|default=|uploadable}}}
{{{field|Step_Picture_04|size=32|class=form-picture|default=|uploadable}}}
{{{field|Step_Picture_05|size=32|class=form-picture|default=|uploadable}}}

{{{for template|ExternalAttachmentsLinks|multiple|maximum instances=10|add button text=+ Add a link|embed in field=Materials[ExternalAttachmentsLinks]}}}
{{{field|ExternalAttachmentsLinks|input type=text}}}
{{{end template}}}
{{{for template|Tuto_Attachments|multiple|maximum instances=30|add button text=+ Add a file|embed in field=Materials[Tuto_Attachments]}}}
{{{field|Attachment|default=|uploadable}}}
{{{end template}}}

{{{for template|Tuto Step|multiple|minimum instances=1|maximum instances=100|add button text=+ Add a step}}}
{{{field|Step_Title|input type=text|class=form-text|placeholder=Title of the step|size=50}}}
{{{field|Step_Content|input type=textarea|rows=16|class=form-textarea|placeholder=Write here the instructions to be followed to complete this step.}}}
{{{field|Step_Picture_00|size=32|class=form-picture|default=|uploadable|image preview}}}
{{{field|Step_Picture_01|size=32|class=form-picture|default=|uploadable}}}
{{{field|Step_Picture_02|size=32|class=form-picture|default=|uploadable}}}
{{{field|Step_Picture_03|size=32|class=form-picture|default=|uploadable}}}
{{{field|Step_Picture_04|size=32|class=form-picture|default=|uploadable}}}
{{{field|Step_Picture_05|size=32|class=form-picture|default=|uploadable}}}
{{{end template}}}

{{{for template|Notes}}}
{{{field|Notes|input type=textarea|rows=5|maxlength=5000|placeholder=List the notes and references for this tutorial.}}}
{{{end template}}}

==== Take pictures ====

User can take pictures from his mobile phone.

==== Send picture to a tutorial ====

# User search for an existing tutorial or create a new one
# User selects the tutorial he wants to send picture to
# User selects pictures he took with the app (or pictures stored in his phone)
# User publish (send) the selected pictures to the tutorial library

Back on his laptop, user find the pictures in the library of pictures of the tutorial. He then can organise the pictures inside the tutorial from its laptop.

Mobile App

2016-11-18T10:49:32Z

Pierre:

Synchronisation of wikifabs

2016-11-18T10:44:07Z

Pierre:

=== Context ===

The wikifab source code is available to anyone for free.

Many organizations have installed their own wikifab-based-site on their own server and they would like to publish some of their tutorials (created on their wikifab) to www.wikifab.org (or to another wikifab instance).

=== State of the art ===

Mediawiki comes with a bunch of API that can be use to synchronize content among wikifab instances
Those APIs enable to create, view and edit pages.

You can find the API documentation here: https://www.mediawiki.org/wiki/API:Main_page

=== Installation guide ===

The guide to install a wikifab instance is here : https://github.com/Wikifab/wikifab-main

=== Features ===

==== login ====

APIs call need to log in on the target wiki. We imagine two different ways :

1st way : either each user on the source wiki must specified an access key on their preference, to link their account on the source wiki to an account on the target wiki. As the result, every tutorials synchronised to the source wiki will appear to be done by the user who do the sync action.

2nd way : an access key is configured globaly on the source wiki, and linked to one unique account on the target wiki. As the result, every tutorials synchronised to the source wiki will appear to be done by an user corresponding to the source wiki (which can be a specific type of user).

==== configure remote wiki ====

Admin of the source wiki must be able to configure a remote wiki to be a target wiki for sync tutorials.

It means :
* add name of the target wiki
* add url of the target wiki
* if needed, add login keys

Additionally, it may require some additional configuration : if categories has been changed, we must set a matching table to match a category from the source wiki, to a category on the target wiki. It may require more configuration if form template is changed. It may also be required on the target wiki to check that the tutorial content match actual forms fields.

This could be done in the configuration file LocalSettings.php

==== Push a tutorial to wikifab ====

Once a remote wiki is configured, a button "sync tutorial to <remote wiki name>" should appear an each tutorial.

Click on this button will send the tutorial content, with images to the target wiki.

==== Dealing with conflicts ====

'''When modification was made on parent'''

'''When modification was made on child'''

Internationalisation

2016-11-17T16:51:25Z

Pierre:

=== Context ===

Wikifab use the mediawiki extension 'PageForm' https://www.mediawiki.org/wiki/Extension:Page_Forms (extensions previously called SemanticsForm ).

This enabled us to create forms templates in order that users create new pages with a predefined form.

However, this extensions is not well integrated we the 'Translate' extension, which enable to have a multilingual website.

Today, wikifab has 2 websites :
* http://beta.wikifab.org : the first version in french
* http://en.wikifab.org : the english version

This requires that users create one account on each platform, and tutorials must be created separately on each site.

We want to have only one website, with translation features included. So that every tutorial can be easily translate to be available in many languages.

So, we want to update the PageForm extension to be properly integrated with Translate extension.

=== installation guide ===

An example of wikifab website with extension 'Translate' enabled is available here : http://i18n.test.wikifab.org/

To develop this feature, you can install a local version of wikifab on your computer or one of your server. You can either install a wikifab wiki and add Translate extension, or just install a mediawiki with Translate and PageForm extensions. The first option enable you to have already some forms templates to create tutorials.

==== Install wikifab site ====

Follow the tutorial here : https://github.com/Wikifab/wikifab-main

Then install Mediawiki extension 'Translate', see instructions here : https://www.mediawiki.org/wiki/MediaWiki_Language_Extension_Bundle

==== Install empty mediawiki with extension Translate and PageForm ====

Here are the commands to install ( proccess for ubuntu)

wget https://releases.wikimedia.org/mediawiki/1.27/mediawiki-1.27.1.tar.gz
tar -xzf mediawiki-1.27.1.tar.gz
mv mediawiki-1.27.1 translation.wikifab
cd translation.wikifab
cd extensions
git clone https://github.com/wikimedia/mediawiki-extensions-PageForms PageForms

And install Mediawiki extension Translate : https://www.mediawiki.org/wiki/MediaWiki_Language_Extension_Bundle

=== how Translate works ===

To translate content of a page, we must edit the page, and add tags <translate>...</translate> to wrap the text to translate, save the page, then Click the "Mark this page for translation" link.

Then it show you the translation units, and here is the trouble for wikifab : it doesn't respect the PageForm fields.

After valid it, texts blocs to translate appear on the special page 'Translate'.

=== To do ===

==== automatically add 'translate' tags ====

* Tags should be added either at page creation, or on a click on a specific action button.
* Tags should be added around each field to be translated.
* Tags should not be visible on edition of page with forms.

==== improve translation forms ====

After adding tags, all pages could be translated. But the translate form is not very good : each text block must be translate one by one, and we havn't a vision of the global page.

So we should create a translation form, which use a specific template, in the same way than we use form to create a tutorial page.

Internationalisation

2016-11-17T16:48:21Z

Pierre:

=== Context ===

Wikifab use the mediawiki extension 'PageForm' https://www.mediawiki.org/wiki/Extension:Page_Forms (extensions previously called SemanticsForm ).

This enabled us to create forms templates in order that users create new pages with a predefined form.

However, this extensions is not well integrated we the 'Translate' extension, which enable to have a multilingual website.

Today, wikifab has 2 websites :
* http://beta.wikifab.org : the first version in french
* http://en.wikifab.org : the english version

This requires that users create one account on each platform, and tutorials must be created separately on each site.

We want to have only one website, with translation features included. So that every tutorial can be easily translate to be available in many languages.

So, we want to update the PageForm extension to be properly integrated with Translate extension.

=== installation guide ===

An example of wikifab website with extension 'Translate' enabled is available here : http://i18n.test.wikifab.org/

To develop this feature, you can install a local version of wikifab on your computer or one of your server. You can either install a wikifab wiki and add Translate extension, or just install a mediawiki with Translate and PageForm extensions. The first option enable you to have already some forms templates to create tutorials.

==== Install wikifab site ====

Follow the tutorial here : https://github.com/Wikifab/wikifab-main

Then install Mediawiki extension 'Translate', see instructions here : https://www.mediawiki.org/wiki/MediaWiki_Language_Extension_Bundle

==== Install empty mediawiki with extension Translate and PageForm ====

Here are the commands to install ( proccess for ubuntu)

wget https://releases.wikimedia.org/mediawiki/1.27/mediawiki-1.27.1.tar.gz
tar -xzf mediawiki-1.27.1.tar.gz
mv mediawiki-1.27.1 translation.wikifab
cd translation.wikifab
cd extensions
git clone https://github.com/wikimedia/mediawiki-extensions-PageForms PageForms

And install Mediawiki extension Translate : https://www.mediawiki.org/wiki/MediaWiki_Language_Extension_Bundle

=== how Translate works ===

To translate content of a page, we must edit the page, and add tags <translate>...</translate> to wrap the text to translate, save the page, then Click the "Mark this page for translation" link.

Then it show you the translation units, and here is the trouble for wikifab : it doesn't respect the PageForm fields.

After valid it, texts blocs to translate appear on the special page 'Translate'.

=== To do ===

==== automatically add 'translate' tags ====

Tags should be added either at page creation, or on a click on a specific action button.

Tags should be added around each field to be translated.

==== improve translation forms ====

After adding tags, all pages could be translated. But the translate form is not very good : each text block must be translate one by one, and we havn't a vision of the global page.

So we should create a translation form, which use a specific template, in the same way than we use form to create a tutorial page.

Internationalisation

2016-11-17T16:44:01Z

Pierre:

=== Context ===

Wikifab use the mediawiki extension 'PageForm' https://www.mediawiki.org/wiki/Extension:Page_Forms (extensions previously called SemanticsForm ).

This enabled us to create forms templates in order that users create new pages with a predefined form.

However, this extensions is not well integrated we the 'Translate' extension, which enable to have a multilingual website.

Today, wikifab has 2 websites :
* http://beta.wikifab.org : the first version in french
* http://en.wikifab.org : the english version

This requires that users create one account on each platform, and tutorials must be created separately on each site.

We want to have only one website, with translation features included. So that every tutorial can be easily translate to be available in many languages.

So, we want to update the PageForm extension to be properly integrated with Translate extension.

=== installation guide ===

To develops this feature, you can either install a wikifab wiki and add Translate extension, or just install a mediawiki with Translate and PageForm extensions :

==== Install wikifab site ====

Follow the tutorial here : https://github.com/Wikifab/wikifab-main

Then install Mediawiki extension 'Translate', see instructions here : https://www.mediawiki.org/wiki/MediaWiki_Language_Extension_Bundle

==== Install empty mediawiki with extension Translate and PageForm ====

Here are the commands to install ( proccess for ubuntu)

wget https://releases.wikimedia.org/mediawiki/1.27/mediawiki-1.27.1.tar.gz
tar -xzf mediawiki-1.27.1.tar.gz
mv mediawiki-1.27.1 translation.wikifab
cd translation.wikifab
cd extensions
git clone https://github.com/wikimedia/mediawiki-extensions-PageForms PageForms

And install Mediawiki extension Translate : https://www.mediawiki.org/wiki/MediaWiki_Language_Extension_Bundle

=== how Translate works ===

To translate content of a page, we must edit the page, and add tags <translate>...</translate> to wrap the text to translate, save the page, then Click the "Mark this page for translation" link.

Then it show you the translation units, and here is the trouble for wikifab : it doesn't respect the PageForm fields.

After valid it, texts blocs to translate appear on the special page 'Translate'.

=== To do ===

==== automatically add 'translate' tags ====

Tags should be added either at page creation, or on a click on a specific action button.

Tags should be added around each field to be translated.

==== improve translation forms ====

After adding tags, all pages could be translated. But the translate form is not very good : each text block must be translate one by one, and we havn't a vision of the global page.

So we should create a translation form, which use a specific template, in the same way than we use form to create a tutorial page.

Internationalisation

2016-11-17T16:09:59Z

Pierre:

=== Context ===

Today wikifab has 2 websites :
* http://beta.wikifab.org : the first version in french
* http://en.wikifab.org : the english version

This requires that users create one account on each platform, and tutorials must be created separately on each site.

We want to have only one website, with translation features included. So that every tutorial can be easily translate to be available in many languages.

Mediawiki has an extension for this : Translate ( https://www.mediawiki.org/wiki/Extension:Translate ) this enable that each page of the wiki can be translated.
Wikifab use the PagesForm extension https://www.mediawiki.org/wiki/Extension:Page_Forms (extensions called previously SemanticsForm ). Unfortunately, this extension doesn't support page translation.

=== state of the art ===

=== installation guide ===

To develops this feature, you can either install a wikifab wiki and add Translate extension, or just install a mediawiki with Translate and PageForm extensions :

==== Install wikifab site ====

Follow the tutorial here : https://github.com/Wikifab/wikifab-main

Then install Mediawiki extension Translate, see instructions here : https://www.mediawiki.org/wiki/MediaWiki_Language_Extension_Bundle

==== Install empty mediawiki with extension Translate and PageForm ====

Here are the commands to install ( proccess for ubuntu)

wget https://releases.wikimedia.org/mediawiki/1.27/mediawiki-1.27.1.tar.gz
tar -xzf mediawiki-1.27.1.tar.gz
mv mediawiki-1.27.1 translation.wikifab
cd translation.wikifab
cd extensions
git clone https://github.com/wikimedia/mediawiki-extensions-PageForms PageForms

And install Mediawiki extension Translate : https://www.mediawiki.org/wiki/MediaWiki_Language_Extension_Bundle

=== To do ===

* add link 'translate' to each page not translated
* change translate page to use forms. We may need to use specifics templates for translation.

Internationalisation

2016-11-17T14:12:51Z

Pierre:

Internationalisation

2016-11-17T13:43:45Z

Pierre: Created page with "=== Context === Today wikifab has 2 websites : * http://beta.wikifab.org : the first version in french * http://en.wikifab.org : the english version This requires that use..."

Main Page

2016-11-17T13:25:34Z

Pierre:

Find here all development projects for Wikifab.

== Projects ==

=== [[Internationalisation]] ===

Wikifab want to have one unique website, which supports all languages. Mediawiki already has extensions to supports this : https://www.mediawiki.org/wiki/Extension:Translate But this is not supported by the SemanticForms extensions.

The goal of this project is to make SemanticsForm compatible with extension Translate

Click here for more details : [[Internationalisation]]

=== [[Mobile App]] ===

Let's get a mobile app to wikifab !

The main goal is to make it easier to take and upload pictures on tutorials.

=== [[Synchronisation of wikis]] ===

Many associations have installed their own wikifab wiki. And they want a way to push a tutorial writed on their site to Wikifab site (or to an other wiki)

Main Page

2016-11-17T13:25:16Z

Pierre:

Find here all developpement project for Wikifab.

== Projects ==

=== [[Internationalisation]] ===

Wikifab want to have one unique website, which supports all languages. Mediawiki already has extensions to supports this : https://www.mediawiki.org/wiki/Extension:Translate But this is not supported by the SemanticForms extensions.

The goal of this project is to make SemanticsForm compatible with extension Translate

Click here for more details : [[Internationalisation]]

=== [[Mobile App]] ===

Let's get a mobile app to wikifab !

The main goal is to make it easier to take and upload pictures on tutorials.

=== [[Synchronisation of wikis]] ===

Many associations have installed their own wikifab wiki. And they want a way to push a tutorial writed on their site to Wikifab site (or to an other wiki)

Main Page

2016-11-17T13:25:01Z

Pierre:

<strong>MediaWiki has been installed.</strong>

Find here all developpement project for Wikifab.

== Projects ==

=== [[Internationalisation]] ===

Wikifab want to have one unique website, which supports all languages. Mediawiki already has extensions to supports this : https://www.mediawiki.org/wiki/Extension:Translate But this is not supported by the SemanticForms extensions.

The goal of this project is to make SemanticsForm compatible with extension Translate

Click here for more details : [[Internationalisation]]

=== [[Mobile App]] ===

Let's get a mobile app to wikifab !

The main goal is to make it easier to take and upload pictures on tutorials.

=== [[Synchronisation of wikis]] ===

Many associations have installed their own wikifab wiki. And they want a way to push a tutorial writed on their site to Wikifab site (or to an other wiki)