Wikidata:Yadda ake ƙirƙirar Wikidata Tours/Javascript
Ƙirƙiri shafin JavaScript
Duk yawon shakatawa na buƙatar fayil ɗin JavaScript wanda ya ƙunshi saitin zaɓuɓɓuka don daidaita tafiyar. Mai Gudanarwar Interface ana buƙatar haƙƙin don tura fayil ɗin JavaScript don gwaji, don haka kuna buƙatar amfani da wannan list of Interface Admins don nemo wanda zai taimaka idan kun isa wannan matakin. Sauran umarnin a kan wannan shafin an yi niyya ne don Mai Gudanar da Interface wanda aka tsara don taimakawa.
Lura: Idan kuna da ainihin ilimin JavaScript da CSS, zaku iya ƙirƙirar fayil ɗin JavaScript da kanku ta bin matakai akan wannan shafin. Har yanzu kuna buƙatar taimako daga Interface Admin don a zahiri tura fayil ɗin don gwaji a mataki na gaba, amma wannan zai adana su ɗan lokaci kamar yadda za su iya farawa daga fayil ɗin JavaScript ɗinku.
Sunan fayil da wurin
A wannan mataki na aiwatarwa, ya kamata a ƙirƙiri fayil ɗin JavaScript a cikin sararin mai amfani na ku, misali. Mai amfani:YOUR_USERNAME/ yawon shakatawa/wbmycooltour.js. Koyaya, don gudanar da yawon shakatawa a zahiri (ko dai akan test.wikidata.org ko babban wikidata.org) kuna buƙatar sanya fayil ɗin JavaScript a cikin sunan MediaWiki ta amfani da yarjejeniyar suna mai zuwa: MediaWiki:Guidedtour-tour-' sunan yawon shakatawa.js.
Hakanan an ƙayyade [sunan yawon shakatawa] azaman ɗayan zaɓuɓɓukan daidaitawa a cikin fayil ɗin JavaScript. Wannan dole ne ya dace da sunan fayil don yawon shakatawa don lodawa. Misali, yi amfani da sunan fayil MediaWiki:Guidedtour-tour-wbcoordinates'.js don yawon shakatawa mai sunan "wbcoordinates". Dole ne kawai ku tura fayil ɗin JavaScript zuwa wannan wurin akan babban wikidata.org da zarar an gwada cikakken balaguron kuma an daidaita shi akan 'test.wikidata.org, kamar yadda aka bayyana a cikin sauran wannan jagorar.
Don taƙaitawa, ya kamata fayil ɗin ya kasance a wurare masu zuwa yayin da kuke aiki ta matakan yawon shakatawa:
Wurin sunan mai amfani
(Current step)
MediaWiki namespace test.wikidata.org
(Gwaji mataki)
MediaWiki namespace www.wikidata.org
(Buga mataki)
Tsari
A ɗauka cewa kuna ƙirƙirar yawon shakatawa mai suna "My Cool Tour", kuna buƙatar waɗannan abubuwa masu zuwa:
- Shafin wiki don haɗi zuwa ga rubutun yawon shakatawa, kamar Wikidata: Tours/My_Cool_Tour
- Fayil na JavaScript, wanda dole ne a sanya shi a MediaWiki:Guided-tour-wbMyCoolTour
- Wani sabon abu na Wikidata, kawai da wannan yawon shakatawa ke amfani dashi
Fayil ɗin JavaScript na "My Cool Tour" za a kammala tare da cikakkun bayanai da aka nuna a cikin samfurin misali a ƙasa. Da yake wannan yawon shakatawa ne kawai na almara, shafin Wiki da fayil ɗin JavaScript ba su wanzu, amma kuna iya duba fayilolin yawon shakatawa na Nassosi don misali na gaske:
- Suna: wbreferences
- Shafi na Wiki: Wikidata: Yawon shakatawa/References
- Fayil na JavaScript: MediaWiki:Guidedtour-tour-wbreferences.js
- Abu na Wikidata: Earth (Q85408509)
- URL yawon shakatawa kai tsaye: https://www.wikidata.org/w/index.php?title=Q85408509&tour=wbreferences
Fadada misalin da ke ƙasa don samfuri za ku iya kwafa da liƙa azaman wurin farawa.
/*
* @see [[Wikidata:Tours/My_cool_tour]]
*
* @author Your_Username_Goes_Here
*/
( function( $, mw, gt, wb ) {
$.ajax( {
async: false,
url: mw.util.wikiScript() + '?title=MediaWiki:Guidedtour-lib.js&action=raw&ctype=text/javascript',
dataType: 'script'
} );
/**
* Name of your tour, always starts with 'wb' by convention
*/
var tourName = 'wbmycooltour',
/**
* Wikidata item that will be loaded for the tour
*/
tourEntityId = 'Q123...',
/**
* Initial data to add to the tour item, such as labels, descriptions and statements in standard wikibase syntax
*/
newData = { };
gt.init( tourName, tourEntityId, newData, {
/**
* The Wiki page from where the tour texts should be loaded.
*/
pageName: 'Wikidata:Tours/My_cool_tour',
/**
* The steps of the tour.
*/
steps: [ {
// 1. Welcome to My Cool Tour
}, {
// 2. Some background info
}, {
// 3. Add a statement
attachTo: '.wikibase-statementgrouplistview > .wikibase-addtoolbar-container .wikibase-toolbar-button-add',
actionBtn2: '.wikibase-statementgrouplistview > .wikibase-addtoolbar-container .wikibase-toolbar-button-add a',
}, {
// 4. Select a property
position: 'top',
attachTo: '.wb-edit',
}, {
// 5. Input a value
position: 'top',
attachTo: '.wb-new .valueview-value'
}, {
// 6. Add a reference
position: 'top',
attachTo: '.wb-new .wikibase-statementview-references .wikibase-toolbar-button-add',
actionBtn2: '.wb-new .wikibase-statementview-references .wikibase-toolbar-button-add a'
}, {
// 7. Select reference property
position: 'top',
attachTo: '.wb-reference-new .ui-suggester-input'
}, {
// 8. Input reference value
position: 'top',
attachTo: '.wb-reference-new .valueview-value',
}, {
// 9. Publish
position: 'top',
attachTo: '.wb-new .wikibase-toolbar-button-save',
actionBtn2: '.wb-new .wikibase-toolbar-button-save a',
}, {
// 10. Congratulations!
// The function below should be included on the last slide
// It makes the final "OK" click redirect back to the tours home page
// Note: This is a temporary hack, it will not be needed in the near future
onShow: function() {
// Todo: should be the default action for clicking the "end tour" button on any Wikidata
$('.guidedtour-end-button').off('click').on('click', function() {
window.location = window.location.origin + '/wiki/Wikidata:tours';
})
}
} ]
} );
} )( jQuery, mediaWiki, mediaWiki.guidedTour, wikibase );
suna yawon shakatawa
Wannan shine sunan da ake amfani da shi don gano yawon shakatawa, ana amfani da shi a cikin URL lokacin ƙaddamar da yawon shakatawa. Dole ne sunan:
- Kasance na musamman, don haka babu yawon shakatawa guda biyu da zasu sami suna iri ɗaya.
- Yi amfani da ƙaramin rubutu na al'ada kawai, ba tare da sarari ba, sarƙoƙi ko wasu haruffa na musamman.
- Daidaita sunan a ƙarshen sunan fayil ɗin JavaScript (misali saita zuwa wbmycooltour a cikin fayil ɗin MediaWiki:Guidedtour-tour-wbmycooltour.js).
- Fara da "wb" daidai da al'ada don wasu yawon shakatawa (misali "wbqualifiers" ko "wbuniqueidentifiers").
- A kiyaye a takaice gwargwadon yiwuwa (misali "bayanin layi" ko "shafin yanar gizo na wbofficial").
tourEntityId
Shigar da lambar Q na abin yawon shakatawa da aka ƙirƙira a matakin baya. Wannan shine keɓaɓɓen abun Wikidata wanda za'a lodawa lokacin yawon shakatawa. Abun da kuka shigar anan ba zai yi amfani da shi ba har sai kun gudanar da zagaye na ƙarshe yayin matakin Buga, amma yana da kyau a rubuta shi a wannan matakin.
'Muhimmanci: Za a share abubuwan yawon shakatawa daga bayanan gaba ɗaya a duk lokacin da mai amfani ya ɗauki rangadin, don haka kada ku taɓa yin amfani da abin na al'ada' Wikidata don yawon shakatawa!
sabonData
newData wani abu ne na JavaScript wanda ya ƙunshi duk bayanan da kuke son ƙarawa zuwa abubuwan yawon shakatawa a farkon farawa, kamar tambari, kwatance da bayanai.
Kamar yadda aka share abin yawon buɗe ido a duk lokacin da mai amfani ya fara yawon shakatawa, barin bayanan farawa azaman abu mara komai {} na nufin yawon shakatawa yana farawa a matsayin abin da ba komai.
Amfani da bayanan abubuwan da ke akwai
Tsarin samar da bayanan farawa yayi daidai da daidaitaccen tsarin haɗin yanar gizo na Wikibase don siffanta abubuwa, ta yadda zaka iya fitarwa cikin sauƙi daga kowane abu da ke akwai. Manyan hanyoyin guda biyu sune:
- 'Amfani da Linked Data interface: Misali, zaku iya kwafi dukkan abubuwan da ke cikin http://www.wikidata.org/entity/Q42.json gaba daya ku liƙa a cikin fayil ɗin JavaScript ɗinku idan kuna son cikakkiya. kwafin Douglas Adams (Q42). Wannan yana da amfani gabaɗaya lokacin yin kwafi daga wani abu da bashi da yawa
- 'Amfani da Wikidata API wbgetentities mataki: Wannan yana ba ku damar sarrafa nau'ikan bayanan da kuke son dawowa, gami da tacewa ta harshe. Misali, wannan kiran API yana mayar da bayanai, tare da lakabi da kwatance a cikin Ingilishi da Faransanci - https://www.wikidata.org/w/api.php?action=wbgetentities&ids=Q42&languages=en%7Cfr&props=claims%7Clabels%7Cdescriptions
Hanya ta al'ada ita ce tace ƙasa zuwa kawai bayanan farawa waɗanda ake buƙata don gudanar da yawon shakatawa, da kuma saita yanayin gabaɗaya da sanya shi kamar gyara wani abu na gaske. Duk da haka, ana ba da shawarar sosai don riƙe lakabin a cikin duk harsunan da ake da su don taimakawa fassarar yawon shakatawa (ƙarin bayani a ƙasa).
Takamaimai da kwatance a cikin bayanan farawa ku
- Koyaushe ƙara lakabi zuwa bayanan farawa na abunku (sai dai idan yawon shakatawa ya kasance game da ƙara alamar). Alamar tana ba da mahimmancin mahallin don sababbin masu amfani.
- Ya kamata ku haɗa alamar a cikin duk yarukan da ake da su. Kamar yadda aka bayyana a sama, yawanci ana kwafi bayanan farawa daga wani sanannen abu na yanzu, don haka alamar za ta kasance a cikin babban adadin harsuna daban-daban. Ƙara wannan bayanan yanzu yana nufin cewa alamu za su iya kasancewa a yanzu yayin da ake fassara yawon shakatawa zuwa harsuna daban-daban. Duba Fassara shafi don ƙarin bayani.
- Ya kamata ku ƙara bayanin fom ɗin "Tabbatar Abun Gwaji don YAYIN KYAUTA yawon buɗe ido kawai" (maye gurbin SUNAN ZUWA da sunan yawon shakatawa). Kamar yadda abubuwan yawon shakatawa abubuwa ne na Wikidata na yau da kullun, za su iya nunawa a cikin akwatin nema. Ƙara wannan bayanin yana tabbatar da cewa kowa ya san cewa abu ba shine ainihin abin da ke cikin wannan batu ba - misali. abun yawon shakatawa Earth (Test item for References tours only) vs abin 'hakikanin' Earth (third planet from the Sun in the Solar System).
- Idan kun ƙara duka lakabi da kwatance a cikin sabon abu, dole ne ku tabbatar cewa haɗin alamar + bayanin ya keɓanta akan Wikidata. Idan ba haka ba, yawon shakatawa ba zai yi lodi ba! Wannan saboda za a yi watsi da gyaran farko don ƙara bayanan farawa. Ana iya samun wannan ta bin abin da ya gabata akan ƙara bayanin.
Tsarin mataki
Kowane mataki na yawon shakatawa yana da abin JavaScript don bayyana ayyukansa. Ana ƙara waɗannan zuwa tsararrun matakai a cikin zaɓuɓɓukan farawa, tare da abu ɗaya don kowane mataki na yawon shakatawa. Ga kowane mataki da ya kamata kawai ya yi iyo a tsakiyar shafin, kuma ba shi da wani aiki na musamman don kammalawa, kuna iya amfani da wani fanko kawai.
Ya kamata ku fara da ƙara abin da ba komai a kowane mataki, tare da sharhi sama da kowane don nuna taken matakin da kowane umarni na musamman (kwafi wannan daga shafin Wiki mai ma'ana). Wannan zai taimaka muku ci gaba da bin diddigin abubuwan da ake buƙata yayin da kuke aiki ta hanyar saitunan kowane mataki.
Zaɓuɓɓukan da ke akwai don kowane mataki sune:
Dukiya | Ƙimomin da aka yarda | Bayani |
---|---|---|
matsayi |
|
Yana ƙayyade matsayin popup dangane da abubuwan da kuke haɗawa da su.
Idan ba'a saita attachTo ba, to za'a yi watsi da wannan saitin.
|
haɗeTo |
|
Mai zaɓa don ɓangaren da pop up ya kamata ya haɗa zuwa.
Idan ka bar wannan babu komai, to buguwar zata yi iyo a tsakiyar shafin. |
aikiBtn2 |
|
Mai zaɓa don aikin dannawa wanda ke buƙatar kammala don matakin ci gaba. Shigar da ƙima don wannan yana da ayyuka masu mahimmanci guda biyu:
Wasu mahimman bayanai game da wannan kayan:
|