Изменения документа Document Tree Macros
Редактировал(а) Андрей Ганьков 2026/01/23 10:50
От версии 1.1
отредактировано superadmin
на 2020/10/06 10:50
на 2020/10/06 10:50
Изменить комментарий:
Install extension [org.xwiki.platform:xwiki-platform-index-tree-macro/12.8]
К версии 8.1
отредактировано Андрей Ганьков
на 2026/01/23 10:50
на 2026/01/23 10:50
Изменить комментарий:
Install extension [org.xwiki.platform:xwiki-platform-index-tree-macro/17.10.2]
Сводка
-
Свойства страницы (2 изменено, 0 добавлено, 0 удалено)
Подробности
- Свойства страницы
-
- Автор документа
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. superadmin1 +xwiki:XWiki.gav - Содержимое
-
... ... @@ -31,9 +31,15 @@ 31 31 #end 32 32 ## Handle relative references 33 33 #makeNodeReferencesAbsolute($docTreeConfig ['root', 'openTo']) 34 - ## Sort the child documents by (raw) title when the node label is the document title. 35 - #if ($docTreeConfig.showDocumentTitle) 36 - #set ($docTreeConfig.orderBy = 'title') 34 + ## FIXME: The 'orderBy' property of the tree API is shared by all tree node types, which means we can't indicate a 35 + ## different sort field per tree node type (e.g. sort wiki nodes by name and document nodes by last modification 36 + ## date). At the same time, this property is currently taken into account only for sorting document tree nodes, so for 37 + ## now we set its value to the specified document sort. In the future we may want to convert this into a map, where 38 + ## the key is the node type. 39 + #set ($docTreeConfig.orderBy = $docTreeConfig.sortDocumentsBy) 40 + ## Sort the child documents by (raw) title when the node label is the document title and there's no sort specified. 41 + #if ($docTreeConfig.showDocumentTitle && "$!docTreeConfig.orderBy" == '') 42 + #set ($docTreeConfig.orderBy = 'title:asc') 37 37 #end 38 38 ## Determine which hierarchy needs to be used. 39 39 #if ($docTreeConfig.showSpaces) ... ... @@ -76,7 +76,11 @@ 76 76 #macro (handleDocumentTreeRequest) 77 77 #if ($request.action) 78 78 #if ($services.csrf.isTokenValid($request.form_token)) 79 - $response.sendError(400, 'The specified action is not supported.') 85 + #if ($request.action == 'create' && $request.type == 'addDocument') 86 + #handleNewNodeCreationRequest() 87 + #else 88 + $response.sendError(400, 'The specified action is not supported.') 89 + #end 80 80 #elseif ($isAjaxRequest) 81 81 $response.sendError(403, 'The CSRF token is missing.') 82 82 #else ... ... @@ -102,6 +102,22 @@ 102 102 #end 103 103 #end 104 104 115 +#macro (handleNewNodeCreationRequest) 116 + #set ($cleanId = $stringtool.substring($request.id, $stringtool.length('document:'))) 117 + #set ($parentReference = $services.model.resolveDocument($cleanId)) 118 + #set ($requestedName = $request.name) 119 + #set ($transformedName = $services.modelvalidation.transformName($requestedName)) 120 + #set ($spaceReference = $services.model.createSpaceReference($transformedName, $parentReference.lastSpaceReference)) 121 + #set ($documentReference = $services.model.createDocumentReference('WebHome', $spaceReference)) 122 + #set ($data = []) 123 + #addDocumentNode($documentReference, $data) 124 + ## We want to allow opening the node to add another hierarchy. 125 + #set ($data[0].children = true) 126 + ## We want to display the actual requested name as node name. 127 + #set ($data[0].text = $requestedName) 128 + #jsonResponse($data) 129 +#end 130 + 105 105 #macro (postProcessDocumentTreeData $data) 106 106 ## This is just a hook to allow post processing the document tree data. 107 107 #end ... ... @@ -126,6 +126,8 @@ 126 126 #set ($limit = $mathtool.max($numbertool.toNumber($request.limit).intValue(), 1)) 127 127 #if ("$!limit" == '') 128 128 #set ($limit = 15) 155 + #else 156 + #validateQueryLimit($limit) 129 129 #end 130 130 #if ($nodeId == '#' && $docTreeConfig.showRoot) 131 131 #maybeAddNode($actualNodeId $children) ... ... @@ -179,6 +179,7 @@ 179 179 180 180 #macro (maybeAddFarmNode $nodeReference $siblings) 181 181 #set ($farmHomeReference = $services.model.resolveDocument('', 'default')) 210 + #set ($isOpened = $docTreeConfig.expandToLevel > 0) 182 182 #set ($discard = $siblings.add({ 183 183 'id': 'farm:*', 184 184 'text': 'Farm', ... ... @@ -188,6 +188,9 @@ 188 188 'type': 'farm', 189 189 'validChildren': ['wiki', 'pagination'] 190 190 }, 220 + 'state': { 221 + 'opened': $isOpened 222 + }, 191 191 'a_attr': { 192 192 'href': $xwiki.getURL($farmHomeReference) 193 193 } ... ... @@ -216,6 +216,7 @@ 216 216 #else 217 217 #set ($label = $wiki.id) 218 218 #end 251 + #set ($isOpened = $docTreeConfig.expandToLevel > 0) 219 219 #set ($discard = $siblings.add({ 220 220 'id': "wiki:$wiki.id", 221 221 'text': $label, ... ... @@ -227,6 +227,9 @@ 227 227 'validChildren': ['space', 'document', 'pagination'], 228 228 'canDelete': $canDeleteWiki 229 229 }, 263 + 'state': { 264 + 'opened': $isOpened 265 + }, 230 230 'a_attr': { 231 231 'href': $xwiki.getURL($wiki.mainPageReference) 232 232 } ... ... @@ -252,6 +252,7 @@ 252 252 253 253 #macro (addSpaceNode $spaceReference $siblings) 254 254 #set ($spaceId = $services.model.serialize($spaceReference, 'default')) 291 + #set ($spaceNodeId = "space:$spaceId") 255 255 #set ($hasSpaceAdmin = $services.security.authorization.hasAccess('admin', $spaceReference)) 256 256 #set ($canViewSpace = $services.security.authorization.hasAccess('view', $spaceReference)) 257 257 #if ($docTreeConfig.showTerminalDocuments) ... ... @@ -259,10 +259,21 @@ 259 259 #set ($hasChildren = true) 260 260 #else 261 261 ## We display only the nested spaces. This space might contain only documents. 262 - #set ($hasChildren = $tree.getChildCount( "space:$spaceId") > 0)299 + #set ($hasChildren = $tree.getChildCount($spaceNodeId) > 0) 263 263 #end 301 + #set ($isOpened = false) 302 + #if ("$!docTreeConfig.expandToLevel" != '') 303 + #set ($rootNode = "wiki:$services.wiki.currentWikiId") 304 + #if ("$!docTreeConfig.root" != '') 305 + #set ($rootNode = "wiki:$services.wiki.currentWikiId") 306 + #else 307 + #set ($rootNode = $docTreeConfig.root) 308 + #end 309 + #set ($rootDistance = $tree.getPath($spaceNodeId).size()) 310 + #set ($isOpened = ($rootDistance != -1 && $docTreeConfig.expandToLevel >= $rootDistance)) 311 + #end 264 264 #set ($discard = $siblings.add({ 265 - 'id': "space:$spaceId",313 + 'id': $spaceNodeId, 266 266 'text': $spaceReference.name, 267 267 'icon': 'fa fa-folder-o', 268 268 'iconOpened': 'fa fa-folder-open-o', ... ... @@ -280,6 +280,9 @@ 280 280 'createDocumentURL': $xwiki.getURL($spaceReference, 'create', $NULL), 281 281 'deleteURL': $xwiki.getURL($spaceReference, 'deletespace', $NULL) 282 282 }, 331 + 'state': { 332 + 'opened': $isOpened 333 + }, 283 283 'a_attr': { 284 284 'href': $xwiki.getURL($spaceReference) 285 285 } ... ... @@ -305,6 +305,7 @@ 305 305 306 306 #macro (addDocumentNode $documentReference $siblings) 307 307 #set ($documentId = $services.model.serialize($documentReference, 'default')) 359 + #set ($docNodeId = "document:$documentId") 308 308 #set ($label = $documentReference.name) 309 309 #if (!$docTreeConfig.showSpaces && 310 310 $documentReference.name == $services.model.getEntityReference('DOCUMENT', 'default').name) ... ... @@ -316,18 +316,16 @@ 316 316 #if ($canViewDoc && $docTreeConfig.showDocumentTitle) 317 317 ## Display the translated title. 318 318 #set ($translatedDocument = $xwiki.getDocument($documentReference).translatedDocument) 319 - ## Make sure the displayed title is not affected by the sheet request parameter (e.g. when $translatedDocument is 320 - ## the current document). By setting the title (even if we don't change it) the internal document instance is cloned 321 - ## so it's going to be different than the current document instance (which is the target of the sheet parameter). 322 - #set ($discard = $translatedDocument.setTitle($translatedDocument.title)) 323 323 #set ($plainTitle = $translatedDocument.plainTitle) 324 324 #if (!$stringtool.isBlank($plainTitle)) 325 325 #set ($label = $plainTitle) 326 326 #end 327 327 #end 328 - #set ($hasChildren = $tree.getChildCount("document:$documentId") > 0) 376 + #set ($hasChildren = $tree.getChildCount($docNodeId) > 0) 377 + #set ($isOpened = false) 378 + #computeIsOpened($docNodeId $isOpened) 329 329 #set ($discard = $siblings.add({ 330 - 'id': "document:$documentId",380 + 'id': $docNodeId, 331 331 'text': $label, 332 332 'icon': 'fa fa-file-o', 333 333 'children': $hasChildren, ... ... @@ -342,6 +342,9 @@ 342 342 'canCopy': $canViewDoc, 343 343 'createDocumentURL': $xwiki.getURL($documentReference, 'create', $NULL) 344 344 }, 395 + 'state': { 396 + 'opened': $isOpened 397 + }, 345 345 'a_attr': { 346 346 'href': $xwiki.getURL($documentReference) 347 347 } ... ... @@ -356,14 +356,18 @@ 356 356 #end 357 357 358 358 #macro (addAddDocumentNode $documentReference $siblings) 412 + ## FIXME: This URL is wrong, it should use the $documentReference as the parent for creation of the node: 413 + ## the reference is already an existing doc, so it shouldn't be the one used for creation. 359 359 #set ($discard = $siblings.add({ 360 360 'id': "addDocument:$services.model.serialize($documentReference, 'default')", 361 - 'text': 'New page...',416 + 'text': $services.localization.render('index.documentTree.addDocument'), 362 362 'icon': 'fa fa-plus-circle', 363 363 'children': false, 364 364 'data': { 365 365 'type': 'addDocument', 366 - 'validChildren': [] 421 + 'validChildren': [], 422 + 'hasContextMenu': true, 423 + 'canRename': true 367 367 }, 368 368 'a_attr': { 369 369 'href': $xwiki.getURL($documentReference, 'create') ... ... @@ -382,9 +382,27 @@ 382 382 #end 383 383 #end 384 384 442 +#macro (computeIsOpened $docNodeId $result) 443 + #set ($isOpened = false) 444 + #if ("$!docTreeConfig.expandToLevel" != '') 445 + #set ($rootNode = "wiki:$services.wiki.currentWikiId") 446 + #if ("$!docTreeConfig.root" != '') 447 + #set ($rootNode = "wiki:$services.wiki.currentWikiId") 448 + #else 449 + #set ($rootNode = $docTreeConfig.root) 450 + #end 451 + #set ($rootDistance = $tree.getPath($docNodeId).size()) 452 + #set ($isOpened = ($rootDistance != -1 && $docTreeConfig.expandToLevel >= $rootDistance)) 453 + #end 454 + #setVariable("$result" $isOpened) 455 +#end 456 + 385 385 #macro (addTranslationsNode $documentReference $siblings) 386 - #set ($discard = $children.add({ 387 - 'id': "translations:${documentReference}", 458 + #set ($isOpened = false) 459 + #set ($docNodeId = "translations:${documentReference}") 460 + #computeIsOpened($docNodeId $isOpened) 461 + #set ($discard = $siblings.add({ 462 + 'id': $docNodeId, 388 388 'text': 'Translations', 389 389 'icon': 'fa fa-language', 390 390 'children': true, ... ... @@ -392,6 +392,9 @@ 392 392 'type': 'translations', 393 393 'validChildren': ['translation'], 394 394 'canDelete': $services.security.authorization.hasAccess('delete', $documentReference) 470 + }, 471 + 'state': { 472 + 'opened': $isOpened 395 395 } 396 396 })) 397 397 #end ... ... @@ -408,8 +408,11 @@ 408 408 409 409 #macro (addTranslationNode $translationReference $siblings) 410 410 #set ($currentLocale = $services.localization.currentLocale) 489 + #set ($isOpened = false) 490 + #set ($docNodeId = "translation:$services.model.serialize($translationReference, 'default')_$translationReference.locale") 491 + #computeIsOpened($docNodeId $isOpened) 411 411 #set ($discard = $siblings.add({ 412 - 'id': "translation:$services.model.serialize($translationReference, 'default')_$translationReference.locale",493 + 'id': $docNodeId, 413 413 'text': $translationReference.locale.getDisplayName($currentLocale), 414 414 'icon': 'fa fa-file-text-o', 415 415 'children': false, ... ... @@ -420,6 +420,9 @@ 420 420 }, 421 421 'a_attr': { 422 422 'href': $xwiki.getURL($translationReference) 504 + }, 505 + 'state': { 506 + 'opened': $isOpened 423 423 } 424 424 })) 425 425 #end ... ... @@ -436,8 +436,11 @@ 436 436 #end 437 437 438 438 #macro (addAttachmentsNode $documentReference $siblings) 523 + #set ($isOpened = false) 524 + #set ($docNodeId = "attachments:${documentReference}") 525 + #computeIsOpened($docNodeId $isOpened) 439 439 #set ($discard = $siblings.add({ 440 - 'id': "attachments:${documentReference}",527 + 'id': $docNodeId, 441 441 'text': 'Attachments', 442 442 'icon': 'fa fa-paperclip', 443 443 'children': true, ... ... @@ -449,6 +449,9 @@ 449 449 }, 450 450 'a_attr': { 451 451 'href': $xwiki.getURL($documentReference, 'view', 'viewer=attachments') 539 + }, 540 + 'state': { 541 + 'opened': $isOpened 452 452 } 453 453 })) 454 454 #end ... ... @@ -468,8 +468,11 @@ 468 468 #set ($attachmentId = $services.model.serialize($attachmentReference, 'default')) 469 469 #set ($canEditDoc = $services.security.authorization.hasAccess('edit', $attachmentReference.parent)) 470 470 #getAttachmentIcon($attachment $icon) 561 + #set ($isOpened = false) 562 + #set ($docNodeId = "attachment:$attachmentId") 563 + #computeIsOpened($docNodeId $isOpened) 471 471 #set ($discard = $siblings.add({ 472 - 'id': "attachment:$attachmentId",565 + 'id': $docNodeId, 473 473 'text': $attachment.filename, 474 474 'icon': $icon, 475 475 'children': false, ... ... @@ -483,10 +483,14 @@ 483 483 'canDelete': $canEditDoc, 484 484 'canMove': $canEditDoc, 485 485 'canCopy': true, 486 - 'deleteURL': $attachment.document.getAttachmentURL($attachment.filename, 'delattachment') 579 + 'deleteURL': $attachment.document.getAttachmentURL($attachment.filename, 'delattachment'), 580 + 'mimetype': $attachment.mimeType 487 487 }, 488 488 'a_attr': { 489 489 'href': $attachment.document.getAttachmentURL($attachment.filename) 584 + }, 585 + 'state': { 586 + 'opened': $isOpened 490 490 } 491 491 })) 492 492 #end ... ... @@ -565,8 +565,11 @@ 565 565 #end 566 566 567 567 #macro (addClassPropertiesNode $documentReference $siblings) 568 - #set ($discard = $children.add({ 569 - 'id': "classProperties:${documentReference}", 665 + #set ($isOpened = false) 666 + #set ($docNodeId = "classProperties:${documentReference}") 667 + #computeIsOpened($docNodeId $isOpened) 668 + #set ($discard = $siblings.add({ 669 + 'id': $docNodeId, 570 570 'text': 'Class Properties', 571 571 'icon': 'fa fa-gears', 572 572 'children': true, ... ... @@ -574,6 +574,9 @@ 574 574 'type': 'classProperties', 575 575 'validChildren': ['classProperty'], 576 576 'canDelete': $services.security.authorization.hasAccess('edit', $documentReference) 677 + }, 678 + 'state': { 679 + 'opened': $isOpened 577 577 } 578 578 })) 579 579 #end ... ... @@ -606,8 +606,11 @@ 606 606 #if (!$icon) 607 607 #set ($icon = 'gear') 608 608 #end 712 + #set ($isOpened = false) 713 + #set ($docNodeId = "classProperty:$classPropertyId") 714 + #computeIsOpened($docNodeId $isOpened) 609 609 #set ($discard = $siblings.add({ 610 - 'id': "classProperty:$classPropertyId",716 + 'id': $docNodeId, 611 611 'text': $property.name, 612 612 'icon': "fa fa-$icon", 613 613 'children': false, ... ... @@ -615,6 +615,9 @@ 615 615 'id': $classPropertyId, 616 616 'type': 'classProperty', 617 617 'validChildren': [] 724 + }, 725 + 'state': { 726 + 'opened': $isOpened 618 618 } 619 619 })) 620 620 #end ... ... @@ -631,8 +631,11 @@ 631 631 #end 632 632 633 633 #macro (addObjectsNode $documentReference $siblings) 634 - #set ($discard = $children.add({ 635 - 'id': "objects:${documentReference}", 743 + #set ($isOpened = false) 744 + #set ($docNodeId = "objects:${documentReference}") 745 + #computeIsOpened($docNodeId $isOpened) 746 + #set ($discard = $siblings.add({ 747 + 'id': $docNodeId, 636 636 'text': 'Objects', 637 637 'icon': 'fa fa-cubes', 638 638 'children': true, ... ... @@ -640,6 +640,9 @@ 640 640 'type': 'objects', 641 641 'validChildren': ['objectsOfType'], 642 642 'canDelete': $services.security.authorization.hasAccess('edit', $documentReference) 755 + }, 756 + 'state': { 757 + 'opened': $isOpened 643 643 } 644 644 })) 645 645 #end ... ... @@ -650,8 +650,11 @@ 650 650 #set ($documentReference = $services.model.resolveDocument($parts.get(0))) 651 651 #set ($classReference = $services.model.resolveDocument($parts.get(1))) 652 652 #if ($services.security.authorization.hasAccess('view', $documentReference)) 653 - #set ($discard = $children.add({ 654 - 'id': "objectsOfType:$documentReference/$classReference", 768 + #set ($isOpened = false) 769 + #set ($docNodeId = "objectsOfType:$documentReference/$classReference") 770 + #computeIsOpened($docNodeId $isOpened) 771 + #set ($discard = $siblings.add({ 772 + 'id': $docNodeId, 655 655 'text': $services.model.serialize($classReference, 'local'), 656 656 'icon': 'fa fa-cubes', 657 657 'children': true, ... ... @@ -659,6 +659,9 @@ 659 659 'type': 'objectsOfType', 660 660 'validChildren': ['object', 'pagination'], 661 661 'canDelete': $services.security.authorization.hasAccess('edit', $documentReference) 780 + }, 781 + 'state': { 782 + 'opened': $isOpened 662 662 } 663 663 })) 664 664 #end ... ... @@ -685,8 +685,11 @@ 685 685 686 686 #macro (addObjectNode $object $objectReference $siblings) 687 687 #set ($objectId = $services.model.serialize($objectReference, 'default')) 688 - #set ($discard = $children.add({ 689 - 'id': "object:$objectId", 809 + #set ($isOpened = false) 810 + #set ($docNodeId = "object:$objectId") 811 + #computeIsOpened($docNodeId $isOpened) 812 + #set ($discard = $siblings.add({ 813 + 'id': $docNodeId, 690 690 'text': "[$object.number]", 691 691 'icon': 'fa fa-cube', 692 692 'children': true, ... ... @@ -695,6 +695,9 @@ 695 695 'type': 'object', 696 696 'validChildren': ['objectProperty'], 697 697 'canDelete': $services.security.authorization.hasAccess('edit', $objectReference.parent) 822 + }, 823 + 'state': { 824 + 'opened': $isOpened 698 698 } 699 699 })) 700 700 #end ... ... @@ -719,8 +719,11 @@ 719 719 #end 720 720 #set ($objectPropertyReference = $services.model.createEntityReference($property.name, 'OBJECT_PROPERTY', $objRef)) 721 721 #set ($objectPropertyId = $services.model.serialize($objectPropertyReference, 'default')) 849 + #set ($isOpened = false) 850 + #set ($docNodeId = "objectProperty:$objectPropertyId") 851 + #computeIsOpened($docNodeId $isOpened) 722 722 #set ($discard = $siblings.add({ 723 - 'id': "objectProperty:$objectPropertyId",853 + 'id': $docNodeId, 724 724 'text': $property.name, 725 725 'icon': "fa fa-$icon", 726 726 'children': false, ... ... @@ -728,6 +728,9 @@ 728 728 'id': $objectPropertyId, 729 729 'type': 'objectProperty', 730 730 'validChildren': [] 861 + }, 862 + 'state': { 863 + 'opened': $isOpened 731 731 } 732 732 })) 733 733 #end ... ... @@ -1125,6 +1125,7 @@ 1125 1125 #macro (searchAttachmentsSolr $text $limit $return) 1126 1126 #set ($params = [ 1127 1127 'fq=type:ATTACHMENT', 1261 + 'fq=locale:*', 1128 1128 'qf=filename^4 attcontent', 1129 1129 'fl=type wiki spaces name filename' 1130 1130 ])