FANDOM


Globaali JavaScript-metodi importArticles() antaa normaalin käyttöliittymä skriptejä ja tyylejä käyttäville artikkeleille wikiassa.

Toiminnallisuus on samanlainen kuin jo olemassa olevilla metodeilla importScriptPage ja importStylesheetPage. Kuitenkin, importArticles() voi tuoda artikkeleista ulkopuolisista wikeistä, from external wikias, niputtaa useita artikkeleita yhdeksi, minimoimaan niitä ja palvelemaan yhtenä pyyntönä. Tämä pienentää tiedostokokoa ja verkkoliikennettä, saaden tehokkaasti suuren määrän lisätiedostoja latautuvan paljon nopeammin.

Käyttö

Metodi importArticles() luottaa moduuleiksi kutsuttuun määritelmään artikkelien lataamiseksi. Moduulit ovat olennaisesti JavaScript-olioita avain/arvo-ominaisuuksilla. Jokaiseen moduuliin vaaditaan seuraavat ominaisuudet:

  • tyyppi (type) - Tämä ominaisuus tarkoittaa artikkelien tyyppejä, joita tämä moduuli sisältää. Tuettuja ttylejä ovat:
  • artikkelit (articles) - Artikkelit, jotka haluat tuoda. Katso alapuolelta osiosta Artikkeleiden paikannus lisätietoa siitä, mitä lisätä.

Minkä tahansa määrän moduuleita voi välittää metodiin importArticles(). Mutta kaikkien moduulin artikkeleiden on oltava samaa tyyppiä.

Bulb

Välimuisti

Metodin importArticles() luomat linkit (ja alla kuvaillut edistyneet tekniikat) tallentuvat välimuistiin enintään 10 minuutiksi. Joten aina kun teet muutoksen, voit olettaa, että 10 minuutin jälkeen kaikki wikiaasi tulleet käyttäjät kokevat päivitetyt versiot JS- ja CSS-tiedostoista, jos importArticles() on käytössä.

Artikkeleiden paikannus

Yksinkertaista koodia käytetään paikantamaan artikkeleita, joita yrität tuoda. Se muistuttaa ja on hyvin samankaltainen kuin kielten väliset linkitykset:

(Etuliite:<WikiName>:)<Artikkeli>

Edellä oleviin sulkeisiin voi kirjoittaa mitä tahansa, ja mikä tahansa hakasulkeisiin kirjoitettu teksti merkitsee käyttäjäsyötettä. Kaksoispistettä käytetään erottamaan merkkijono eri segmentteihin jäsennystä varten. Etuliitteet kertovat miten haluat etsiä artikkelia ja yleensä niitä seuraa wikian nimi, elukuun ottamatta paikallisen wikian tapauksia.

Paikalliset artikkelit

Artikkelit paikallisessa wikiassa ovat paikannettavissa nimen mukaan samalla tavalla kuin linkittäisit ne normaalisti. Niihin ei vaadita etuliitettä tai wikian nimeä, vaikka, vasikka mukavuussyistä, on etuliite local (paikallinen) (tai lyhennettynä "l"). Esimerkiksi, jos haluat tuoda artikkelin Järjestelmäviesti:Common.js, mikä tahansa seuraavista käy:

Järjestelmäviesti:Common.js
l:Järjestelmäviesti:Common.js
local:Järjestelmäviesti:Common.js

Ulkoiset artikkelit

