Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use pageId instead of Spacekey and parent title #107

Closed
muchino opened this issue Jun 20, 2016 · 11 comments
Closed

Use pageId instead of Spacekey and parent title #107

muchino opened this issue Jun 20, 2016 · 11 comments
Assignees
Milestone

Comments

@muchino
Copy link

muchino commented Jun 20, 2016

Hi

At all let me say Thank you for this maven plugin I just added this plugin to our maven Archetypes to generate our documentation in the future in a better way.

While I tested the plugin there came up the question in my mind "what should I do if the parent page will be renamed" ok editing the pom again.

But wouldn't it be nice to just use the pageId (maybe in a special "usepageid=true" mode.

So we can save us to define the Spacekey and the page title which can contain special characaters.

What do you think about this?

Cheers
Oli

@bsorrentino bsorrentino self-assigned this Jun 20, 2016
@bsorrentino bsorrentino added this to the 4.10 milestone Jun 20, 2016
@bsorrentino
Copy link
Owner

bsorrentino commented Jun 20, 2016

Hi, thx for interest

It's a good technical enhancement ... my opinion is that i would like preserve readability of plugin configuration itself and ... using ID probably it will not

However i think that it could be implemented in 2 ways:

  1. Adding new parameter parentPageId
  2. As fallback strategy of parentPageTitle (if doesn't find title assume that it is an ID)

I'll add such feature as soon as possible (4.10)

What do u think about ?

@muchino
Copy link
Author

muchino commented Jun 21, 2016

Sound great :) I think the new parameter would be the best solution if you like to persist both name of the parameters.

So you can define in your documentation: "If you configure the parentPageTitle, you need to specify the spaceKey. If you use the parentPageId, the spaceKey isn't needed anymore".

And Because of the "Title" in the name of the parameter parentPageTitle, it can be confusing that the pageId is working there too.

@bsorrentino
Copy link
Owner

agree

however, in the case of providing parentPageId i get the parent page title in order to use it as prefix (unless the childrenTitlesPrefixed is false)

@muchino
Copy link
Author

muchino commented Jun 21, 2016

sry - now I can't follow you :(

@bsorrentino
Copy link
Owner

I've deployed release 4.10-SNAPSHOT with fix.
Now is available the argument parentPageId, please test it and le me know

@muchino
Copy link
Author

muchino commented Jun 27, 2016

what should I need to to to use the snapshot? where is the repository

@bsorrentino
Copy link
Owner

the snapshot repo is here

to configure in maven

<pluginRepositories>

    <!-- IF YOU WANT STAY TUNED ON UPDATE REMOVE COMMENT -->
    <pluginRepository>
        <id>sonatype-repo</id>
        <url>https://oss.sonatype.org/content/repositories/snapshots</url>
        <releases>
            <enabled>false</enabled>
        </releases>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </pluginRepository>

</pluginRepositories>

@muchino
Copy link
Author

muchino commented Jun 28, 2016

works - cool :)

what is now the order if both is added?
If pageID is present - this one is used ?

@bsorrentino
Copy link
Owner

Hi, Thanks for feedback

If both are present pageID has priority (beeing more efficient)

I'll arrange official release soon

@bsorrentino
Copy link
Owner

I've released the release 4.10

@muchino
Copy link
Author

muchino commented Jul 1, 2016

Thank you!
Am 01.07.2016 12:15 schrieb "bsorrentino" notifications@github.com:

Closed #107
#107.


You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
#107 (comment),
or mute the thread
https://github.com/notifications/unsubscribe/ABM9tYUildVovEoScdwQRnYqHbKureYbks5qROipgaJpZM4I56JU
.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants