From cafc1e08eb2e15cca2b821524db400eb1e9e9c5c Mon Sep 17 00:00:00 2001 From: Zack Lovatt Date: Thu, 21 Jun 2018 12:17:00 -0700 Subject: [PATCH] Updates all links and anchors in jsobjref to allow for proper ref targeting --- docs/introduction/changelog.rst | 2 +- docs/jsobjref/application.rst | 296 +++++++-------- docs/jsobjref/artboard.rst | 22 +- docs/jsobjref/artboards.rst | 18 +- docs/jsobjref/brush.rst | 8 +- docs/jsobjref/brushes.rst | 10 +- docs/jsobjref/characterAttributes.rst | 104 +++--- docs/jsobjref/characterStyle.rst | 12 +- docs/jsobjref/characterStyles.rst | 14 +- docs/jsobjref/characters.rst | 14 +- docs/jsobjref/color/cmykcolor.rst | 22 +- docs/jsobjref/color/index.rst | 19 +- docs/jsobjref/compoundPathItem.rst | 83 ++--- docs/jsobjref/compoundPathItems.rst | 18 +- docs/jsobjref/dataset.rst | 18 +- docs/jsobjref/datasets.rst | 20 +- docs/jsobjref/document.rst | 485 ++++++++++++------------- docs/jsobjref/documentPreset.rst | 60 ++- docs/jsobjref/documents.rst | 40 +- docs/jsobjref/epsSaveOptions.rst | 68 ++-- docs/jsobjref/exportOptionsAutoCAD.rst | 77 ++-- 21 files changed, 697 insertions(+), 713 deletions(-) diff --git a/docs/introduction/changelog.rst b/docs/introduction/changelog.rst index 608e2f8..79409e8 100644 --- a/docs/introduction/changelog.rst +++ b/docs/introduction/changelog.rst @@ -13,7 +13,7 @@ What's new and changed for scripting? `Illustrator XX.X (CC 2017) <>`_ ******************************************************************************** -- Added: :ref:`getIsFileOpen ` +- Added: :ref:`jsobjref/Application.getIsFileOpen` ---- diff --git a/docs/jsobjref/application.rst b/docs/jsobjref/application.rst index bac1327..f20556f 100644 --- a/docs/jsobjref/application.rst +++ b/docs/jsobjref/application.rst @@ -16,9 +16,9 @@ global app object, which contains all other Illustrator objects. Properties ========== -.. _app.activeDocument: +.. _jsobjref/application.activeDocument: -app.activeDocument +application.activeDocument ******************************************************************************** ``app.activeDocument`` @@ -29,13 +29,13 @@ The active (frontmost) document in Illustrator. **Type** -`Document <#document>`__ +:ref:`jsobjref/document` ---- -.. _app.browserAvailable: +.. _jsobjref/application.browserAvailable: -app.browserAvailable +application.browserAvailable ******************************************************************************** ``app.browserAvailable`` @@ -50,9 +50,9 @@ Boolean; read-only. ---- -.. _app.buildNumber: +.. _jsobjref/application.buildNumber: -app.buildNumber +application.buildNumber ******************************************************************************** ``app.buildNumber`` @@ -67,9 +67,9 @@ String; read-only. ---- -.. _app.colorSettingsList: +.. _jsobjref/application.colorSettingsList: -app.colorSettingsList +application.colorSettingsList ******************************************************************************** ``app.colorSettingsList`` @@ -85,9 +85,9 @@ Object; read-only. ---- -.. _app.coordinateSystem: +.. _jsobjref/application.coordinateSystem: -app.coordinateSystem +application.coordinateSystem ******************************************************************************** ``app.coordinateSystem`` @@ -99,13 +99,13 @@ document or artboard. **Type** -`CoordinateSystem <#coordinatesystem>`__ +:ref:`jsobjref/coordinateSystem` ---- -.. _app.defaultColorSettings: +.. _jsobjref/application.defaultColorSettings: -app.defaultColorSettings +application.defaultColorSettings ******************************************************************************** ``app.defaultColorSettings`` @@ -121,9 +121,9 @@ File; read-only. ---- -.. _app.documents: +.. _jsobjref/application.documents: -app.documents +application.documents ******************************************************************************** ``app.documents`` @@ -134,13 +134,13 @@ The documents in the application. **Type** -`Documents <#documents>`__ +:ref:`jsobjref/documents` ---- -.. _app.flattenerPresetList: +.. _jsobjref/application.flattenerPresetList: -app.flattenerPresetList +application.flattenerPresetList ******************************************************************************** ``app.flattenerPresetList`` @@ -156,9 +156,9 @@ Object; read-only. ---- -.. _app.freeMemory: +.. _jsobjref/application.freeMemory: -app.freeMemory +application.freeMemory ******************************************************************************** ``app.freeMemory`` @@ -174,9 +174,9 @@ Number (long); read-only. ---- -.. _app.locale: +.. _jsobjref/application.locale: -app.locale +application.locale ******************************************************************************** ``app.locale`` @@ -191,9 +191,9 @@ String; read-only. ---- -.. _app.name: +.. _jsobjref/application.name: -app.name +application.name ******************************************************************************** ``app.name`` @@ -209,9 +209,9 @@ String; read-only. ---- -.. _app.pasteRememberLayers: +.. _jsobjref/application.pasteRememberLayers: -app.pasteRememberLayers +application.pasteRememberLayers ******************************************************************************** ``app.pasteRememberLayers`` @@ -226,9 +226,9 @@ Boolean; read-only. ---- -.. _app.path: +.. _jsobjref/application.path: -app.path +application.path ******************************************************************************** ``app.path`` @@ -243,9 +243,9 @@ File; read-only. ---- -.. _app.PDFPresetsList: +.. _jsobjref/application.PDFPresetsList: -app.PDFPresetsList +application.PDFPresetsList ******************************************************************************** ``app.PDFPresetsList`` @@ -261,9 +261,9 @@ Object; read-only. ---- -.. _app.PPDFileList: +.. _jsobjref/application.PPDFileList: -app.PPDFileList +application.PPDFileList ******************************************************************************** ``app.PPDFileList`` @@ -279,9 +279,9 @@ Object; read-only. ---- -.. _app.preferences: +.. _jsobjref/application.preferences: -app.preferences +application.preferences ******************************************************************************** ``app.preferences`` @@ -292,13 +292,13 @@ Illustrator’s preference settings. **Type** -`Preferences <#preferences>`__ +:ref:`jsobjref/preferences` ---- -.. _app.printerList: +.. _jsobjref/application.printerList: -app.printerList +application.printerList ******************************************************************************** ``app.printerList`` @@ -309,13 +309,13 @@ The list of installed printers. **Type** -Array of `Printer <#printer>`__ +Array of :ref:`jsobjref/printer` ---- -.. _app.printPresetsList: +.. _jsobjref/application.printPresetsList: -app.printPresetsList +application.printPresetsList ******************************************************************************** ``app.printPresetsList`` @@ -330,9 +330,9 @@ Object; read-only. ---- -.. _app.scriptingVersion: +.. _jsobjref/application.scriptingVersion: -app.scriptingVersion +application.scriptingVersion ******************************************************************************** ``app.scriptingVersion`` @@ -347,9 +347,9 @@ String; read-only. ---- -.. _app.selection: +.. _jsobjref/application.selection: -app.selection +application.selection ******************************************************************************** ``app.selection`` @@ -364,9 +364,9 @@ Array of Objects; read-only. ---- -.. _app.startupPresetsList: +.. _jsobjref/application.startupPresetsList: -app.startupPresetsList +application.startupPresetsList ******************************************************************************** ``app.startupPresetsList`` @@ -381,9 +381,9 @@ Object; read-only. ---- -.. _app.textFonts: +.. _jsobjref/application.textFonts: -app.textFonts +application.textFonts ******************************************************************************** ``app.textFonts`` @@ -394,13 +394,13 @@ The installed fonts. **Type** -`TextFonts <#textfonts>`__ +:ref:`jsobjref/textFonts` ---- -.. _app.tracingPresetList: +.. _jsobjref/application.tracingPresetList: -app.tracingPresetList +application.tracingPresetList ******************************************************************************** ``app.tracingPresetList`` @@ -416,9 +416,9 @@ Array of Strings; read-only. ---- -.. _app.typename: +.. _jsobjref/application.typename: -app.typename +application.typename ******************************************************************************** ``app.typename`` @@ -433,9 +433,9 @@ String; read-only. ---- -.. _app.userInteractionLevel: +.. _jsobjref/application.userInteractionLevel: -app.userInteractionLevel +application.userInteractionLevel ******************************************************************************** ``app.userInteractionLevel`` @@ -447,13 +447,13 @@ script commands. **Type** -`UserInteractionLevel <#userinteractionlevel>`__ +:ref:`jsobjref/userInteractionLevel` ---- -.. _app.version: +.. _jsobjref/application.version: -app.version +application.version ******************************************************************************** ``app.version`` @@ -468,9 +468,9 @@ String; read-only. ---- -.. _app.visible: +.. _jsobjref/application.visible: -app.visible +application.visible ******************************************************************************** ``app.visible`` @@ -489,9 +489,9 @@ Boolean; read-only. Methods ======= -.. _app.beep: +.. _jsobjref/application.beep: -app.beep() +application.beep() ******************************************************************************** ``app.beep()`` @@ -506,9 +506,9 @@ Nothing. ---- -.. _app.concatenateMatrix: +.. _jsobjref/application.concatenateMatrix: -app.concatenateMatrix() +application.concatenateMatrix() ******************************************************************************** ``app.concatenateMatrix(matrix, secondMatrix)`` @@ -530,9 +530,9 @@ Matrix ---- -.. _app.concatenateRotationMatrix: +.. _jsobjref/application.concatenateRotationMatrix: -app.concatenateRotationMatrix() +application.concatenateRotationMatrix() ******************************************************************************** ``app.concatenateRotationMatrix(matrix, angle)`` @@ -554,9 +554,9 @@ Matrix ---- -.. _app.concatenateScaleMatrix: +.. _jsobjref/application.concatenateScaleMatrix: -app.concatenateScaleMatrix() +application.concatenateScaleMatrix() ******************************************************************************** ``app.concatenateScaleMatrix(matrix[, scaleX][, scaleY])`` @@ -579,9 +579,9 @@ Matrix ---- -.. _app.concatenateTranslationMatrix: +.. _jsobjref/application.concatenateTranslationMatrix: -app.concatenateTranslationMatrix() +application.concatenateTranslationMatrix() ******************************************************************************** ``app.concatenateTranslationMatrix(matrix[, deltaX][, deltaY])`` @@ -604,9 +604,9 @@ Matrix ---- -.. _app.convertSampleColor: +.. _jsobjref/application.convertSampleColor: -app.convertSampleColor() +application.convertSampleColor() ******************************************************************************** ``app.convertSampleColor(sourceColorSpace, sourceColor, destColorSpace, colorConvertPurpose[, sourceHasAlpha][, destHasAlpha])`` @@ -617,14 +617,14 @@ Converts a sample-component color from one color space to another. **Parameters** -======================= ============================================== ==== -``sourceColorSpace`` `ImageColorSpace <#imagecolorspace>`__ todo -``sourceColor`` ColorComponents todo -``destColorSpace`` `ImageColorSpace <#imagecolorspace>`__ todo -``colorConvertPurpose`` `ColorConvertPurpose <#colorconvertpurpose>`__ todo -``[sourceHasAlpha]`` Boolean, optional todo -``[destHasAlpha]`` Boolean, optional todo -======================= ============================================== ==== +======================= =================================== ==== +``sourceColorSpace`` :ref:`jsobjref/imageColorSpace` todo +``sourceColor`` ColorComponents todo +``destColorSpace`` :ref:`jsobjref/imageColorSpace` todo +``colorConvertPurpose`` :ref:`jsobjref/colorConvertPurpose` todo +``[sourceHasAlpha]`` Boolean, optional todo +``[destHasAlpha]`` Boolean, optional todo +======================= =================================== ==== **Returns** @@ -632,9 +632,9 @@ Array of ColorComponents ---- -.. _app.copy: +.. _jsobjref/application.copy: -app.copy() +application.copy() ******************************************************************************** ``app.copy()`` @@ -649,9 +649,9 @@ Nothing. ---- -.. _app.cut: +.. _jsobjref/application.cut: -app.cut() +application.cut() ******************************************************************************** ``app.cut()`` @@ -667,9 +667,9 @@ Nothing. ---- -.. _app.deleteWorkspace: +.. _jsobjref/application.deleteWorkspace: -app.deleteWorkspace() +application.deleteWorkspace() ******************************************************************************** ``app.deleteWorkspace(workspaceName)`` @@ -690,9 +690,9 @@ Boolean ---- -.. _app.getIdentityMatrix: +.. _jsobjref/application.getIdentityMatrix: -app.getIdentityMatrix() +application.getIdentityMatrix() ******************************************************************************** ``app.getIdentityMatrix()`` @@ -707,9 +707,9 @@ Matrix ---- -.. _app.getIsFileOpen: +.. _jsobjref/application.getIsFileOpen: -app.getIsFileOpen() +application.getIsFileOpen() ******************************************************************************** ``app.getIsFileOpen(filePath)`` @@ -733,9 +733,9 @@ Boolean ---- -.. _app.getPPDFileInfo: +.. _jsobjref/application.getPPDFileInfo: -app.getPPDFileInfo() +application.getPPDFileInfo() ******************************************************************************** ``app.getPPDFileInfo(name)`` @@ -752,13 +752,13 @@ Gets detailed file information for specified PPD file. **Returns** -`PPDFileInfo <#ppdfileinfo>`__ +:ref:`jsobjref/pPDFileInfo` ---- -.. _app.getPresetFileOfType: +.. _jsobjref/application.getPresetFileOfType: -app.getPresetFileOfType() +application.getPresetFileOfType() ******************************************************************************** ``app.getPresetFileOfType(presetType)`` @@ -770,9 +770,9 @@ specified preset type. **Parameters** -============== ============================================ ==== -``presetType`` `DocumentPresetType <#documentpresettype>`__ todo -============== ============================================ ==== +============== ================================== ==== +``presetType`` :ref:`jsobjref/documentPresetType` todo +============== ================================== ==== **Returns** @@ -780,9 +780,9 @@ File ---- -.. _app.getPresetSettings: +.. _jsobjref/application.getPresetSettings: -app.getPresetSettings() +application.getPresetSettings() ******************************************************************************** ``app.getPresetSettings(preset)`` @@ -800,13 +800,13 @@ a given preset name. **Returns** -`DocumentPreset <#documentpreset>`__ +:ref:`jsobjref/documentPreset` ---- -.. _app.getRotationMatrix: +.. _jsobjref/application.getRotationMatrix: -app.getRotationMatrix() +application.getRotationMatrix() ******************************************************************************** ``app.getRotationMatrix([angle])`` @@ -832,9 +832,9 @@ Matrix ---- -.. _app.getScaleMatrix: +.. _jsobjref/application.getScaleMatrix: -app.getScaleMatrix() +application.getScaleMatrix() ******************************************************************************** ``app.getScaleMatrix([scaleX][, scaleY])`` @@ -862,9 +862,9 @@ Matrix ---- -.. _app.getScriptableHelpGroup: +.. _jsobjref/application.getScriptableHelpGroup: -app.getScriptableHelpGroup() +application.getScriptableHelpGroup() ******************************************************************************** ``app.getScriptableHelpGroup()`` @@ -880,9 +880,9 @@ Variant ---- -.. _app.getTranslationMatrix: +.. _jsobjref/application.getTranslationMatrix: -app.getTranslationMatrix() +application.getTranslationMatrix() ******************************************************************************** ``app.getTranslationMatrix([deltaX][, deltaY])`` @@ -911,9 +911,9 @@ Matrix ---- -.. _app.invertMatrix: +.. _jsobjref/application.invertMatrix: -app.invertMatrix() +application.invertMatrix() ******************************************************************************** ``app.invertMatrix(matrix)`` @@ -934,9 +934,9 @@ Matrix ---- -.. _app.isEqualMatrix: +.. _jsobjref/application.isEqualMatrix: -app.isEqualMatrix() +application.isEqualMatrix() ******************************************************************************** ``app.isEqualMatrix(matrix, secondMatrix)`` @@ -958,9 +958,9 @@ Boolean ---- -.. _app.isSingularMatrix: +.. _jsobjref/application.isSingularMatrix: -app.isSingularMatrix() +application.isSingularMatrix() ******************************************************************************** ``app.isSingularMatrix(matrix)`` @@ -981,9 +981,9 @@ Boolean ---- -.. _app.loadColorSettings: +.. _jsobjref/application.loadColorSettings: -app.loadColorSettings() +application.loadColorSettings() ******************************************************************************** ``app.loadColorSettings(fileSpec)`` @@ -1005,9 +1005,9 @@ Nothing. ---- -.. _app.open: +.. _jsobjref/application.open: -app.open() +application.open() ******************************************************************************** ``app.open(file[, documentColorSpace][, options])`` @@ -1026,21 +1026,21 @@ Opens the specified document file. **Parameters** -======================== ============================================ ==== -``file`` File todo -``[documentColorSpace]`` `DocumentColorSpace <#documentcolorspace>`__ todo -``[options]`` anything todo -======================== ============================================ ==== +======================== ================================== ==== +``file`` File todo +``[documentColorSpace]`` :ref:`jsobjref/documentColorSpace` todo +``[options]`` anything todo +======================== ================================== ==== **Returns** -`Document <#document>`__ +:ref:`jsobjref/document` ---- -.. _app.paste: +.. _jsobjref/application.paste: -app.paste() +application.paste() ******************************************************************************** ``app.paste()`` @@ -1055,9 +1055,9 @@ Nothing. ---- -.. _app.quit: +.. _jsobjref/application.quit: -app.quit() +application.quit() ******************************************************************************** ``app.quit()`` @@ -1075,9 +1075,9 @@ Nothing. ---- -.. _app.redo: +.. _jsobjref/application.redo: -app.redo() +application.redo() ******************************************************************************** ``app.redo()`` @@ -1092,9 +1092,9 @@ Nothing. ---- -.. _app.redraw: +.. _jsobjref/application.redraw: -app.redraw() +application.redraw() ******************************************************************************** ``app.redraw()`` @@ -1109,9 +1109,9 @@ Nothing. ---- -.. _app.resetWorkspace: +.. _jsobjref/application.resetWorkspace: -app.resetWorkspace() +application.resetWorkspace() ******************************************************************************** ``app.resetWorkspace()`` @@ -1126,9 +1126,9 @@ Boolean ---- -.. _app.saveWorkspace: +.. _jsobjref/application.saveWorkspace: -app.saveWorkspace() +application.saveWorkspace() ******************************************************************************** ``app.saveWorkspace(workspaceName)`` @@ -1149,9 +1149,9 @@ Boolean ---- -.. _app.sendScriptMessage: +.. _jsobjref/application.sendScriptMessage: -app.sendScriptMessage() +application.sendScriptMessage() ******************************************************************************** ``app.sendScriptMessage(pluginName, messageSelector, inputString)`` @@ -1175,9 +1175,9 @@ String ---- -.. _app.showPresets: +.. _jsobjref/application.showPresets: -app.showPresets() +application.showPresets() ******************************************************************************** ``app.showPresets(fileSpec)`` @@ -1198,9 +1198,9 @@ PrintPresetList ---- -.. _app.switchWorkspace: +.. _jsobjref/application.switchWorkspace: -app.switchWorkspace() +application.switchWorkspace() ******************************************************************************** ``app.switchWorkspace(workspaceName)`` @@ -1221,9 +1221,9 @@ Boolean ---- -.. _app.translatePlaceholderText: +.. _jsobjref/application.translatePlaceholderText: -app.translatePlaceholderText() +application.translatePlaceholderText() ******************************************************************************** ``app.translatePlaceholderText(text)`` @@ -1245,9 +1245,9 @@ String ---- -.. _app.undo: +.. _jsobjref/application.undo: -app.undo() +application.undo() ******************************************************************************** ``app.undo()`` diff --git a/docs/jsobjref/artboard.rst b/docs/jsobjref/artboard.rst index aa9157e..cc742e0 100644 --- a/docs/jsobjref/artboard.rst +++ b/docs/jsobjref/artboard.rst @@ -14,7 +14,7 @@ in one document. Properties ========== -.. _artboard.artboardRect: +.. _jsobjref/artboard.artboardRect: artboard.artboardRect ******************************************************************************** @@ -31,7 +31,7 @@ Rect ---- -.. _artboard.name: +.. _jsobjref/artboard.name: artboard.name ******************************************************************************** @@ -48,7 +48,7 @@ String ---- -.. _artboard.parent: +.. _jsobjref/artboard.parent: artboard.parent ******************************************************************************** @@ -61,11 +61,11 @@ The parent of this object. **Type** -`Document <#document>`__; read-only. +:ref:`jsobjref/document`; read-only. ---- -.. _artboard.rulerOrigin: +.. _jsobjref/artboard.rulerOrigin: artboard.rulerOrigin ******************************************************************************** @@ -82,7 +82,7 @@ Point ---- -.. _artboard.rulerPAR: +.. _jsobjref/artboard.rulerPAR: artboard.rulerPAR ******************************************************************************** @@ -101,7 +101,7 @@ Number (double) ---- -.. _artboard.showCenter: +.. _jsobjref/artboard.showCenter: artboard.showCenter ******************************************************************************** @@ -118,7 +118,7 @@ Boolean ---- -.. _artboard.showCrossHairs: +.. _jsobjref/artboard.showCrossHairs: artboard.showCrossHairs ******************************************************************************** @@ -135,7 +135,7 @@ Boolean ---- -.. _artboard.showSafeAreas: +.. _jsobjref/artboard.showSafeAreas: artboard.showSafeAreas ******************************************************************************** @@ -152,7 +152,7 @@ Boolean ---- -.. _artboard.typename: +.. _jsobjref/artboard.typename: artboard.typename ******************************************************************************** @@ -173,7 +173,7 @@ String Methods ========== -.. _artboard.remove: +.. _jsobjref/artboard.remove: artboard.remove() ******************************************************************************** diff --git a/docs/jsobjref/artboards.rst b/docs/jsobjref/artboards.rst index a78792b..56ce6d3 100644 --- a/docs/jsobjref/artboards.rst +++ b/docs/jsobjref/artboards.rst @@ -13,7 +13,7 @@ A collection of Artboard objects. Properties ========== -.. _artboards.length: +.. _jsobjref/artboards.length: artboards.length ******************************************************************************** @@ -30,7 +30,7 @@ Number; read-only. ---- -.. _artboards.parent: +.. _jsobjref/artboards.parent: artboards.parent ******************************************************************************** @@ -48,7 +48,7 @@ The name of the object that contains this dataset ---- -.. _artboards.typename: +.. _jsobjref/artboards.typename: artboards.typename ******************************************************************************** @@ -69,7 +69,7 @@ String; read-only. Methods ======= -.. _artboards.add: +.. _jsobjref/artboards.add: artboards.add() ******************************************************************************** @@ -92,7 +92,7 @@ Creates a new Artboard object. ---- -.. _artboards.getActiveArtboardIndex: +.. _jsobjref/artboards.getActiveArtboardIndex: artboards.getActiveArtboardIndex() ******************************************************************************** @@ -111,7 +111,7 @@ Number (long) ---- -.. _artboards.getByName: +.. _jsobjref/artboards.getByName: artboards.getByName() ******************************************************************************** @@ -134,7 +134,7 @@ Gets the first element in the collection with the specified name. ---- -.. _artboards.insert: +.. _jsobjref/artboards.insert: artboards.insert() ******************************************************************************** @@ -158,7 +158,7 @@ Nothing. ---- -.. _artboards.remove: +.. _jsobjref/artboards.remove: artboards.remove() ******************************************************************************** @@ -181,7 +181,7 @@ Nothing. ---- -.. _artboards.setActiveArtboardIndex: +.. _jsobjref/artboards.setActiveArtboardIndex: artboards.setActiveArtboardIndex() ******************************************************************************** diff --git a/docs/jsobjref/brush.rst b/docs/jsobjref/brush.rst index 939f4f5..f08cc8f 100644 --- a/docs/jsobjref/brush.rst +++ b/docs/jsobjref/brush.rst @@ -16,7 +16,7 @@ created by the user within Illustrator. You can access brushes within a script, Properties ========== -.. _brush.name: +.. _jsobjref/brush.name: brush.name ******************************************************************************** @@ -33,7 +33,7 @@ String ---- -.. _brush.parent: +.. _jsobjref/brush.parent: brush.parent ******************************************************************************** @@ -50,7 +50,7 @@ The document that contains this brush. ---- -.. _brush.typename: +.. _jsobjref/brush.typename: brush.typename ******************************************************************************** @@ -71,7 +71,7 @@ String; read-only. Methods ======= -.. _brush.applyTo: +.. _jsobjref/brush.applyTo: brush.applyTo() ******************************************************************************** diff --git a/docs/jsobjref/brushes.rst b/docs/jsobjref/brushes.rst index 1a4a5b1..e9ed3e8 100644 --- a/docs/jsobjref/brushes.rst +++ b/docs/jsobjref/brushes.rst @@ -15,7 +15,7 @@ A collection of brush objects in a document. Properties ========== -.. _brushes.length: +.. _jsobjref/brushes.length: brushes.length ******************************************************************************** @@ -32,7 +32,7 @@ Number; read-only. ---- -.. _brushes.parent: +.. _jsobjref/brushes.parent: brushes.parent ******************************************************************************** @@ -49,7 +49,7 @@ Object; read-only. ---- -.. _brushes.typename: +.. _jsobjref/brushes.typename: brushes.typename ******************************************************************************** @@ -70,7 +70,7 @@ String; read-only. Methods ======= -.. _brushes.getByName: +.. _jsobjref/brushes.getByName: brushes.getByName() ******************************************************************************** @@ -93,7 +93,7 @@ Gets the first element in the collection with the specified name. ---- -.. _brushes.index: +.. _jsobjref/brushes.index: brushes.index() ******************************************************************************** diff --git a/docs/jsobjref/characterAttributes.rst b/docs/jsobjref/characterAttributes.rst index 8015d37..a2937aa 100644 --- a/docs/jsobjref/characterAttributes.rst +++ b/docs/jsobjref/characterAttributes.rst @@ -20,7 +20,7 @@ Specifies the properties of a character contained in a text frame. A ``Character Properties ========== -.. _characterAttributes.akiLeft: +.. _jsobjref/characterAttributes.akiLeft: characterAttributes.akiLeft ******************************************************************************** @@ -37,7 +37,7 @@ Number (double) ---- -.. _characterAttributes.akiRight: +.. _jsobjref/characterAttributes.akiRight: characterAttributes.akiRight ******************************************************************************** @@ -54,7 +54,7 @@ Number (double) ---- -.. _characterAttributes.alignment: +.. _jsobjref/characterAttributes.alignment: characterAttributes.alignment ******************************************************************************** @@ -71,7 +71,7 @@ The character alignment type. ---- -.. _characterAttributes.alternateGlyphs: +.. _jsobjref/characterAttributes.alternateGlyphs: characterAttributes.alternateGlyphs ******************************************************************************** @@ -88,7 +88,7 @@ The alternate glyphs form. ---- -.. _characterAttributes.autoLeading: +.. _jsobjref/characterAttributes.autoLeading: characterAttributes.autoLeading ******************************************************************************** @@ -105,7 +105,7 @@ Boolean ---- -.. _characterAttributes.baselineDirection: +.. _jsobjref/characterAttributes.baselineDirection: characterAttributes.baselineDirection ******************************************************************************** @@ -122,7 +122,7 @@ The Japanese text baseline direction. ---- -.. _characterAttributes.baselinePosition: +.. _jsobjref/characterAttributes.baselinePosition: characterAttributes.baselinePosition ******************************************************************************** @@ -139,7 +139,7 @@ The baseline position of text. ---- -.. _characterAttributes.baselineShift: +.. _jsobjref/characterAttributes.baselineShift: characterAttributes.baselineShift ******************************************************************************** @@ -156,7 +156,7 @@ Number (double) ---- -.. _characterAttributes.capitalization: +.. _jsobjref/characterAttributes.capitalization: characterAttributes.capitalization ******************************************************************************** @@ -173,7 +173,7 @@ The case of text. ---- -.. _characterAttributes.connectionForms: +.. _jsobjref/characterAttributes.connectionForms: characterAttributes.connectionForms ******************************************************************************** @@ -190,7 +190,7 @@ Boolean ---- -.. _characterAttributes.contextualLigature: +.. _jsobjref/characterAttributes.contextualLigature: characterAttributes.contextualLigature ******************************************************************************** @@ -207,7 +207,7 @@ Boolean ---- -.. _characterAttributes.discretionaryLigature: +.. _jsobjref/characterAttributes.discretionaryLigature: characterAttributes.discretionaryLigature ******************************************************************************** @@ -224,7 +224,7 @@ Boolean ---- -.. _characterAttributes.figureStyle: +.. _jsobjref/characterAttributes.figureStyle: characterAttributes.figureStyle ******************************************************************************** @@ -241,7 +241,7 @@ The number style in a OpenType font. ---- -.. _characterAttributes.fillColor: +.. _jsobjref/characterAttributes.fillColor: characterAttributes.fillColor ******************************************************************************** @@ -258,7 +258,7 @@ The color of the text fill. ---- -.. _characterAttributes.fractions: +.. _jsobjref/characterAttributes.fractions: characterAttributes.fractions ******************************************************************************** @@ -275,7 +275,7 @@ Boolean ---- -.. _characterAttributes.horizontalScale: +.. _jsobjref/characterAttributes.horizontalScale: characterAttributes.horizontalScale ******************************************************************************** @@ -292,7 +292,7 @@ Number (double) ---- -.. _characterAttributes.italics: +.. _jsobjref/characterAttributes.italics: characterAttributes.italics ******************************************************************************** @@ -309,7 +309,7 @@ Boolean ---- -.. _characterAttributes.kerningMethod: +.. _jsobjref/characterAttributes.kerningMethod: characterAttributes.kerningMethod ******************************************************************************** @@ -326,7 +326,7 @@ The automatic kerning method to use. ---- -.. _characterAttributes.language: +.. _jsobjref/characterAttributes.language: characterAttributes.language ******************************************************************************** @@ -343,7 +343,7 @@ The language of text. ---- -.. _characterAttributes.leading: +.. _jsobjref/characterAttributes.leading: characterAttributes.leading ******************************************************************************** @@ -360,7 +360,7 @@ Number (double) ---- -.. _characterAttributes.ligature: +.. _jsobjref/characterAttributes.ligature: characterAttributes.ligature ******************************************************************************** @@ -377,7 +377,7 @@ Boolean ---- -.. _characterAttributes.noBreak: +.. _jsobjref/characterAttributes.noBreak: characterAttributes.noBreak ******************************************************************************** @@ -394,7 +394,7 @@ Boolean ---- -.. _characterAttributes.openTypePosition: +.. _jsobjref/characterAttributes.openTypePosition: characterAttributes.openTypePosition ******************************************************************************** @@ -411,7 +411,7 @@ The OpenType baseline position. ---- -.. _characterAttributes.ordinals: +.. _jsobjref/characterAttributes.ordinals: characterAttributes.ordinals ******************************************************************************** @@ -428,7 +428,7 @@ Boolean ---- -.. _characterAttributes.ornaments: +.. _jsobjref/characterAttributes.ornaments: characterAttributes.ornaments ******************************************************************************** @@ -445,7 +445,7 @@ Boolean ---- -.. _characterAttributes.overprintFill: +.. _jsobjref/characterAttributes.overprintFill: characterAttributes.overprintFill ******************************************************************************** @@ -462,7 +462,7 @@ Boolean ---- -.. _characterAttributes.overprintStroke: +.. _jsobjref/characterAttributes.overprintStroke: characterAttributes.overprintStroke ******************************************************************************** @@ -479,7 +479,7 @@ Boolean ---- -.. _characterAttributes.parent: +.. _jsobjref/characterAttributes.parent: characterAttributes.parent ******************************************************************************** @@ -496,7 +496,7 @@ Object, read-only. ---- -.. _characterAttributes.proportionalMetrics: +.. _jsobjref/characterAttributes.proportionalMetrics: characterAttributes.proportionalMetrics ******************************************************************************** @@ -513,7 +513,7 @@ Boolean ---- -.. _characterAttributes.rotation: +.. _jsobjref/characterAttributes.rotation: characterAttributes.rotation ******************************************************************************** @@ -530,7 +530,7 @@ Number (double) ---- -.. _characterAttributes.size: +.. _jsobjref/characterAttributes.size: characterAttributes.size ******************************************************************************** @@ -547,7 +547,7 @@ Number (double) ---- -.. _characterAttributes.strikeThrough: +.. _jsobjref/characterAttributes.strikeThrough: characterAttributes.strikeThrough ******************************************************************************** @@ -564,7 +564,7 @@ Boolean ---- -.. _characterAttributes.strokeColor: +.. _jsobjref/characterAttributes.strokeColor: characterAttributes.strokeColor ******************************************************************************** @@ -581,7 +581,7 @@ The color of the text stroke. ---- -.. _characterAttributes.strokeWeight: +.. _jsobjref/characterAttributes.strokeWeight: characterAttributes.strokeWeight ******************************************************************************** @@ -598,7 +598,7 @@ Number (double) ---- -.. _characterAttributes.stylisticAlternates: +.. _jsobjref/characterAttributes.stylisticAlternates: characterAttributes.stylisticAlternates ******************************************************************************** @@ -615,7 +615,7 @@ Boolean ---- -.. _characterAttributes.swash: +.. _jsobjref/characterAttributes.swash: characterAttributes.swash ******************************************************************************** @@ -632,7 +632,7 @@ Boolean ---- -.. _characterAttributes.tateChuYokoHorizontal: +.. _jsobjref/characterAttributes.tateChuYokoHorizontal: characterAttributes.tateChuYokoHorizontal ******************************************************************************** @@ -649,7 +649,7 @@ Number (long) ---- -.. _characterAttributes.tateChuYokoVertical: +.. _jsobjref/characterAttributes.tateChuYokoVertical: characterAttributes.tateChuYokoVertical ******************************************************************************** @@ -666,7 +666,7 @@ Number (long) ---- -.. _characterAttributes.textFont: +.. _jsobjref/characterAttributes.textFont: characterAttributes.textFont ******************************************************************************** @@ -683,7 +683,7 @@ The text font. ---- -.. _characterAttributes.titling: +.. _jsobjref/characterAttributes.titling: characterAttributes.titling ******************************************************************************** @@ -700,7 +700,7 @@ Boolean ---- -.. _characterAttributes.tracking: +.. _jsobjref/characterAttributes.tracking: characterAttributes.tracking ******************************************************************************** @@ -717,7 +717,7 @@ Number (long) ---- -.. _characterAttributes.Tsume: +.. _jsobjref/characterAttributes.Tsume: characterAttributes.Tsume ******************************************************************************** @@ -734,7 +734,7 @@ Number (double) ---- -.. _characterAttributes.typename: +.. _jsobjref/characterAttributes.typename: characterAttributes.typename ******************************************************************************** @@ -751,7 +751,7 @@ String, read-only. ---- -.. _characterAttributes.underline: +.. _jsobjref/characterAttributes.underline: characterAttributes.underline ******************************************************************************** @@ -768,7 +768,7 @@ Boolean ---- -.. _characterAttributes.verticalScale: +.. _jsobjref/characterAttributes.verticalScale: characterAttributes.verticalScale ******************************************************************************** @@ -785,7 +785,7 @@ Number (double) ---- -.. _characterAttributes.wariChuCharactersAfterBreak: +.. _jsobjref/characterAttributes.wariChuCharactersAfterBreak: characterAttributes.wariChuCharactersAfterBreak ******************************************************************************** @@ -802,7 +802,7 @@ Number (long) ---- -.. _characterAttributes.wariChuCharactersBeforeBreak: +.. _jsobjref/characterAttributes.wariChuCharactersBeforeBreak: characterAttributes.wariChuCharactersBeforeBreak ******************************************************************************** @@ -819,7 +819,7 @@ Number (long) ---- -.. _characterAttributes.waiChuEnabled: +.. _jsobjref/characterAttributes.waiChuEnabled: characterAttributes.waiChuEnabled ******************************************************************************** @@ -836,7 +836,7 @@ Boolean ---- -.. _characterAttributes.wariChuJustification: +.. _jsobjref/characterAttributes.wariChuJustification: characterAttributes.wariChuJustification ******************************************************************************** @@ -853,7 +853,7 @@ The Wari-Chu justification. ---- -.. _characterAttributes.wariChuLineGap: +.. _jsobjref/characterAttributes.wariChuLineGap: characterAttributes.wariChuLineGap ******************************************************************************** @@ -870,7 +870,7 @@ Number (long) ---- -.. _characterAttributes.wariChuLines: +.. _jsobjref/characterAttributes.wariChuLines: characterAttributes.wariChuLines ******************************************************************************** @@ -887,7 +887,7 @@ Number (long) ---- -.. _characterAttributes.wariChuScale: +.. _jsobjref/characterAttributes.wariChuScale: characterAttributes.wariChuScale ******************************************************************************** diff --git a/docs/jsobjref/characterStyle.rst b/docs/jsobjref/characterStyle.rst index 62dfe32..2847125 100644 --- a/docs/jsobjref/characterStyle.rst +++ b/docs/jsobjref/characterStyle.rst @@ -15,7 +15,7 @@ Associates character attributes with characters. For an example, see :ref:`jsobj Properties ========== -.. _characterStyle.characterAttributes: +.. _jsobjref/characterStyle.characterAttributes: characterStyle.characterAttributes ******************************************************************************** @@ -32,7 +32,7 @@ The character properties for the style. ---- -.. _characterStyle.name: +.. _jsobjref/characterStyle.name: characterStyle.name ******************************************************************************** @@ -49,7 +49,7 @@ String ---- -.. _characterStyle.parent: +.. _jsobjref/characterStyle.parent: characterStyle.parent ******************************************************************************** @@ -66,7 +66,7 @@ Object, read-only. ---- -.. _characterStyle.typename: +.. _jsobjref/characterStyle.typename: characterStyle.typename ******************************************************************************** @@ -87,7 +87,7 @@ String, read-only. Methods ======= -.. _characterStyle.applyTo: +.. _jsobjref/characterStyle.applyTo: characterStyle.applyTo() ******************************************************************************** @@ -111,7 +111,7 @@ Nothing ----- -.. _characterStyle.remove: +.. _jsobjref/characterStyle.remove: characterStyle.remove() ******************************************************************************** diff --git a/docs/jsobjref/characterStyles.rst b/docs/jsobjref/characterStyles.rst index 3a374d3..39c9efc 100644 --- a/docs/jsobjref/characterStyles.rst +++ b/docs/jsobjref/characterStyles.rst @@ -15,7 +15,7 @@ A collection of CharacterStyle objects. Properties ========== -.. _characterStyles.length: +.. _jsobjref/characterStyles.length: characterStyles.length ******************************************************************************** @@ -32,7 +32,7 @@ Number; read-only. ---- -.. _characterStyles.parent: +.. _jsobjref/characterStyles.parent: characterStyles.parent ******************************************************************************** @@ -49,7 +49,7 @@ Object; read-only. ---- -.. _characterStyles.typename: +.. _jsobjref/characterStyles.typename: characterStyles.typename ******************************************************************************** @@ -70,7 +70,7 @@ String; read-only. Methods ======= -.. _characterStyles.add: +.. _jsobjref/characterStyles.add: characterStyles.add() ******************************************************************************** @@ -93,7 +93,7 @@ Creates a named character style. ---- -.. _characterStyles.getByName: +.. _jsobjref/characterStyles.getByName: characterStyles.getByName() ******************************************************************************** @@ -116,7 +116,7 @@ Gets the first element in the collection with the provided name. ---- -.. _characterStyles.index: +.. _jsobjref/characterStyles.index: characterStyles.index() ******************************************************************************** @@ -139,7 +139,7 @@ Gets an element from the collection. ---- -.. _characterStyles.removeAll: +.. _jsobjref/characterStyles.removeAll: characterStyles.removeAll() ******************************************************************************** diff --git a/docs/jsobjref/characters.rst b/docs/jsobjref/characters.rst index 9811777..c85f2a2 100644 --- a/docs/jsobjref/characters.rst +++ b/docs/jsobjref/characters.rst @@ -17,7 +17,7 @@ The elements are not named; you must access them by index. Properties ========== -.. _characters.length: +.. _jsobjref/characters.length: characters.length ******************************************************************************** @@ -34,7 +34,7 @@ Number; read-only. ---- -.. _characters.parent: +.. _jsobjref/characters.parent: characters.parent ******************************************************************************** @@ -51,7 +51,7 @@ Object; read-only. ---- -.. _characters.typename: +.. _jsobjref/characters.typename: characters.typename ******************************************************************************** @@ -72,7 +72,7 @@ String; read-only. Methods ======= -.. _characters.add: +.. _jsobjref/characters.add: characters.add() ******************************************************************************** @@ -99,7 +99,7 @@ If a location is not specified, adds the new character to the containing text fr ---- -.. _characters.addBefore: +.. _jsobjref/characters.addBefore: characters.addBefore() ******************************************************************************** @@ -122,7 +122,7 @@ Adds a character before the specified text selection. ---- -.. _characters.index: +.. _jsobjref/characters.index: characters.index() ******************************************************************************** @@ -145,7 +145,7 @@ Gets an element from the collection. ---- -.. _characters.removeAll: +.. _jsobjref/characters.removeAll: characters.removeAll() ******************************************************************************** diff --git a/docs/jsobjref/color/cmykcolor.rst b/docs/jsobjref/color/cmykcolor.rst index f1a26bf..ed055b4 100644 --- a/docs/jsobjref/color/cmykcolor.rst +++ b/docs/jsobjref/color/cmykcolor.rst @@ -21,7 +21,7 @@ actual color space. Properties ========== -.. _cmykColor.black: +.. _jsobjref/color/cmykColor.black: cmykColor.black ******************************************************************************** @@ -38,7 +38,7 @@ Number (double) ---- -.. _cmykColor.cyan: +.. _jsobjref/color/cmykColor.cyan: cmykColor.cyan ******************************************************************************** @@ -55,7 +55,7 @@ Number (double) ---- -.. _cmykColor.magenta: +.. _jsobjref/color/cmykColor.magenta: cmykColor.magenta ******************************************************************************** @@ -72,7 +72,7 @@ Number (double) ---- -.. _cmykColor.typename: +.. _jsobjref/color/cmykColor.typename: cmykColor.typename ******************************************************************************** @@ -89,7 +89,7 @@ String; read-only. ---- -.. _cmykColor.yellow: +.. _jsobjref/color/cmykColor.yellow: cmykColor.yellow ******************************************************************************** @@ -121,12 +121,12 @@ Setting a CMYK color if ( app.documents.length > 0 && app.activeDocument.pathItems.length > 0) { frontPath = app.activeDocument.pathItems[0]; // Set color values for the CMYK object - newCMYKColor = new CMYKColor(); - newCMYKColor.black = 0; - newCMYKColor.cyan = 30.4; - newCMYKColor.magenta = 32; - newCMYKColor.yellow = 0; + newcmykColor = new cmykColor(); + newcmykColor.black = 0; + newcmykColor.cyan = 30.4; + newcmykColor.magenta = 32; + newcmykColor.yellow = 0; // Use the color object in the path item frontPath.filled = true; - frontPath.fillColor = newCMYKColor; + frontPath.fillColor = newcmykColor; } diff --git a/docs/jsobjref/color/index.rst b/docs/jsobjref/color/index.rst index f16c0f4..f5239e7 100644 --- a/docs/jsobjref/color/index.rst +++ b/docs/jsobjref/color/index.rst @@ -10,14 +10,13 @@ Color An abstract parent class for all color classes used in Illustrator. Subclasses are: .. toctree:: - :maxdepth: 2 + :maxdepth: 2 - cmykcolor - cmykColor - gradientColor - grayColor - labColor - noColor - patternColor - rGBColor - spotColor + cmykColor + gradientColor + grayColor + labColor + noColor + patternColor + rGBColor + spotColor diff --git a/docs/jsobjref/compoundPathItem.rst b/docs/jsobjref/compoundPathItem.rst index f3a05c8..97f8a7b 100644 --- a/docs/jsobjref/compoundPathItem.rst +++ b/docs/jsobjref/compoundPathItem.rst @@ -20,7 +20,7 @@ All paths within a compound path share property values. Therefore, if you set th Properties ========== -.. _compoundPathItem.artworkKnockout: +.. _jsobjref/compoundPathItem.artworkKnockout: compoundPathItem.artworkKnockout ******************************************************************************** @@ -37,7 +37,7 @@ Is this object used to create a knockout, and if so, what kind of knockout. ---- -.. _compoundPathItem.blendingMode: +.. _jsobjref/compoundPathItem.blendingMode: compoundPathItem.blendingMode ******************************************************************************** @@ -54,7 +54,7 @@ The mode used when compositing an object. ---- -.. _compoundPathItem.controlBounds: +.. _jsobjref/compoundPathItem.controlBounds: compoundPathItem.controlBounds ******************************************************************************** @@ -71,7 +71,7 @@ Array of 4 numbers, read-only. ---- -.. _compoundPathItem.editable: +.. _jsobjref/compoundPathItem.editable: compoundPathItem.editable ******************************************************************************** @@ -88,7 +88,7 @@ Boolean, read-only. ---- -.. _compoundPathItem.geometricBounds: +.. _jsobjref/compoundPathItem.geometricBounds: compoundPathItem.geometricBounds ******************************************************************************** @@ -105,7 +105,7 @@ Array of 4 numbers, read-only. ---- -.. _compoundPathItem.height: +.. _jsobjref/compoundPathItem.height: compoundPathItem.height ******************************************************************************** @@ -122,7 +122,7 @@ Number (double). ---- -.. _compoundPathItem.hidden: +.. _jsobjref/compoundPathItem.hidden: compoundPathItem.hidden ******************************************************************************** @@ -139,7 +139,7 @@ Boolean. ---- -.. _compoundPathItem.isIsolated: +.. _jsobjref/compoundPathItem.isIsolated: compoundPathItem.isIsolated ******************************************************************************** @@ -156,7 +156,7 @@ Boolean. ---- -.. _compoundPathItem.layer: +.. _jsobjref/compoundPathItem.layer: compoundPathItem.layer ******************************************************************************** @@ -173,7 +173,7 @@ The layer to which this compound path item belongs. ---- -.. _compoundPathItem.left: +.. _jsobjref/compoundPathItem.left: compoundPathItem.left ******************************************************************************** @@ -190,7 +190,7 @@ Number (double). ---- -.. _compoundPathItem.locked: +.. _jsobjref/compoundPathItem.locked: compoundPathItem.locked ******************************************************************************** @@ -207,7 +207,7 @@ Boolean. ---- -.. _compoundPathItem.name: +.. _jsobjref/compoundPathItem.name: compoundPathItem.name ******************************************************************************** @@ -224,7 +224,7 @@ String. ---- -.. _compoundPathItem.note: +.. _jsobjref/compoundPathItem.note: compoundPathItem.note ******************************************************************************** @@ -241,7 +241,7 @@ String. ---- -.. _compoundPathItem.opacity: +.. _jsobjref/compoundPathItem.opacity: compoundPathItem.opacity ******************************************************************************** @@ -258,7 +258,7 @@ Number (double). ---- -.. _compoundPathItem.parent: +.. _jsobjref/compoundPathItem.parent: compoundPathItem.parent ******************************************************************************** @@ -272,9 +272,10 @@ The parent of this object. **Type** :ref:`jsobjref/layer` or :ref:`jsobjref/groupItem`, read-only. + ---- -.. _compoundPathItem.pathItems: +.. _jsobjref/compoundPathItem.pathItems: compoundPathItem.pathItems ******************************************************************************** @@ -291,7 +292,7 @@ The path art items in this compound path. ---- -.. _compoundPathItem.position: +.. _jsobjref/compoundPathItem.position: compoundPathItem.position ******************************************************************************** @@ -308,7 +309,7 @@ Array of 2 numbers. ---- -.. _compoundPathItem.selected: +.. _jsobjref/compoundPathItem.selected: compoundPathItem.selected ******************************************************************************** @@ -325,7 +326,7 @@ Boolean. ---- -.. _compoundPathItem.sliced: +.. _jsobjref/compoundPathItem.sliced: compoundPathItem.sliced ******************************************************************************** @@ -342,7 +343,7 @@ Boolean. ---- -.. _compoundPathItem.tags: +.. _jsobjref/compoundPathItem.tags: compoundPathItem.tags ******************************************************************************** @@ -359,7 +360,7 @@ The tags contained in this object. ---- -.. _compoundPathItem.top: +.. _jsobjref/compoundPathItem.top: compoundPathItem.top ******************************************************************************** @@ -376,7 +377,7 @@ Number (double). ---- -.. _compoundPathItem.typename: +.. _jsobjref/compoundPathItem.typename: compoundPathItem.typename ******************************************************************************** @@ -393,7 +394,7 @@ String, read-only. ---- -.. _compoundPathItem.uRL: +.. _jsobjref/compoundPathItem.uRL: compoundPathItem.uRL ******************************************************************************** @@ -410,7 +411,7 @@ String. ---- -.. _compoundPathItem.visibilityVariable: +.. _jsobjref/compoundPathItem.visibilityVariable: compoundPathItem.visibilityVariable ******************************************************************************** @@ -427,7 +428,7 @@ Variant. ---- -.. _compoundPathItem.visibleBounds: +.. _jsobjref/compoundPathItem.visibleBounds: compoundPathItem.visibleBounds ******************************************************************************** @@ -444,7 +445,7 @@ Array of 4 numbers, read-only. ---- -.. _compoundPathItem.width: +.. _jsobjref/compoundPathItem.width: compoundPathItem.width ******************************************************************************** @@ -461,7 +462,7 @@ Number (double). ---- -.. _compoundPathItem.wrapInside: +.. _jsobjref/compoundPathItem.wrapInside: compoundPathItem.wrapInside ******************************************************************************** @@ -478,7 +479,7 @@ Boolean. ---- -.. _compoundPathItem.wrapOffset: +.. _jsobjref/compoundPathItem.wrapOffset: compoundPathItem.wrapOffset ******************************************************************************** @@ -495,7 +496,7 @@ Number (double). ---- -.. _compoundPathItem.wrapped: +.. _jsobjref/compoundPathItem.wrapped: compoundPathItem.wrapped ******************************************************************************** @@ -512,7 +513,7 @@ Boolean. ---- -.. _compoundPathItem.zOrderPosition: +.. _jsobjref/compoundPathItem.zOrderPosition: compoundPathItem.zOrderPosition ******************************************************************************** @@ -533,7 +534,7 @@ Number (long), read-only. Methods ======= -.. _compoundPathItem.duplicate: +.. _jsobjref/compoundPathItem.duplicate: compoundPathItem.duplicate() ******************************************************************************** @@ -560,7 +561,7 @@ Creates a duplicate of the selected object. ---- -.. _compoundPathItem.move: +.. _jsobjref/compoundPathItem.move: compoundPathItem.move() ******************************************************************************** @@ -587,7 +588,7 @@ Nothing. ---- -.. _compoundPathItem.remove: +.. _jsobjref/compoundPathItem.remove: compoundPathItem.remove() ******************************************************************************** @@ -604,7 +605,7 @@ Nothing. ---- -.. _compoundPathItem.resize: +.. _jsobjref/compoundPathItem.resize: compoundPathItem.resize() ******************************************************************************** @@ -648,7 +649,7 @@ Nothing. ---- -.. _compoundPathItem.rotate: +.. _jsobjref/compoundPathItem.rotate: compoundPathItem.rotate() ******************************************************************************** @@ -688,7 +689,7 @@ Nothing. ---- -.. _compoundPathItem.transform: +.. _jsobjref/compoundPathItem.transform: compoundPathItem.transform() ******************************************************************************** @@ -730,7 +731,7 @@ Nothing. ---- -.. _compoundPathItem.translate: +.. _jsobjref/compoundPathItem.translate: compoundPathItem.translate() ******************************************************************************** @@ -771,7 +772,7 @@ Nothing. ---- -.. _compoundPathItem.zOrder: +.. _jsobjref/compoundPathItem.zOrder: compoundPathItem.zOrder() ******************************************************************************** @@ -814,7 +815,7 @@ Selecting paths in a document numPaths = thePaths.length; for ( i = 0; i < doc.pathItems.length; i++ ) { pathArt = doc.pathItems[i]; - if ( pathArt.parent.typename != "CompoundPathItem" ) { + if ( pathArt.parent.typename != "compoundPathItem" ) { pathArt.selected = true; count++; } @@ -833,11 +834,11 @@ Creating and modifying a compound path item if ( app.documents.length > 0 ) { doc = app.activeDocument; newCompoundPath = doc.activeLayer.compoundPathItems.add(); - + // Create the path items newPath = newCompoundPath.pathItems.add(); newPath.setEntirePath( Array( Array(30, 50), Array(30, 100) ) ); - + newPath = newCompoundPath.pathItems.add(); newPath.setEntirePath( Array( Array(40, 100), Array(100, 100) ) ); diff --git a/docs/jsobjref/compoundPathItems.rst b/docs/jsobjref/compoundPathItems.rst index 75bf839..2d83b45 100644 --- a/docs/jsobjref/compoundPathItems.rst +++ b/docs/jsobjref/compoundPathItems.rst @@ -7,7 +7,7 @@ Compound Path Items **Description** -A collection of ``CompoundPathItem`` objects. +A collection of :ref:`jsobjref/compoundPathItem` objects. ---- @@ -15,7 +15,7 @@ A collection of ``CompoundPathItem`` objects. Properties ========== -.. _compoundPathItems.length: +.. _jsobjref/compoundPathItems.length: compoundPathItems.length ******************************************************************************** @@ -32,7 +32,7 @@ Number, read-only. ---- -.. _compoundPathItems.parent: +.. _jsobjref/compoundPathItems.parent: compoundPathItems.parent ******************************************************************************** @@ -49,7 +49,7 @@ Object, read-only. ---- -.. _compoundPathItems.typename: +.. _jsobjref/compoundPathItems.typename: compoundPathItems.typename ******************************************************************************** @@ -70,7 +70,7 @@ String, read-only. Methods ======= -.. _compoundPathItems.add: +.. _jsobjref/compoundPathItems.add: compoundPathItems.add() ******************************************************************************** @@ -87,7 +87,7 @@ Creates a new ``CompoundPathItem``. ---- -.. _compoundPathItems.getByName: +.. _jsobjref/compoundPathItems.getByName: compoundPathItems.getByName() ******************************************************************************** @@ -112,7 +112,7 @@ Gets the first element in the collection with the specified name. ---- -.. _compoundPathItems.index: +.. _jsobjref/compoundPathItems.index: compoundPathItems.index() ******************************************************************************** @@ -137,7 +137,7 @@ Gets an element from the collection. ---- -.. _compoundPathItems.removeAll: +.. _jsobjref/compoundPathItems.removeAll: compoundPathItems.removeAll() ******************************************************************************** @@ -167,4 +167,4 @@ Counting compound paths if ( app.documents.length > 0 ) { var doc = app.activeDocument; var numCompoundPaths = doc.layers[0].compoundPathItems.length; - } \ No newline at end of file + } diff --git a/docs/jsobjref/dataset.rst b/docs/jsobjref/dataset.rst index 7583204..c335256 100644 --- a/docs/jsobjref/dataset.rst +++ b/docs/jsobjref/dataset.rst @@ -1,6 +1,6 @@ .. _jsobjref/dataset: -Dataset +dataset ################################################################################ ``dataset`` @@ -15,7 +15,7 @@ A set of data used for dynamic publishing. A dataset allows you to collect a num Properties ========== -.. _dataset.name: +.. _jsobjref/dataset.name: dataset.name ******************************************************************************** @@ -32,7 +32,7 @@ String. ---- -.. _dataset.parent: +.. _jsobjref/dataset.parent: dataset.parent ******************************************************************************** @@ -49,7 +49,7 @@ The name of the object that contains this dataset. ---- -.. _dataset.typename: +.. _jsobjref/dataset.typename: dataset.typename ******************************************************************************** @@ -70,7 +70,7 @@ String. Methods ======= -.. _dataset.display: +.. _jsobjref/dataset.display: dataset.display() ******************************************************************************** @@ -87,7 +87,7 @@ Nothing. ---- -.. _dataset.remove: +.. _jsobjref/dataset.remove: dataset.remove() ******************************************************************************** @@ -104,7 +104,7 @@ Nothing. ---- -.. _dataset.update: +.. _jsobjref/dataset.update: dataset.update() ******************************************************************************** @@ -133,7 +133,7 @@ Using variables and datasets // Creates two variables, 1 visibility and 1 text, // creates two datasets each with different values for the variables, // then displays both datasets - + var docRef = documents.add(); // Create visibility variable @@ -168,4 +168,4 @@ Using variables and datasets ds1.display(); redraw(); ds2.display(); - redraw(); \ No newline at end of file + redraw(); diff --git a/docs/jsobjref/datasets.rst b/docs/jsobjref/datasets.rst index 439d2b7..f8cc1dc 100644 --- a/docs/jsobjref/datasets.rst +++ b/docs/jsobjref/datasets.rst @@ -1,13 +1,13 @@ .. _jsobjref/datasets: -Datasets +datasets ################################################################################ ``dataSets`` **Description** -A collection of ``Dataset`` objects. +A collection of :ref:`jsobjref/dataset` objects. ---- @@ -15,7 +15,7 @@ A collection of ``Dataset`` objects. Properties ========== -.. _dataSets.length: +.. _jsobjref/datasets.length: dataSets.length ******************************************************************************** @@ -32,7 +32,7 @@ Number, read-only. ---- -.. _dataSets.parent: +.. _jsobjref/datasets.parent: dataSets.parent ******************************************************************************** @@ -49,7 +49,7 @@ The name of the object that contains this dataset. ---- -.. _dataSets.typename: +.. _jsobjref/datasets.typename: dataSets.typename ******************************************************************************** @@ -70,7 +70,7 @@ String, read-only. Methods ======= -.. _dataSets.add: +.. _jsobjref/datasets.add: dataSets.add() ******************************************************************************** @@ -87,7 +87,7 @@ Creates a new dataset object. ---- -.. _dataSets.getByName: +.. _jsobjref/datasets.getByName: dataSets.getByName() ******************************************************************************** @@ -112,7 +112,7 @@ Gets the first element in the collection with the specified name. ---- -.. _dataSets.index: +.. _jsobjref/datasets.index: dataSets.index() ******************************************************************************** @@ -137,7 +137,7 @@ Gets an element from the collection. ---- -.. _dataSets.removeAll: +.. _jsobjref/datasets.removeAll: dataSets.removeAll() ******************************************************************************** @@ -151,5 +151,3 @@ Removes all elements in the collection. **Returns** Nothing. - ----- \ No newline at end of file diff --git a/docs/jsobjref/document.rst b/docs/jsobjref/document.rst index 8d3644c..760e2ff 100644 --- a/docs/jsobjref/document.rst +++ b/docs/jsobjref/document.rst @@ -7,13 +7,11 @@ Document **Description** -An Illustrator document. Documents are contained in the Application object. +An Illustrator document. Documents are contained in the :ref:`jsobjref/application` object. The default document settings—those properties starting with the word “default”—are global settings that affect the current document. Be sure to modify these default properties only when a document is open. Note that if you set default properties to desired values before creating new objects, you can streamline your scripts, eliminating the need to specify specific properties such as ``fillColor`` and ``stroked`` that have default properties. -A document’s color space, height, and width can only be set when the document is created. You cannot modify these properties in an existing document. See Application.open for more information on how document color spaces are handled. - -//todo: Add link to **Application.open** in above paragraph. +A document’s color space, height, and width can only be set when the document is created. You cannot modify these properties in an existing document. See :ref:`jsobjref/application.open` for more information on how document color spaces are handled. ---- @@ -21,9 +19,9 @@ A document’s color space, height, and width can only be set when the document Properties ========== -.. _document.activeDataset: +.. _jsobjref/document.activeDataset: -document.activeDataset +Document.activeDataset ******************************************************************************** ``app.activeDocument.activeDataset`` @@ -38,9 +36,9 @@ The currently opened dataset. ---- -.. _document.activeLayer: +.. _jsobjref/document.activeLayer: -document.activeLayer +Document.activeLayer ******************************************************************************** ``app.activeDocument.activeLayer`` @@ -55,9 +53,9 @@ The active layer in the document. ---- -.. _document.activeView: +.. _jsobjref/document.activeView: -document.activeView +Document.activeView ******************************************************************************** ``app.activeDocument.activeView`` @@ -72,9 +70,9 @@ The document’s current view. ---- -.. _document.artboards: +.. _jsobjref/document.artboards: -document.artboards +Document.artboards ******************************************************************************** ``app.activeDocument.artboards`` @@ -89,9 +87,9 @@ All artboards in the document. ---- -.. _document.brushes: +.. _jsobjref/document.brushes: -document.brushes +Document.brushes ******************************************************************************** ``app.activeDocument.brushes`` @@ -106,9 +104,9 @@ The brushes contained in the document. ---- -.. _document.characterStyles: +.. _jsobjref/document.characterStyles: -document.characterStyles +Document.characterStyles ******************************************************************************** ``app.activeDocument.characterStyles`` @@ -123,9 +121,9 @@ The list of character styles in this document. ---- -.. _document.compoundPathItems: +.. _jsobjref/document.compoundPathItems: -document.compoundPathItems +Document.compoundPathItems ******************************************************************************** ``app.activeDocument.compoundPathItems`` @@ -140,9 +138,9 @@ The compound path items contained in the document. ---- -.. _document.cropBox: +.. _jsobjref/document.cropBox: -document.cropBox +Document.cropBox ******************************************************************************** ``app.activeDocument.cropBox`` @@ -157,9 +155,9 @@ Array of 4 numbers. ---- -.. _document.cropStyle: +.. _jsobjref/document.cropStyle: -document.cropStyle +Document.cropStyle ******************************************************************************** ``app.activeDocument.cropStyle`` @@ -170,15 +168,13 @@ The style of the document’s cropping box. **Type** -// todo: link to **CropOptions** in Chapter 2 "Scripting Constants" - -**CropOptions**. +:ref:`jsobjref/cropOptions` ---- -.. _document.dataSets: +.. _jsobjref/document.dataSets: -document.dataSets +Document.dataSets ******************************************************************************** ``app.activeDocument.dataSets`` @@ -193,9 +189,9 @@ The datasets contained in the document. ---- -.. _document.defaultFillColor: +.. _jsobjref/document.defaultFillColor: -document.defaultFillColor +Document.defaultFillColor ******************************************************************************** ``app.activeDocument.defaultFillColor`` @@ -210,9 +206,9 @@ The color to use to fill new paths if ``defaultFilled`` is ``true``. ---- -.. _document.defaultFilled: +.. _jsobjref/document.defaultFilled: -document.defaultFilled +Document.defaultFilled ******************************************************************************** ``app.activeDocument.defaultFilled`` @@ -227,26 +223,9 @@ Boolean. ---- -.. _document.defaultFilled: +.. _jsobjref/document.defaultFillOverprint: -document.defaultFilled -******************************************************************************** - -``app.activeDocument.defaultFilled`` - -**Description** - -If ``true``, a new path should be filled. - -**Type** - -Boolean. - ----- - -.. _document.defaultFillOverprint: - -document.defaultFillOverprint +Document.defaultFillOverprint ******************************************************************************** ``app.activeDocument.defaultFillOverprint`` @@ -261,9 +240,9 @@ Boolean. ---- -.. _document.defaultStrokeCap: +.. _jsobjref/document.defaultStrokeCap: -document.defaultStrokeCap +Document.defaultStrokeCap ******************************************************************************** ``app.activeDocument.defaultStrokeCap`` @@ -274,15 +253,13 @@ Default type of line capping for paths created. **Type** -// todo: link to **StrokeCap** in Chapter 2 "Scripting Constants" - -**StrokeCap**. +:ref:`jsobjref/strokeCap` ---- -.. _document.defaultStrokeColor: +.. _jsobjref/document.defaultStrokeColor: -document.defaultStrokeColor +Document.defaultStrokeColor ******************************************************************************** ``app.activeDocument.defaultStrokeColor`` @@ -297,9 +274,9 @@ The stroke color for new paths if default stroked is ``true``. ---- -.. _document.defaultStroked: +.. _jsobjref/document.defaultStroked: -document.defaultStroked +Document.defaultStroked ******************************************************************************** ``app.activeDocument.defaultStroked`` @@ -314,9 +291,9 @@ Boolean. ---- -.. _document.defaultStrokeDashes: +.. _jsobjref/document.defaultStrokeDashes: -document.defaultStrokeDashes +Document.defaultStrokeDashes ******************************************************************************** ``app.activeDocument.defaultStrokeDashes`` @@ -331,9 +308,9 @@ Object. ---- -.. _document.defaultStrokeDashOffset: +.. _jsobjref/document.defaultStrokeDashOffset: -document.defaultStrokeDashOffset +Document.defaultStrokeDashOffset ******************************************************************************** ``app.activeDocument.defaultStrokeDashOffset`` @@ -348,9 +325,9 @@ Number (double). ---- -.. _document.defaultStrokeJoin: +.. _jsobjref/document.defaultStrokeJoin: -document.defaultStrokeJoin +Document.defaultStrokeJoin ******************************************************************************** ``app.activeDocument.defaultStrokeJoin`` @@ -361,15 +338,13 @@ Default type of joints in new paths. **Type** -// todo: link to **StrokeJoin** in Chapter 2 "Scripting Constants" - -**StrokeJoin**. +:ref:`jsobjref/strokeJoin` ---- -.. _document.defaultStrokeMiterLimit: +.. _jsobjref/document.defaultStrokeMiterLimit: -document.defaultStrokeMiterLimit +Document.defaultStrokeMiterLimit ******************************************************************************** ``app.activeDocument.defaultStrokeMiterLimit`` @@ -384,9 +359,9 @@ Number (double). ---- -.. _document.defaultStrokeOverprint: +.. _jsobjref/document.defaultStrokeOverprint: -document.defaultStrokeOverprint +Document.defaultStrokeOverprint ******************************************************************************** ``app.activeDocument.defaultStrokeOverprint`` @@ -401,9 +376,9 @@ Boolean. ---- -.. _document.defaultStrokeWidth: +.. _jsobjref/document.defaultStrokeWidth: -document.defaultStrokeWidth +Document.defaultStrokeWidth ******************************************************************************** ``app.activeDocument.defaultStrokeWidth`` @@ -418,9 +393,9 @@ Number (double). ---- -.. _document.documentColorSpace: +.. _jsobjref/document.documentColorSpace: -document.documentColorSpace +Document.documentColorSpace ******************************************************************************** ``app.activeDocument.documentColorSpace`` @@ -431,15 +406,13 @@ The color specification system to use for this document’s color space. **Type** -// todo: link to **DocumentColorSpace** in Chapter 2 "Scripting Constants" - -**DocumentColorSpace**, read-only. +:ref:`jsobjref/documentColorSpace`, read-only. ---- -.. _document.fullName: +.. _jsobjref/document.fullName: -document.fullName +Document.fullName ******************************************************************************** ``app.activeDocument.fullName`` @@ -454,9 +427,9 @@ File, read-only. ---- -.. _document.geometricBounds: +.. _jsobjref/document.geometricBounds: -document.geometricBounds +Document.geometricBounds ******************************************************************************** ``app.activeDocument.geometricBounds`` @@ -471,9 +444,9 @@ Array of 4 numbers, read-only. ---- -.. _document.gradients: +.. _jsobjref/document.gradients: -document.gradients +Document.gradients ******************************************************************************** ``app.activeDocument.gradients`` @@ -488,9 +461,9 @@ The gradients contained in the document. ---- -.. _document.graphicStyles: +.. _jsobjref/document.graphicStyles: -document.graphicStyles +Document.graphicStyles ******************************************************************************** ``app.activeDocument.graphicStyles`` @@ -505,9 +478,9 @@ The graphic styles defined in this document. ---- -.. _document.graphItems: +.. _jsobjref/document.graphItems: -document.graphItems +Document.graphItems ******************************************************************************** ``app.activeDocument.graphItems`` @@ -522,9 +495,9 @@ The graph art items in this document. ---- -.. _document.groupItems: +.. _jsobjref/document.groupItems: -document.groupItems +Document.groupItems ******************************************************************************** ``app.activeDocument.groupItems`` @@ -539,9 +512,9 @@ The group items contained in the document. ---- -.. _document.height: +.. _jsobjref/document.height: -document.height +Document.height ******************************************************************************** ``app.activeDocument.height`` @@ -556,9 +529,9 @@ Number (double), read-only. ---- -.. _document.inkList: +.. _jsobjref/document.inkList: -document.inkList +Document.inkList ******************************************************************************** ``app.activeDocument.inkList`` @@ -573,9 +546,9 @@ Object, read-only. ---- -.. _document.kinsokuSet: +.. _jsobjref/document.kinsokuSet: -document.kinsokuSet +Document.kinsokuSet ******************************************************************************** ``app.activeDocument.kinsokuSet`` @@ -590,9 +563,9 @@ Object, read-only. ---- -.. _document.layers: +.. _jsobjref/document.layers: -document.layers +Document.layers ******************************************************************************** ``app.activeDocument.layers`` @@ -607,9 +580,9 @@ The layers contained in the document. ---- -.. _document.legacyTextItems: +.. _jsobjref/document.legacyTextItems: -document.legacyTextItems +Document.legacyTextItems ******************************************************************************** ``app.activeDocument.legacyTextItems`` @@ -624,9 +597,9 @@ The legacy text items in the document. ---- -.. _document.meshItems: +.. _jsobjref/document.meshItems: -document.meshItems +Document.meshItems ******************************************************************************** ``app.activeDocument.meshItems`` @@ -641,9 +614,9 @@ The mesh art items contained in the document. ---- -.. _document.mojikumiSet: +.. _jsobjref/document.mojikumiSet: -document.mojikumiSet +Document.mojikumiSet ******************************************************************************** ``app.activeDocument.mojikumiSet`` @@ -658,9 +631,9 @@ Object, read-only. ---- -.. _document.name: +.. _jsobjref/document.name: -document.name +Document.name ******************************************************************************** ``app.activeDocument.name`` @@ -675,9 +648,9 @@ String, read-only. ---- -.. _document.nonNativeItems: +.. _jsobjref/document.nonNativeItems: -document.nonNativeItems +Document.nonNativeItems ******************************************************************************** ``app.activeDocument.nonNativeItems`` @@ -692,9 +665,9 @@ The non-native art items in this document. ---- -.. _document.outputResolution: +.. _jsobjref/document.outputResolution: -document.outputResolution +Document.outputResolution ******************************************************************************** ``app.activeDocument.outputResolution`` @@ -709,9 +682,9 @@ Number (double), read-only. ---- -.. _document.pageItems: +.. _jsobjref/document.pageItems: -document.pageItems +Document.pageItems ******************************************************************************** ``app.activeDocument.pageItems`` @@ -726,9 +699,9 @@ The page items (all art item classes) contained in the document. ---- -.. _document.pageOrigin: +.. _jsobjref/document.pageOrigin: -document.pageOrigin +Document.pageOrigin ******************************************************************************** ``app.activeDocument.pageOrigin`` @@ -743,9 +716,9 @@ Array of 2 numbers. ---- -.. _document.paragraphStyles: +.. _jsobjref/document.paragraphStyles: -document.paragraphStyles +Document.paragraphStyles ******************************************************************************** ``app.activeDocument.paragraphStyles`` @@ -760,9 +733,9 @@ The list of paragraph styles in this document. ---- -.. _document.parent: +.. _jsobjref/document.parent: -document.parent +Document.parent ******************************************************************************** ``app.activeDocument.parent`` @@ -777,9 +750,9 @@ The application that contains this document. ---- -.. _document.path: +.. _jsobjref/document.path: -document.path +Document.path ******************************************************************************** ``app.activeDocument.path`` @@ -794,9 +767,9 @@ File, read-only. ---- -.. _document.pathItems: +.. _jsobjref/document.pathItems: -document.pathItems +Document.pathItems ******************************************************************************** ``app.activeDocument.pathItems`` @@ -811,9 +784,9 @@ The path items contained in this document. ---- -.. _document.patterns: +.. _jsobjref/document.patterns: -document.patterns +Document.patterns ******************************************************************************** ``app.activeDocument.patterns`` @@ -828,9 +801,9 @@ The patterns contained in this document. ---- -.. _document.placedItems: +.. _jsobjref/document.placedItems: -document.placedItems +Document.placedItems ******************************************************************************** ``app.activeDocument.placedItems`` @@ -845,9 +818,9 @@ The placed items contained in this document. ---- -.. _document.pluginItems: +.. _jsobjref/document.pluginItems: -document.pluginItems +Document.pluginItems ******************************************************************************** ``app.activeDocument.pluginItems`` @@ -862,9 +835,9 @@ The plug-in items contained in this document. ---- -.. _document.printTiles: +.. _jsobjref/document.printTiles: -document.printTiles +Document.printTiles ******************************************************************************** ``app.activeDocument.printTiles`` @@ -879,9 +852,9 @@ Boolean, read-only. ---- -.. _document.rasterEffectSettings: +.. _jsobjref/document.rasterEffectSettings: -document.rasterEffectSettings +Document.rasterEffectSettings ******************************************************************************** ``app.activeDocument.rasterEffectSettings`` @@ -896,9 +869,9 @@ The document’s raster effect settings. ---- -.. _document.rasterItems: +.. _jsobjref/document.rasterItems: -document.rasterItems +Document.rasterItems ******************************************************************************** ``app.activeDocument.rasterItems`` @@ -913,9 +886,9 @@ The raster items contained in this document. ---- -.. _document.rulerOrigin: +.. _jsobjref/document.rulerOrigin: -document.rulerOrigin +Document.rulerOrigin ******************************************************************************** ``app.activeDocument.rulerOrigin`` @@ -930,9 +903,9 @@ Array of 2 numbers. ---- -.. _document.rulerUnits: +.. _jsobjref/document.rulerUnits: -document.rulerUnits +Document.rulerUnits ******************************************************************************** ``app.activeDocument.rulerUnits`` @@ -943,15 +916,13 @@ The default measurement units for the rulers in the document. **Type** -// todo: link to **RulerUnits** in Chapter 2 "Scripting Constants" - -**RulerUnits**, read-only. +:ref:`jsobjref/rulerUnits`, read-only. ---- -.. _document.saved: +.. _jsobjref/document.saved: -document.saved +Document.saved ******************************************************************************** ``app.activeDocument.saved`` @@ -966,9 +937,9 @@ Boolean. ---- -.. _document.selection: +.. _jsobjref/document.selection: -document.selection +Document.selection ******************************************************************************** ``app.activeDocument.selection`` @@ -985,9 +956,9 @@ Array of objects. ---- -.. _document.showPlacedImages: +.. _jsobjref/document.showPlacedImages: -document.showPlacedImages +Document.showPlacedImages ******************************************************************************** ``app.activeDocument.showPlacedImages`` @@ -1002,9 +973,9 @@ Boolean, read-only. ---- -.. _document.splitLongPaths: +.. _jsobjref/document.splitLongPaths: -document.splitLongPaths +Document.splitLongPaths ******************************************************************************** ``app.activeDocument.splitLongPaths`` @@ -1019,9 +990,9 @@ Boolean, read-only. ---- -.. _document.spots: +.. _jsobjref/document.spots: -document.spots +Document.spots ******************************************************************************** ``app.activeDocument.spots`` @@ -1036,9 +1007,9 @@ The spot colors contained in this document. ---- -.. _document.stationery: +.. _jsobjref/document.stationery: -document.stationery +Document.stationery ******************************************************************************** ``app.activeDocument.stationery`` @@ -1053,9 +1024,9 @@ Boolean, read-only. ---- -.. _document.stories: +.. _jsobjref/document.stories: -document.stories +Document.stories ******************************************************************************** ``app.activeDocument.stories`` @@ -1070,9 +1041,9 @@ The story items in this document. ---- -.. _document.swatches: +.. _jsobjref/document.swatches: -document.swatches +Document.swatches ******************************************************************************** ``app.activeDocument.swatches`` @@ -1087,9 +1058,9 @@ The swatches in this document. ---- -.. _document.swatchGroups: +.. _jsobjref/document.swatchGroups: -document.swatchGroups +Document.swatchGroups ******************************************************************************** ``app.activeDocument.swatchGroups`` @@ -1104,9 +1075,9 @@ The swatch groups in this document. ---- -.. _document.symbolItems: +.. _jsobjref/document.symbolItems: -document.symbolItems +Document.symbolItems ******************************************************************************** ``app.activeDocument.symbolItems`` @@ -1121,9 +1092,9 @@ The art items in the document linked to symbols. ---- -.. _document.symbols: +.. _jsobjref/document.symbols: -document.symbols +Document.symbols ******************************************************************************** ``app.activeDocument.symbols`` @@ -1138,9 +1109,9 @@ The symbols in this document. ---- -.. _document.tags: +.. _jsobjref/document.tags: -document.tags +Document.tags ******************************************************************************** ``app.activeDocument.tags`` @@ -1155,9 +1126,9 @@ The tags in this document. ---- -.. _document.textFrames: +.. _jsobjref/document.textFrames: -document.textFrames +Document.textFrames ******************************************************************************** ``app.activeDocument.textFrames`` @@ -1172,9 +1143,9 @@ The text frames in this document. ---- -.. _document.tileFullPages: +.. _jsobjref/document.tileFullPages: -document.tileFullPages +Document.tileFullPages ******************************************************************************** ``app.activeDocument.tileFullPages`` @@ -1189,9 +1160,9 @@ Boolean, read-only. ---- -.. _document.typename: +.. _jsobjref/document.typename: -document.typename +Document.typename ******************************************************************************** ``app.activeDocument.typename`` @@ -1206,9 +1177,9 @@ String, read-only. ---- -.. _document.useDefaultScreen: +.. _jsobjref/document.useDefaultScreen: -document.useDefaultScreen +Document.useDefaultScreen ******************************************************************************** ``app.activeDocument.useDefaultScreen`` @@ -1223,9 +1194,9 @@ Boolean, read-only. ---- -.. _document.variables: +.. _jsobjref/document.variables: -document.variables +Document.variables ******************************************************************************** ``app.activeDocument.variables`` @@ -1240,9 +1211,9 @@ The variables defined in this document. ---- -.. _document.variablesLocked: +.. _jsobjref/document.variablesLocked: -document.variablesLocked +Document.variablesLocked ******************************************************************************** ``app.activeDocument.variablesLocked`` @@ -1257,9 +1228,9 @@ Boolean. ---- -.. _document.views: +.. _jsobjref/document.views: -document.views +Document.views ******************************************************************************** ``app.activeDocument.views`` @@ -1274,9 +1245,9 @@ The views contained in this document. ---- -.. _document.visibleBounds: +.. _jsobjref/document.visibleBounds: -document.visibleBounds +Document.visibleBounds ******************************************************************************** ``app.activeDocument.visibleBounds`` @@ -1291,9 +1262,9 @@ Array of 4 numbers, read-only. ---- -.. _document.width: +.. _jsobjref/document.width: -document.width +Document.width ******************************************************************************** ``app.activeDocument.width`` @@ -1308,9 +1279,9 @@ Number (double), read-only. ---- -.. _document.XMPString: +.. _jsobjref/document.XMPString: -document.XMPString +Document.XMPString ******************************************************************************** ``app.activeDocument.XMPString`` @@ -1329,9 +1300,9 @@ String. Methods ======= -.. _document.activate: +.. _jsobjref/document.activate: -document.activate() +Document.activate() ******************************************************************************** ``app.activeDocument.activate()`` @@ -1346,9 +1317,9 @@ Nothing. ---- -.. _document.arrange: +.. _jsobjref/document.arrange: -document.arrange() +Document.arrange() ******************************************************************************** ``app.activeDocument.arrange([layoutStyle])`` @@ -1362,7 +1333,7 @@ Arranges multiple documents in the given layout style. +-------------------+---------------------------------------------------------------------------------------+-------------+ | Parameter | Type | Description | +===================+=======================================================================================+=============+ -| ``[layoutStyle]`` | // todo: link to **DocumentLayoutStyle** in Chapter 2 "Scripting Constants", optional | todo | +| ``[layoutStyle]`` | :ref:`jsobjref/documentLayoutStyle`, optional | todo | +-------------------+---------------------------------------------------------------------------------------+-------------+ **Returns** @@ -1371,9 +1342,9 @@ Boolean. ---- -.. _document.close: +.. _jsobjref/document.close: -document.close() +Document.close() ******************************************************************************** ``app.activeDocument.close([saveOptions])`` @@ -1389,7 +1360,7 @@ When you close a document, you should set your document reference to ``null`` to +-------------------+-------------------------------------------------------------------------------+-------------+ | Parameter | Type | Description | +===================+===============================================================================+=============+ -| ``[saveOptions]`` | // todo: link to **SaveOptions** in Chapter 2 "Scripting Constants", optional | todo | +| ``[saveOptions]`` | :ref:`jsobjref/saveOptions` | todo | +-------------------+-------------------------------------------------------------------------------+-------------+ **Returns** @@ -1398,9 +1369,9 @@ Nothing. ---- -.. _document.closeNoUI: +.. _jsobjref/document.closeNoUI: -document.closeNoUI() +Document.closeNoUI() ******************************************************************************** ``app.activeDocument.closeNoUI()`` @@ -1415,9 +1386,9 @@ Nothing. ---- -.. _document.convertCoordinate: +.. _jsobjref/document.convertCoordinate: -document.convertCoordinate() +Document.convertCoordinate() ******************************************************************************** ``app.activeDocument.convertCoordinate(coordinate, source, destination)`` @@ -1433,9 +1404,9 @@ Converts the given point between artboard and document coordinate systems. Retur +=================+==========================================================================+=============+ | ``coordinate`` | Point | todo | +-----------------+--------------------------------------------------------------------------+-------------+ -| ``source`` | // todo: link to **CoordinateSystem** in Chapter 2 "Scripting Constants" | todo | +| ``source`` | :ref:`jsobjref/coordinateSystem` | todo | +-----------------+--------------------------------------------------------------------------+-------------+ -| ``destination`` | // todo: link to **CoordinateSystem** in Chapter 2 "Scripting Constants" | todo | +| ``destination`` | :ref:`jsobjref/coordinateSystem` | todo | +-----------------+--------------------------------------------------------------------------+-------------+ **Returns** @@ -1444,9 +1415,9 @@ Point. ---- -.. _document.exportFile: +.. _jsobjref/document.exportFile: -document.exportFile() +Document.exportFile() ******************************************************************************** ``app.activeDocument.exportFile(exportFile, exportFormat [,options])`` @@ -1462,7 +1433,7 @@ Exports the document to the specified file using one of the predefined export fi +==================+====================================================================+=============+ | ``exportFile`` | File | todo | +------------------+--------------------------------------------------------------------+-------------+ -| ``exportFormat`` | // todo: link to **ExportType** in Chapter 2 "Scripting Constants" | todo | +| ``exportFormat`` | :ref:`jsobjref/exportType` | todo | +------------------+--------------------------------------------------------------------+-------------+ | ``[options]`` | Variant, optional | todo | +------------------+--------------------------------------------------------------------+-------------+ @@ -1473,9 +1444,9 @@ Nothing. ---- -.. _document.exportPDFPreset: +.. _jsobjref/document.exportPDFPreset: -document.exportPDFPreset() +Document.exportPDFPreset() ******************************************************************************** ``app.activeDocument.exportPDFPreset(file)`` @@ -1498,9 +1469,9 @@ Nothing. ---- -.. _document.exportPerspectiveGridPreset: +.. _jsobjref/document.exportPerspectiveGridPreset: -document.exportPerspectiveGridPreset() +Document.exportPerspectiveGridPreset() ******************************************************************************** ``app.activeDocument.exportPerspectiveGridPreset(file)`` @@ -1523,9 +1494,9 @@ Nothing. ---- -.. _document.exportPrintPreset: +.. _jsobjref/document.exportPrintPreset: -document.exportPrintPreset() +Document.exportPrintPreset() ******************************************************************************** ``app.activeDocument.exportPrintPreset(file)`` @@ -1548,9 +1519,9 @@ Nothing. ---- -.. _document.exportVariables: +.. _jsobjref/document.exportVariables: -document.exportVariables() +Document.exportVariables() ******************************************************************************** ``app.activeDocument.exportVariables(fileSpec)`` @@ -1573,9 +1544,9 @@ Nothing. ---- -.. _document.fitArtboardToSelectedArt: +.. _jsobjref/document.fitArtboardToSelectedArt: -document.fitArtboardToSelectedArt() +Document.fitArtboardToSelectedArt() ******************************************************************************** ``app.activeDocument.fitArtboardToSelectedArt([index])`` @@ -1598,9 +1569,9 @@ Boolean. ---- -.. _document.getPerspectiveActivePlane: +.. _jsobjref/document.getPerspectiveActivePlane: -document.getPerspectiveActivePlane() +Document.getPerspectiveActivePlane() ******************************************************************************** ``app.activeDocument.getPerspectiveActivePlane()`` @@ -1611,15 +1582,15 @@ Retrieves the active plane of the active perspective grid of the document. **Returns** -// todo: link to **PerspectiveGridPlaneType** in Chapter 2 "Scripting Constants" +:ref:`jsobjref/perspectiveGridPlaneType` **PerspectiveGridPlaneType**. ---- -.. _document.hidePerspectiveGrid: +.. _jsobjref/document.hidePerspectiveGrid: -document.hidePerspectiveGrid() +Document.hidePerspectiveGrid() ******************************************************************************** ``app.activeDocument.hidePerspectiveGrid()`` @@ -1634,9 +1605,9 @@ Boolean. ---- -.. _document.imageCapture: +.. _jsobjref/document.imageCapture: -document.imageCapture() +Document.imageCapture() ******************************************************************************** ``app.activeDocument.imageCapture(imageFile [,clipBounds] [,options])`` @@ -1665,9 +1636,9 @@ Nothing. ---- -.. _document.importCharacterStyles: +.. _jsobjref/document.importCharacterStyles: -document.importCharacterStyles() +Document.importCharacterStyles() ******************************************************************************** ``app.activeDocument.importCharacterStyles(fileSpec)`` @@ -1690,9 +1661,9 @@ Nothing. ---- -.. _document.importParagraphStyles: +.. _jsobjref/document.importParagraphStyles: -document.importParagraphStyles() +Document.importParagraphStyles() ******************************************************************************** ``app.activeDocument.importParagraphStyles(fileSpec)`` @@ -1715,9 +1686,9 @@ Nothing. ---- -.. _document.importPDFPreset: +.. _jsobjref/document.importPDFPreset: -document.importPDFPreset() +Document.importPDFPreset() ******************************************************************************** ``app.activeDocument.importPDFPreset(fileSpec [, replacingPreset])`` @@ -1742,9 +1713,9 @@ Nothing. ---- -.. _document.importPrintPreset: +.. _jsobjref/document.importPrintPreset: -document.importPrintPreset() +Document.importPrintPreset() ******************************************************************************** ``app.activeDocument.importPrintPreset(printPreset, fileSpec)`` @@ -1769,9 +1740,9 @@ Nothing. ---- -.. _document.importVariables: +.. _jsobjref/document.importVariables: -document.importVariables() +Document.importVariables() ******************************************************************************** ``app.activeDocument.importVariables(fileSpec)`` @@ -1794,9 +1765,9 @@ Nothing. ---- -.. _document.print: +.. _jsobjref/document.print: -document.print() +Document.print() ******************************************************************************** ``app.activeDocument.print([options])`` @@ -1819,9 +1790,9 @@ Nothing. ---- -.. _document.rasterize: +.. _jsobjref/document.rasterize: -document.rasterize() +Document.rasterize() ******************************************************************************** ``app.activeDocument.rasterize(sourceArt [, clipBounds] [, options])`` @@ -1848,9 +1819,9 @@ Rasterizes the source art(s) within the specified clip bounds. The source art(s) ---- -.. _document.rearrangeArboards: +.. _jsobjref/document.rearrangeArboards: -document.rearrangeArboards() +Document.rearrangeArboards() ******************************************************************************** ``app.activeDocument.rearrangeArboards([artboardLayout] [, artboardRowsOrCols] [, artboardSpacing] [, artboardMoveArtwork])`` @@ -1870,7 +1841,7 @@ When last argument is true (the default), artwork is moved with the artboards. +---------------------------+------------------------------------------------------------------------------------------+-------------+ | Parameter | Type | Description | +===========================+==========================================================================================+=============+ -| ``[artboardLayout]`` | // todo: link to **DocumentArtboardLayout** in Chapter 2 "Scripting Constants", optional | todo | +| ``[artboardLayout]`` | :ref:`jsobjref/documentArtboardLayout`, optional | todo | +---------------------------+------------------------------------------------------------------------------------------+-------------+ | ``[artboardRowsOrCols]`` | Integer, optional | todo | +---------------------------+------------------------------------------------------------------------------------------+-------------+ @@ -1885,9 +1856,9 @@ Boolean. ---- -.. _document.save: +.. _jsobjref/document.save: -document.save() +Document.save() ******************************************************************************** ``app.activeDocument.save()`` @@ -1902,9 +1873,9 @@ Nothing. ---- -.. _document.saveAs: +.. _jsobjref/document.saveAs: -document.saveAs() +Document.saveAs() ******************************************************************************** ``app.activeDocument.saveAs(saveIn [, options])`` @@ -1920,7 +1891,7 @@ Saves the document in the specified file as an Illustrator, EPS, or PDF file. +===============+===============================================================================+=============+ | ``saveIn`` | File | todo | +---------------+-------------------------------------------------------------------------------+-------------+ -| ``[options]`` | // todo: link to **SaveOptions** in Chapter 2 "Scripting Constants", optional | todo | +| ``[options]`` | :ref:`jsobjref/saveOptions`, optional | todo | +---------------+-------------------------------------------------------------------------------+-------------+ **Returns** @@ -1929,9 +1900,9 @@ Nothing. ---- -.. _document.saveNoUI: +.. _jsobjref/document.saveNoUI: -document.saveNoUI() +Document.saveNoUI() ******************************************************************************** ``app.activeDocument.saveNoUI(saveIn)`` @@ -1954,9 +1925,9 @@ Nothing. ---- -.. _document.selectObjectsOnActiveArtboard: +.. _jsobjref/document.selectObjectsOnActiveArtboard: -document.selectObjectsOnActiveArtboard() +Document.selectObjectsOnActiveArtboard() ******************************************************************************** ``app.activeDocument.selectObjectsOnActiveArtboard()`` @@ -1971,9 +1942,9 @@ Boolean. ---- -.. _document.setActivePlane: +.. _jsobjref/document.setActivePlane: -document.setActivePlane() +Document.setActivePlane() ******************************************************************************** ``app.activeDocument.setActivePlane(gridPlane)`` @@ -1987,7 +1958,7 @@ Sets the active plane of the active perspective grid of the document. Returns `` +---------------+----------------------------------------------------------------------------------+-------------+ | Parameter | Type | Description | +===============+==================================================================================+=============+ -| ``gridPlane`` | // todo: link to **PerspectiveGridPlaneType** in Chapter 2 "Scripting Constants" | todo | +| ``gridPlane`` | :ref:`jsobjref/perspectiveGridPlaneType` | todo | +---------------+----------------------------------------------------------------------------------+-------------+ **Returns** @@ -1996,9 +1967,9 @@ Boolean. ---- -.. _document.selectPerspectivePreset: +.. _jsobjref/document.selectPerspectivePreset: -document.selectPerspectivePreset() +Document.selectPerspectivePreset() ******************************************************************************** ``app.activeDocument.selectPerspectivePreset(gridType, presetName)`` @@ -2012,7 +1983,7 @@ Selects a predefined preset to define grid for the current document. Returns ``t +----------------+-----------------------------------------------------------------------------+-------------+ | Parameter | Type | Description | +================+=============================================================================+=============+ -| ``gridType`` | // todo: link to **PerspectiveGridType** in Chapter 2 "Scripting Constants" | todo | +| ``gridType`` | :ref:`jsobjref/perspectiveGridType` | todo | +----------------+-----------------------------------------------------------------------------+-------------+ | ``presetName`` | String | todo | +----------------+-----------------------------------------------------------------------------+-------------+ @@ -2023,9 +1994,9 @@ Boolean. ---- -.. _document.showPerspectiveGrid: +.. _jsobjref/document.showPerspectiveGrid: -document.showPerspectiveGrid() +Document.showPerspectiveGrid() ******************************************************************************** ``app.activeDocument.showPerspectiveGrid()`` @@ -2040,9 +2011,9 @@ Boolean. ---- -.. _document.windowCapture: +.. _jsobjref/document.windowCapture: -document.windowCapture() +Document.windowCapture() ******************************************************************************** ``app.activeDocument.windowCapture(imageFile, windowSize)`` @@ -2111,4 +2082,4 @@ Creating a document with defaults } doc.defaultFilled = true; - doc.defaultStroked = true; \ No newline at end of file + doc.defaultStroked = true; diff --git a/docs/jsobjref/documentPreset.rst b/docs/jsobjref/documentPreset.rst index d97bd11..db45dd5 100644 --- a/docs/jsobjref/documentPreset.rst +++ b/docs/jsobjref/documentPreset.rst @@ -7,9 +7,7 @@ Document Preset **Description** -A preset document template to use when creating a new document. See **Documents.addDocument()**. - -//todo: Add link to **Documents.addDocument()** in above paragraph. +A preset document template to use when creating a new document. See :ref:`jsobjref/documents.addDocument`. ---- @@ -17,7 +15,7 @@ A preset document template to use when creating a new document. See **Documents. Properties ========== -.. _documentPreset.artboardLayout: +.. _jsobjref/documentPreset.artboardLayout: documentPreset.artboardLayout ******************************************************************************** @@ -30,13 +28,11 @@ The layout of artboards in the new document. Default: ``GridByRow``. **Type** -// todo: link to **DocumentArtboardLayout** in Chapter 2 "Scripting Constants" - -**DocumentArtboardLayout** +:ref:`jsobjref/documentArtboardLayout` ---- -.. _documentPreset.artboardRowsOrCols: +.. _jsobjref/documentPreset.artboardRowsOrCols: documentPreset.artboardRowsOrCols ******************************************************************************** @@ -53,7 +49,7 @@ Number (long). ---- -.. _documentPreset.artboardSpacing: +.. _jsobjref/documentPreset.artboardSpacing: documentPreset.artboardSpacing ******************************************************************************** @@ -70,7 +66,7 @@ Number (double). ---- -.. _documentPreset.colorMode: +.. _jsobjref/documentPreset.colorMode: documentPreset.colorMode ******************************************************************************** @@ -83,13 +79,11 @@ The color space for the new document. **Type** -// todo: link to **DocumentColorSpace** in Chapter 2 "Scripting Constants" - -**DocumentColorSpace** +:ref:`jsobjref/documentColorSpace` ---- -.. _documentPreset.documentBleedLink: +.. _jsobjref/documentPreset.documentBleedLink: documentPreset.documentBleedLink ******************************************************************************** @@ -106,7 +100,7 @@ Boolean. ---- -.. _documentPreset.documentBleedOffsetRect: +.. _jsobjref/documentPreset.documentBleedOffsetRect: documentPreset.documentBleedOffsetRect ******************************************************************************** @@ -123,7 +117,7 @@ Rectangle. ---- -.. _documentPreset.height: +.. _jsobjref/documentPreset.height: documentPreset.height ******************************************************************************** @@ -140,7 +134,7 @@ Number (double). ---- -.. _documentPreset.numArtboards: +.. _jsobjref/documentPreset.numArtboards: documentPreset.numArtboards ******************************************************************************** @@ -157,7 +151,7 @@ Number (long). ---- -.. _documentPreset.previewMode: +.. _jsobjref/documentPreset.previewMode: documentPreset.previewMode ******************************************************************************** @@ -170,13 +164,11 @@ The preview mode for the new document. **Type** -// todo: link to **DocumentPreviewMode** in Chapter 2 "Scripting Constants" - -**DocumentPreviewMode** +:ref:`jsobjref/previewMode` ---- -.. _documentPreset.rasterResolution: +.. _jsobjref/documentPreset.rasterResolution: documentPreset.rasterResolution ******************************************************************************** @@ -189,13 +181,11 @@ The raster resolution for the new document. **Type** -// todo: link to **DocumentRasterResolution** in Chapter 2 "Scripting Constants" - -**DocumentRasterResolution** +:ref:`jsobjref/rasterResolution` ---- -.. _documentPreset.title: +.. _jsobjref/documentPreset.title: documentPreset.title ******************************************************************************** @@ -212,7 +202,7 @@ String. ---- -.. _documentPreset.transparencyGrid: +.. _jsobjref/documentPreset.transparencyGrid: documentPreset.transparencyGrid ******************************************************************************** @@ -225,13 +215,11 @@ The transparency grid color for the new document. **Type** -// todo: link to **DocumentTransparencyGrid** in Chapter 2 "Scripting Constants" - -**DocumentTransparencyGrid** +:ref:`jsobjref/documentTransparencyGrid` ---- -.. _documentPreset.typename: +.. _jsobjref/documentPreset.typename: documentPreset.typename ******************************************************************************** @@ -248,7 +236,7 @@ String, read-only. ---- -.. _documentPreset.units: +.. _jsobjref/documentPreset.units: documentPreset.units ******************************************************************************** @@ -261,13 +249,11 @@ The ruler units for the new document. **Type** -// todo: link to **RulerUnits** in Chapter 2 "Scripting Constants" - -**RulerUnits** +:ref:`jsobjref/rulerUnits` ---- -.. _documentPreset.width: +.. _jsobjref/documentPreset.width: documentPreset.width ******************************************************************************** @@ -281,5 +267,3 @@ The width in document points. Default: 612.0 **Type** Number (double). - ----- \ No newline at end of file diff --git a/docs/jsobjref/documents.rst b/docs/jsobjref/documents.rst index 622b6c5..57ea849 100644 --- a/docs/jsobjref/documents.rst +++ b/docs/jsobjref/documents.rst @@ -7,7 +7,7 @@ Documents **Description** -A collection of ``Document`` objects. +A collection of :ref:`jsobjref/document` objects. ---- @@ -15,9 +15,9 @@ A collection of ``Document`` objects. Properties ========== -.. _documents.length: +.. _jsobjref/documents.length: -documents.length +Documents.length ******************************************************************************** ``app.documents.length`` @@ -32,9 +32,9 @@ Number, read-only. ---- -.. _documents.parent: +.. _jsobjref/documents.parent: -documents.parent +Documents.parent ******************************************************************************** ``app.documents.parent`` @@ -49,9 +49,9 @@ Object, read-only. ---- -.. _documents.typename: +.. _jsobjref/documents.typename: -documents.typename +Documents.typename ******************************************************************************** ``app.documents.typename`` @@ -70,9 +70,9 @@ String, read-only. Methods ======= -.. _documents.add: +.. _jsobjref/documents.add: -documents.add() +Documents.add() ******************************************************************************** :: @@ -90,7 +90,7 @@ Creates a new document using optional parameters and returns a reference to the +--------------------------+--------------------------------------------------------------------------------------+-------------+ | Parameter | Type | Description | +==========================+======================================================================================+=============+ -| ``[documentColorSpace]`` | // todo: link to **DocumentColorSpace** in Chapter 2 "Scripting Constants", optional | todo | +| ``[documentColorSpace]`` | :ref:`jsobjref/documentColorSpace`, optional | todo | +--------------------------+--------------------------------------------------------------------------------------+-------------+ | ``[width]`` | number (double), optional | todo | +--------------------------+--------------------------------------------------------------------------------------+-------------+ @@ -98,7 +98,7 @@ Creates a new document using optional parameters and returns a reference to the +--------------------------+--------------------------------------------------------------------------------------+-------------+ | ``[numArtBoards]`` | number (long), optional | todo | +--------------------------+--------------------------------------------------------------------------------------+-------------+ -| ``[artboardLayout]`` | // todo: link to **DocumentArtboardLayout** in Chapter 2 "Scripting Constants" | todo | +| ``[artboardLayout]`` | :ref:`jsobjref/documentArtboardLayout` | todo | +--------------------------+--------------------------------------------------------------------------------------+-------------+ | ``[artboardSpacing]`` | number (double), optional | todo | +--------------------------+--------------------------------------------------------------------------------------+-------------+ @@ -111,9 +111,9 @@ Creates a new document using optional parameters and returns a reference to the ---- -.. _documents.addDocument: +.. _jsobjref/documents.addDocument: -documents.addDocument() +Documents.addDocument() ******************************************************************************** ``app.documents.addDocument(startupPreset [, presetSettings] [, showOptionsDialog])`` @@ -140,9 +140,9 @@ Creates a document from the preset, replacing any provided setting values, and r ---- -.. _documents.addDocumentNoUI: +.. _jsobjref/documents.addDocumentNoUI: -documents.addDocumentNoUI() +Documents.addDocumentNoUI() ******************************************************************************** ``app.documents.addDocumentNoUI(startupPreset)`` @@ -165,9 +165,9 @@ Creates a document without showing in UI. ---- -.. _documents.getByName: +.. _jsobjref/documents.getByName: -documents.getByName() +Documents.getByName() ******************************************************************************** ``app.documents.getByName(name)`` @@ -190,9 +190,9 @@ Gets the first element in the collection with the specified name. ---- -.. _documents.index: +.. _jsobjref/documents.index: -documents.index() +Documents.index() ******************************************************************************** ``app.documents.index(itemKey)`` @@ -226,4 +226,4 @@ Creating a new document // Creates a new document with an RGB color space - app.documents.add( DocumentColorSpace.RGB ); \ No newline at end of file + app.documents.add( DocumentColorSpace.RGB ); diff --git a/docs/jsobjref/epsSaveOptions.rst b/docs/jsobjref/epsSaveOptions.rst index 765ebad..74f7826 100644 --- a/docs/jsobjref/epsSaveOptions.rst +++ b/docs/jsobjref/epsSaveOptions.rst @@ -7,7 +7,9 @@ EPS Save Options **Description** -Options for saving a document as an Illustrator EPS file, used with the `saveAs `__ method. All properties are optional. +Options for saving a document as an Illustrator EPS file, used with the :ref:`jsobjref/document.saveAs` method. + +All properties are optional. ---- @@ -15,7 +17,7 @@ Options for saving a document as an Illustrator EPS file, used with the `saveAs Properties ========== -.. _epsSaveOptions.artboardRange: +.. _jsobjref/epsSaveOptions.artboardRange: epsSaveOptions.artboardRange ******************************************************************************** @@ -32,7 +34,7 @@ String. ---- -.. _epsSaveOptions.cmykPostScript: +.. _jsobjref/epsSaveOptions.cmykPostScript: epsSaveOptions.cmykPostScript ******************************************************************************** @@ -49,7 +51,7 @@ Boolean. ---- -.. _epsSaveOptions.compatibility: +.. _jsobjref/epsSaveOptions.compatibility: epsSaveOptions.compatibility ******************************************************************************** @@ -58,15 +60,17 @@ epsSaveOptions.compatibility **Description** -Specifies the version of the EPS file format to save. Default: ``Compatibility.ILLUSTRATOR1719``. +Specifies the version of the EPS file format to save. + +Default: ``Compatibility.ILLUSTRATOR1719``. **Type** -// todo: link to **Compatibility** in Chapter 2 "Scripting Constants" +:ref:`jsobjref/compatibility` ---- -.. _epsSaveOptions.compatibleGradientPrinting: +.. _jsobjref/epsSaveOptions.compatibleGradientPrinting: epsSaveOptions.compatibleGradientPrinting ******************************************************************************** @@ -75,7 +79,9 @@ epsSaveOptions.compatibleGradientPrinting **Description** -If ``true``, create a raster item of the gradient or gradient mesh so that PostScript Level 2 printers can print the object. Default: ``false``. +If ``true``, create a raster item of the gradient or gradient mesh so that PostScript Level 2 printers can print the object. + +Default: ``false``. **Type** @@ -83,7 +89,7 @@ Boolean. ---- -.. _epsSaveOptions.embedAllFonts: +.. _jsobjref/epsSaveOptions.embedAllFonts: epsSaveOptions.embedAllFonts ******************************************************************************** @@ -92,7 +98,9 @@ epsSaveOptions.embedAllFonts **Description** -If ``true``, all fonts used by the document should be embedded in the saved file (version 7 or later). Default: ``false``. +If ``true``, all fonts used by the document should be embedded in the saved file (version 7 or later). + +Default: ``false``. **Type** @@ -100,7 +108,7 @@ Boolean. ---- -.. _epsSaveOptions.embedLinkedFiles: +.. _jsobjref/epsSaveOptions.embedLinkedFiles: epsSaveOptions.embedLinkedFiles ******************************************************************************** @@ -117,7 +125,7 @@ Boolean. ---- -.. _epsSaveOptions.flattenOuput: +.. _jsobjref/epsSaveOptions.flattenOuput: epsSaveOptions.flattenOuput ******************************************************************************** @@ -130,11 +138,11 @@ How should transparency be flattened for file formats older than Illustrator 9. **Type** -// todo: link to **OutputFlattening** in Chapter 2 "Scripting Constants" +:ref:`jsobjref/outputFlattening` ---- -.. _epsSaveOptions.includeDocumentThumbnails: +.. _jsobjref/epsSaveOptions.includeDocumentThumbnails: epsSaveOptions.includeDocumentThumbnails ******************************************************************************** @@ -151,7 +159,7 @@ Boolean. ---- -.. _epsSaveOptions.overprint: +.. _jsobjref/epsSaveOptions.overprint: epsSaveOptions.overprint ******************************************************************************** @@ -160,15 +168,17 @@ epsSaveOptions.overprint **Description** -Whether to preserve, discard, or simulate the overprint. Default: ``PDFOverprint.PRESERVEPDFOVERPRINT``. +Whether to preserve, discard, or simulate the overprint. + +Default: ``PDFOverprint.PRESERVEPDFOVERPRINT``. **Type** -// todo: link to **PDFOverprint** in Chapter 2 "Scripting Constants" +:ref:`jsobjref/pDFOverprint` ---- -.. _epsSaveOptions.postScript: +.. _jsobjref/epsSaveOptions.postScript: epsSaveOptions.postScript ******************************************************************************** @@ -177,15 +187,17 @@ epsSaveOptions.postScript **Description** -PostScript Language Level to use (Level 1 valid for file format version 8 or older). Default: ``EPSPostScriptLevelEnum.LEVEL2``. +PostScript Language Level to use (Level 1 valid for file format version 8 or older). + +Default: ``EPSPostScriptLevelEnum.LEVEL2``. **Type** -// todo: link to **EPSPostScriptLevelEnum** in Chapter 2 "Scripting Constants" +:ref:`jsobjref/ePSPostScriptLevelEnum` ---- -.. _epsSaveOptions.preview: +.. _jsobjref/epsSaveOptions.preview: epsSaveOptions.preview ******************************************************************************** @@ -198,11 +210,11 @@ The format for the EPS preview image. **Type** -// todo: link to **EPSPreview** in Chapter 2 "Scripting Constants" +:ref:`jsobjref/ePSPreview` ---- -.. _epsSaveOptions.saveMultipleArtboards: +.. _jsobjref/epsSaveOptions.saveMultipleArtboards: epsSaveOptions.saveMultipleArtboards ******************************************************************************** @@ -211,7 +223,9 @@ epsSaveOptions.saveMultipleArtboards **Description** -If ``true``, all artboards or range of artboards are saved. Default: ``false``. +If ``true``, all artboards or range of artboards are saved. + +Default: ``false``. **Type** @@ -219,7 +233,7 @@ Boolean. ---- -.. _epsSaveOptions.typename: +.. _jsobjref/epsSaveOptions.typename: epsSaveOptions.typename ******************************************************************************** @@ -257,8 +271,8 @@ Exporting to EPS format saveDoc = app.activeDocument; } - var saveOpts = new EPSSaveOptions(); + var saveOpts = new ePSSaveOptions(); saveOpts.cmykPostScript = true; saveOpts.embedAllFonts = true; saveDoc.saveAs( newFile, saveOpts ); - } \ No newline at end of file + } diff --git a/docs/jsobjref/exportOptionsAutoCAD.rst b/docs/jsobjref/exportOptionsAutoCAD.rst index faeb768..32c61ab 100644 --- a/docs/jsobjref/exportOptionsAutoCAD.rst +++ b/docs/jsobjref/exportOptionsAutoCAD.rst @@ -7,9 +7,12 @@ Export Options AutoCAD **Description** -Options for exporting a document as an AutoCAD file, used with the `exportFile `__ method. All properties are optional. +Options for exporting a document as an AutoCAD file, used with the :ref:`jsobjref/document.exportFile` method. +All properties are optional. -When you export a document, a file extension is appended automatically. You should not include any file extension in the file specification. To override the default AutoCAD export format (DWG), use the `exportFileFormat <#exportoptionsautocad-exportfileformat>`__ property. +When you export a document, a file extension is appended automatically. You should not include any file extension in the file specification. + +To override the default AutoCAD export format (DWG), use the :ref:`jsobjref/exportOptionsAutoCAD.exportFileFormat` property. ---- @@ -17,7 +20,7 @@ When you export a document, a file extension is appended automatically. You shou Properties ========== -.. _exportOptionsAutoCAD.alterPathsForAppearance: +.. _jsobjref/exportOptionsAutoCAD.alterPathsForAppearance: exportOptionsAutoCAD.alterPathsForAppearance ******************************************************************************** @@ -26,7 +29,9 @@ exportOptionsAutoCAD.alterPathsForAppearance **Description** -If ``true``, paths are altered if needed to maintain appearance. Default: ``false``. +If ``true``, paths are altered if needed to maintain appearance. + +Default: ``false``. **Type** @@ -34,7 +39,7 @@ Boolean. ---- -.. _exportOptionsAutoCAD.colors: +.. _jsobjref/exportOptionsAutoCAD.colors: exportOptionsAutoCAD.colors ******************************************************************************** @@ -47,11 +52,11 @@ The colors exported into the AutoCAD file. **Type** -// todo: link to **AutoCADColors** in Chapter 2 "Scripting Constants" +:ref:`jsobjref/autoCADColors` ---- -.. _exportOptionsAutoCAD.convertTextToOutlines: +.. _jsobjref/exportOptionsAutoCAD.convertTextToOutlines: exportOptionsAutoCAD.convertTextToOutlines ******************************************************************************** @@ -60,7 +65,9 @@ exportOptionsAutoCAD.convertTextToOutlines **Description** -If ``true``, text is converted to vector paths; preserves the visual appearance of type. Default: ``false``. +If ``true``, text is converted to vector paths; preserves the visual appearance of type. + +Default: ``false``. **Type** @@ -68,7 +75,7 @@ Boolean. ---- -.. _exportOptionsAutoCAD.exportFileFormat: +.. _jsobjref/exportOptionsAutoCAD.exportFileFormat: exportOptionsAutoCAD.exportFileFormat ******************************************************************************** @@ -77,15 +84,17 @@ exportOptionsAutoCAD.exportFileFormat **Description** -The format to which the file is exported. Default: ``AutoCADExportFileFormat.DWG``. +The format to which the file is exported. + +Default: ``AutoCADExportFileFormat.DWG``. **Type** -// todo: link to **AutoCADExportFileFormat** in Chapter 2 "Scripting Constants" +:ref:`jsobjref/autoCADExportFileFormat` ---- -.. _exportOptionsAutoCAD.exportOption: +.. _jsobjref/exportOptionsAutoCAD.exportOption: exportOptionsAutoCAD.exportOption ******************************************************************************** @@ -94,15 +103,17 @@ exportOptionsAutoCAD.exportOption **Description** -Specifies whether to preserve appearance or editability during export. Default: ``AutoCADExportOption.MaximizeEditability``. +Specifies whether to preserve appearance or editability during export. + +Default: ``AutoCADExportOption.MaximizeEditability``. **Type** -// todo: link to **AutoCADExportOption** in Chapter 2 "Scripting Constants" +:ref:`jsobjref/autoCADExportOption` ---- -.. _exportOptionsAutoCAD.exportSelectedArtOnly: +.. _jsobjref/exportOptionsAutoCAD.exportSelectedArtOnly: exportOptionsAutoCAD.exportSelectedArtOnly ******************************************************************************** @@ -111,7 +122,9 @@ exportOptionsAutoCAD.exportSelectedArtOnly **Description** -If ``true``, only selected artwork is exported. Default: ``false``. +If ``true``, only selected artwork is exported. + +Default: ``false``. **Type** @@ -119,7 +132,7 @@ Boolean. ---- -.. _exportOptionsAutoCAD.rasterFormat: +.. _jsobjref/exportOptionsAutoCAD.rasterFormat: exportOptionsAutoCAD.rasterFormat ******************************************************************************** @@ -132,11 +145,11 @@ The format in which raster art is exported. **Type** -// todo: link to **AutoCADRasterFormat** in Chapter 2 "Scripting Constants" +:ref:`jsobjref/autoCADRasterFormat` ---- -.. _exportOptionsAutoCAD.scaleLineweights: +.. _jsobjref/exportOptionsAutoCAD.scaleLineweights: exportOptionsAutoCAD.scaleLineweights ******************************************************************************** @@ -145,7 +158,9 @@ exportOptionsAutoCAD.scaleLineweights **Description** -If ``true``, line weights are scaled by the same scaling factor as the rest of the drawing. Default: ``false``. +If ``true``, line weights are scaled by the same scaling factor as the rest of the drawing. + +Default: ``false``. **Type** @@ -153,7 +168,7 @@ Boolean. ---- -.. _exportOptionsAutoCAD.typename: +.. _jsobjref/exportOptionsAutoCAD.typename: exportOptionsAutoCAD.typename ******************************************************************************** @@ -170,7 +185,7 @@ String, read-only. ---- -.. _exportOptionsAutoCAD.unit: +.. _jsobjref/exportOptionsAutoCAD.unit: exportOptionsAutoCAD.unit ******************************************************************************** @@ -183,11 +198,11 @@ The measurement units from which to map. **Type** -// todo: link to **AutoCADUnit** in Chapter 2 "Scripting Constants" +:ref:`jsobjref/autoCADUnit` ---- -.. _exportOptionsAutoCAD.unitScaleRatio: +.. _jsobjref/exportOptionsAutoCAD.unitScaleRatio: exportOptionsAutoCAD.unitScaleRatio ******************************************************************************** @@ -196,7 +211,9 @@ exportOptionsAutoCAD.unitScaleRatio **Description** -The ratio (as a percentage) by which output is scaled. Range: 0 to 1000 +The ratio (as a percentage) by which output is scaled. + +Range: 0 to 1000 **Type** @@ -204,7 +221,7 @@ Number (double). ---- -.. _exportOptionsAutoCAD.version: +.. _jsobjref/exportOptionsAutoCAD.version: exportOptionsAutoCAD.version ******************************************************************************** @@ -213,10 +230,10 @@ exportOptionsAutoCAD.version **Description** -The release of AutoCAD to which the file is exported. Default: ``AutoCADCompatibility.AutoCADRelease24``. +The release of AutoCAD to which the file is exported. -**Type** +Default: ``AutoCADCompatibility.AutoCADRelease24``. -// todo: link to **AutoCADCompatibility** in Chapter 2 "Scripting Constants" +**Type** ----- \ No newline at end of file +:ref:`jsobjref/autoCADCompatibility`