Divec has uploaded a new change for review. https://gerrit.wikimedia.org/r/82557
Change subject: Minor documentation improvements ...................................................................... Minor documentation improvements CODING.md * Document the procedure for adding a new javascript class modules/ve-mw/dm/annotations/ve.dm.MWExternalLinkAnnotation.js modules/ve-mw/dm/annotations/ve.dm.MWInternalLinkAnnotation.js modules/ve/dm/lineardata/ve.dm.ElementLinearData.js modules/ve/dm/ve.dm.LinearData.js * Add whitespace line before preformatted examples Change-Id: I54443ea3d4799328655d279f379d4ddc176c50a0 --- M CODING.md M modules/ve-mw/dm/annotations/ve.dm.MWExternalLinkAnnotation.js M modules/ve-mw/dm/annotations/ve.dm.MWInternalLinkAnnotation.js M modules/ve/dm/lineardata/ve.dm.ElementLinearData.js M modules/ve/dm/ve.dm.LinearData.js 5 files changed, 25 insertions(+), 0 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/VisualEditor refs/changes/57/82557/1 diff --git a/CODING.md b/CODING.md index 5ed791c..6646d4b 100644 --- a/CODING.md +++ b/CODING.md @@ -89,3 +89,19 @@ jQuery classes: * jQuery * jQuery.Event + +## Adding a new javascript class + +When a new javascript class is added, the file must be referenced in a number of places before +it can be used. + +If it is a test file: +* VisualEditor.hooks.php onResourceLoaderTestModules (if it is a test module) + +If it is not a test file: +* .docs/categories.json in General->Utilities (or somewhere more specific) +* VisualEditor.php, in ext.visualEditor.core (or somewhere more specific) +* Run `php maintenance/makeStaticLoader.php --target demo --write-file demos/ve/index.php` +* Run `php maintenance/makeStaticLoader.php --target test --write-file modules/ve/test/index.php` + +makeStaticLoader.php is a utility to automatically add script tags in dependency order. diff --git a/modules/ve-mw/dm/annotations/ve.dm.MWExternalLinkAnnotation.js b/modules/ve-mw/dm/annotations/ve.dm.MWExternalLinkAnnotation.js index 2bcd7cc..9defe3c 100644 --- a/modules/ve-mw/dm/annotations/ve.dm.MWExternalLinkAnnotation.js +++ b/modules/ve-mw/dm/annotations/ve.dm.MWExternalLinkAnnotation.js @@ -9,6 +9,7 @@ * DataModel MediaWiki external link annotation. * * Example HTML sources: + * * <a rel="mw:ExtLink"> * <a rel="mw:ExtLink/Numbered"> * diff --git a/modules/ve-mw/dm/annotations/ve.dm.MWInternalLinkAnnotation.js b/modules/ve-mw/dm/annotations/ve.dm.MWInternalLinkAnnotation.js index 54eb8df..f1c3ab7 100644 --- a/modules/ve-mw/dm/annotations/ve.dm.MWInternalLinkAnnotation.js +++ b/modules/ve-mw/dm/annotations/ve.dm.MWInternalLinkAnnotation.js @@ -11,6 +11,7 @@ * DataModel MediaWiki internal link annotation. * * Example HTML sources: + * * <a rel="mw:WikiLink"> * * @class diff --git a/modules/ve/dm/lineardata/ve.dm.ElementLinearData.js b/modules/ve/dm/lineardata/ve.dm.ElementLinearData.js index 91ff5fb..1944af3 100644 --- a/modules/ve/dm/lineardata/ve.dm.ElementLinearData.js +++ b/modules/ve/dm/lineardata/ve.dm.ElementLinearData.js @@ -72,10 +72,12 @@ * This method assumes that any value that has a type property that's a string is an element object. * * Content offsets: + * * <heading> a </heading> <paragraph> b c <img> </img> </paragraph> * . ^ ^ . ^ ^ ^ . ^ . * * Content offsets: + * * <list> <listItem> </listItem> <list> * . . . . . * @@ -145,18 +147,22 @@ * This method assumes that any value that has a type property that's a string is an element object. * * Structural offsets (unrestricted = false): + * * <heading> a </heading> <paragraph> b c <img> </img> </paragraph> * ^ . . ^ . . . . . ^ * * Structural offsets (unrestricted = true): + * * <heading> a </heading> <paragraph> b c <img> </img> </paragraph> * ^ . . ^ . . . . . ^ * * Structural offsets (unrestricted = false): + * * <list> <listItem> </listItem> <list> * ^ ^ ^ ^ ^ * * Content branch offsets (unrestricted = true): + * * <list> <listItem> </listItem> <list> * ^ . ^ . ^ * diff --git a/modules/ve/dm/ve.dm.LinearData.js b/modules/ve/dm/ve.dm.LinearData.js index 1f887f8..462b496 100644 --- a/modules/ve/dm/ve.dm.LinearData.js +++ b/modules/ve/dm/ve.dm.LinearData.js @@ -43,6 +43,7 @@ * This method assumes that any value that has a type property that's a string is an element object. * * Element data: + * * <heading> a </heading> <paragraph> b c <img></img> </paragraph> * ^ . ^ ^ . . ^ ^ ^ . * -- To view, visit https://gerrit.wikimedia.org/r/82557 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I54443ea3d4799328655d279f379d4ddc176c50a0 Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/extensions/VisualEditor Gerrit-Branch: master Gerrit-Owner: Divec <[email protected]> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