Ulkoisten wikioiden artikkeleita voi paikantaa samalla tavalla kuin linkittäisit niitä normaalisti. Kuitenkin, paikallisissa artikkeleissa, ulkoiset artikkelit vaativat etuliitteen käyttöä ja wikian nimen määrittämään, että mistä wikiasta ne tuodaan ja miten tunnistaa kyseinen wikia. Wikia tukee wikioiden etsimällä heidän tietokantansa nimeä, mikä on tyypillisesti wikian englanninkielinen nimi, ja URL-osoitetta. Tietokantahakuja suoritetaan ulkoiselle etuliitteelle (kuten "remote" tai "w") ha URL-haut suoritetaan url-etuliitteellä (tai lyhyesti "u"). Esimerkiksi, jos haluat tuoda artikkelin {{#NewWindowLink:http://dev.wikia.com/index.php?title=Highlight/code.css%7CHighlight/code.css}} {{#NewWindowLink:http://dev.wikia.com%7CDev Wikistä}}, mikä tahansa sueraavista käy:

w:dev:Highlight/code.css
remote:dev:Highlight/code.css
external:dev:Highlight/code.css
u:dev:Highlight/code.css
url:dev:Highlight/code.css
u:dev.wikia.com:Highlight/code.css
url:dev.wikia.com:Highlight/code.css

Tämä koodi toimii minkä tahansa kielisissä wikeissä. Esimerkiksi, jos haluat tuoda artikkelin {{#NewWindowLink:http://it.onepiece.wikia.com/index.php?title=MediaWiki:Common.js%7CJärjestelmäviesti:Common.js}} {{#NewWindowLink:http://it.onepiece.wikia.com%7COne Piece Wikin}} italialaisesta versiosta:

u:it.onepiece:MediaWiki:Common.js
url:it.onepiece:MediaWiki:Common.js
url:it.onepiece.wikia.com:MediaWiki:Common.js

Yleensä on helpompaa paikallistaa resursseja ulkoisista wikioista URL-osoitteen kuin tietokannan nimen avulla, kaksi ne kaksi eivät aina täsmää.

Edistynyt käyttö

Kulissien takana, metodi importArticles() toteuttaa kolme tarpeellista tehtävää:

  1. Oikein muotoillun URL-osoitteen tuottaminen ResourceLoaderin kautta,
  2. Suorittamalla järkitarkastuksia mooduleihin varmistaakseen, että ne ovat muotoiltu oikein
  3. Käyttäjäpalautteen tarjoaminen virheen tapauksessa.

metodin käyttöä ei kuitenkaan ole tiukasti vaadittua useiden artikkelien yhdistämisessä ja minimointia yhdellä pyynnöllä. Jos haluat, voit tuottaa URL-osoitteen manuaalisesti ja ladata varat toisilla keinoilla, kuten CSS:n @import-lauseella tai jQuery.getScript -skriptin kautta JavaScriptillä.

Kun URL-osoitteeseen sisällytettäviä parametrejä on monta, seuraavat ovat hyödyllisimpiä:

Parametri Parametrin kuvaus
mode Kertoo ResourceLoaderille, että lataamme artikkeleita. Pitäisi asettaa arvolle "articles".
articles Luettelo artikkeleista. Jos useita artikkeleita tarjotaan, neon erotettava pystyviivalla "|".
only Tuotavien artikkeleiden tyyppi. Arvon pitäisi olla joko "scripts" tai "styles."
debug Tämä parametri ei oletuksellisesti ole tarpeellinen, mutta sen arvoksi voi asettaa "true" minimoinnin estämiseksi, jotta virheenkorjaus on helpompaa tuotujen artikkelien sisällä.

Lopuksi, URL-osoitteen loppuun pitäisi lisätä jotain tällaista:

/load.php?mode=articles&articles=One.css|Two.css&only=styles

Jota voi käyttää in yhdistettynä @import-lauseeseen, kuten:

@import url("/load.php?mode=articles&articles=One.css|Two.css&only=styles");

Esimerkkejä

Tuodessasi useita skriptiartikkeleita, yhden paikallisesta wikistä ja ulkoisesta wikistä:

importArticles({
    type: "script",
    articles: [
        "MediaWiki:MyCustomJavaScript.js",
        "external:dev:MediaWiki:External_include.js"
    ]
});

Tuodessasi useita skriptiartikkeleita, yhden paikallisesta wikistä ja ulkoisesta wikistä:

importArticles({
    type: "style",
    articles: [
        "MediaWiki:Common.css",
        "external:starwars:MediaWiki:External_include.css"
    ]
});

Tuodessasi useita metodeita yhden metodikutsun kautta:

importArticles({
    type: "script",
    articles: [
        "MediaWiki:MyCustomJavaScript.js",
        "external:dev:MediaWiki:External_include.js"
    ]
}, {
    type: "style",
    article: "MediaWiki:Common.css"
});

Vaihtoehtoiset koodiesimerkit

Metodi importArticles() tukee myös yksinkertaistettuja, vaihtoehtoisia koodeja yleisiin käyttötarkoituksiin. Mukavuuden vuoksi on määritelty myös metodi importArticle().

Yhden ainoan tiedoston sisällyttäminen paikallisesta wikiasta moduulin määritystä käyttäen:

importArticle({
    type: "style",
    article: "MediaWiki:Common.css"
});

Katso myös

Lisäohjeet ja palaute

Community content is available under CC-BY-SA unless otherwise noted.