Questions about options in *Filter Streams Converter* and possibles typos ? (In XWiki LTS 15.10.11)

Help / Discuss
, ,
1

Hello,
this time I am about to dive into importing several spaces one after the other and calculate how long this will take.

However I am not quite ready for a marathon yet, as I am preparing the initial setup in the Filter Streams Converter application options.

I have done it before, I have even kept a PDF printed from several previous XWiki editions used and tested, which allows me to observe differences between the versions such as new options bringing some thinking.

I have stumbled upon two options in which a sentence seems wrong, perhaps due to a typo in the comment of the option. Here is what it looks like:

Max page count 
The maximum number of pages to import (-1 means to limit) int 
[field with default option -1]

I wonder if the text in parenthesis should rather be “(-1 means no limit)” ?

Here I read:

Users wiki 
The wiki is which users and groups are located. If applicable, users will be imported in this wiki; any user reference, including ones in permissions, will include this wiki. java.lang.String

At first I didn’t understand the sentence The wiki is which users and groups are located. What does it mean? Then I thought maybe what is meant here would rather be The wiki in which users and groups are located.

Am I right? Is there a typo in each of these two options comments?

And I have a question about one of the new options added in this version:

Target 
The target where to save the content org.xwiki.filter.output.OutputTarget Supported format is file:<path in server> (e.g. file:/home/myuser/target.xml). When empty it send a file named target to the browser.

As I am about to import a zipped XML Confluence space, and didn’t see this option before, I don’t know what to make of it and what to do or how to use it. What is org.xwiki.filter.output.OutputTarget exactly?

About XWiki output options, what do the other XWiki outputs do exactly, compared to the first option selected in the screenshot below ? Don’t we want everything imported from the Confluence export spaces?
8-Import-Confluence-XWiki-output-options

About this option:
Store Confluence details 
Store Confluence details in each migrated page 
boolean

What kind of details could it be, what specific situation might it refer to?

This one isn’t very clear either:

Produce user references 
Indicate if the links to users should produce links to XWiki users profile pages or use the "user:" prefix. 
boolean

If we leave the default option which is set to false, then what does the "user:" prefix do? And what about personal pages in the wiki? Is that also a possible choice?

Thanks for your help!

2

Indeed, sounds like it.

Yes, definitely.

You might want to report BUG issues on Loading.... And if you feel like providing a pull request for those, you can find them in confluence/confluence-xml/src/main/java/org/xwiki/contrib/confluence/filter/input/ConfluenceInputProperties.java at master · xwiki-contrib/confluence · GitHub.

I think you are not looking at the right output filter actually. The job of the one you are showing is to produce a generic XML representation of what the input filter has interpreted. For an import I would have expected you to use the Instance output filter, as described on https://extensions.xwiki.org/xwiki/bin/view/Extension/Confluence/XML/#HTutorial (since your goal seems to be to import a Confluence package).

3

Hi @jmarkoll,

This option stores an XWiki object that contains technical information about the document from confluence, including its id. I encourage you to set this to true if you plan to use this information to fix up links after migrating, or support such features like CQL macros that can reference page ids.

Am I right? Is there a typo in each of these two options comments?

Yep, we need to fix this. Thanks for noticing and telling us.

I’m not sure what are the consequences of changing this parameter, I would leave the default.

About XWiki output options, what do the other XWiki outputs do exactly, compared to the first option selected in the screenshot below ? Don’t we want everything imported from the Confluence export spaces?

We do, and the other options are mostly there for either technical reasons, or for other use cases. When using the Confluence migrator, you most likely want to use xwiki+instance which produces everything we support in the wiki.

4

By the way, @jmarkoll, make sure you don’t miss our documentation on the input parameters: https://extensions.xwiki.org/xwiki/bin/view/Extension/Confluence/XML/#HInputparametersdocumentation

5

Hello Thomas,
here is my bug report, I hope I did it right : Loading...

I won’t do a pull request, this would need me to learn how to do that (and to do it the right way), and I can’t take that time as I am just an employee.

6

I have gone throught the documentation on the input parameters, for sure! I did several times. :slight_smile:

7

Alright thank you! One more question : What are CQL macros?

8

Do you think this:

Screenshot 2024-07-26 at 14-40-30 XWiki
Screenshot 2024-07-26 at 14-40-30 XWiki1370Ă—66 2.77 KB

could be setup to be frozen at the top of the page, while scrolling down the page?

PS: having vertical lines in XWiki tables (borders for cells) would be easier to read…

9

Hi,
sorry, I only see your questions now. CQL macros would be macros compatible with Confluence macros and that uses their custom query language called CQL.

10

The question is worth its own forum post or ticket :slight_smile:

1 Like
11

Done! Input Parameters documentation (suggestion)