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

Add a Powershell cmdlet to generate documentation #48

Closed
x97mdr opened this issue Dec 5, 2011 · 13 comments
Closed

Add a Powershell cmdlet to generate documentation #48

x97mdr opened this issue Dec 5, 2011 · 13 comments
Labels
Milestone

Comments

@x97mdr
Copy link
Owner

x97mdr commented Dec 5, 2011

In order to run pickles from Powershell scripts (like psake)
As a Pickles user
I want to have a powershell module with a cmdlet that I can import and use to generate documentation.

A good reference on making a Powershell module from a C# assembly is here: http://blogs.msdn.com/b/saveenr/archive/2010/03/08/how-to-create-a-powershell-2-0-module-and-cmdlet-with-visual-studio-2010-screencast-included.aspx

@marcusoftnet
Copy link
Contributor

Yeah - that looks great. Give me a last chance then ;). I'll
Try to look into this.

I suggest that this is the default way of interacting with pickles and hence comes with the standard Pickles package.
Thoughts on that?

@x97mdr
Copy link
Owner Author

x97mdr commented Dec 5, 2011

I would agree, Powershell is more widely known and is a great toolset.
When this becomes available we use it as the default means of generating
documentation.

On Mon, Dec 5, 2011 at 11:57 AM, Marcus Hammarberg <
reply@reply.github.com

wrote:

Yeah - that looks great. Give me a last chance then ;). I'll
Try to look into this.

I suggest that this is the default way of interacting with pickles and
hence comes with the standard Pickles package.
Thoughts on that?


Reply to this email directly or view it on GitHub:
#48 (comment)

@marcusoftnet
Copy link
Contributor

Saw that PowerShell only supports .Net 3.5. So we get some problems to call into a 4.0 assembly.

Any problems with "downgrading" the projects to 3.5? Any dynamics being used there?

@marcusoftnet
Copy link
Contributor

Doh! Just realized (after trying to switch to 3.5) that this is a major problem!

I'll do some more checking for PowerShell and .NET 4.0 and see if we can get around it that way

@x97mdr
Copy link
Owner Author

x97mdr commented Dec 6, 2011

I seem to recall that this was an issue, but I cannot remember using any
specific .NET4 features ... ?

On Tue, Dec 6, 2011 at 2:11 PM, Marcus Hammarberg <
reply@reply.github.com

wrote:

Doh! Just realized (after trying to switch to 3.5) that this is a major
problem!

I'll do some more checking for PowerShell and .NET 4.0 and see if we can
get around it that way


Reply to this email directly or view it on GitHub:
#48 (comment)

@marcusoftnet
Copy link
Contributor

Got my hacking evening destroyed by a screaming kid. I'll look into this some more. There were some problems but I went over it very fast.

Probably no biggie

/Marcus Hammarberg
www.marcusoft.net
Skickat från Marcus iPhone

7 dec 2011 kl. 00:18 skrev x97mdrreply@reply.github.com:

I seem to recall that this was an issue, but I cannot remember using any
specific .NET4 features ... ?

On Tue, Dec 6, 2011 at 2:11 PM, Marcus Hammarberg <
reply@reply.github.com

wrote:

Doh! Just realized (after trying to switch to 3.5) that this is a major
problem!

I'll do some more checking for PowerShell and .NET 4.0 and see if we can
get around it that way


Reply to this email directly or view it on GitHub:
#48 (comment)


Reply to this email directly or view it on GitHub:
#48 (comment)

@x97mdr
Copy link
Owner Author

x97mdr commented Dec 7, 2011

no worries, thank you for the time spent on it! I think I'm going to work
on Word format as the next implementation. Any other ideas as to what
should be the next format to support?

On Wed, Dec 7, 2011 at 1:30 AM, Marcus Hammarberg <
reply@reply.github.com

wrote:

Got my hacking evening destroyed by a screaming kid. I'll look into this
some more. There were some problems but I went over it very fast.

Probably no biggie

/Marcus Hammarberg
www.marcusoft.net
Skickat frn Marcus iPhone

7 dec 2011 kl. 00:18 skrev x97mdrreply@reply.github.com:

I seem to recall that this was an issue, but I cannot remember using any
specific .NET4 features ... ?

On Tue, Dec 6, 2011 at 2:11 PM, Marcus Hammarberg <
reply@reply.github.com

wrote:

Doh! Just realized (after trying to switch to 3.5) that this is a major
problem!

I'll do some more checking for PowerShell and .NET 4.0 and see if we can
get around it that way


Reply to this email directly or view it on GitHub:
#48 (comment)


Reply to this email directly or view it on GitHub:
#48 (comment)


Reply to this email directly or view it on GitHub:
#48 (comment)

@marcusoftnet
Copy link
Contributor

I would think that PDF would be best after that.

But I've also have my thoughts on JSON and an one-page interactive webpage driven by JavaScript that operate on the JSON data. Would that be hard?

With JSON data it could also be simple to export to other systems etc.

What do you think?

@x97mdr
Copy link
Owner Author

x97mdr commented Dec 9, 2011

I was thinking about that. I got a short email from Gojko about being able to searcha dn filter the documentation on various criteria. To do so we would need JSON storage I think. It would work kind of like TiddlyWiki with all of the info in one file and various bits of functionality on top? Maybe we could even use a cool Javascript MVC framework to work it all up! ;)

@marcusoftnet
Copy link
Contributor

Exactly - we simply point to a CDN'ed version of KnockIut.js for example.

The "app" is a simple HTML-file that include the JSON-structure. So if anybody wants to they can replace the HTML to suit their style.

I've "proved" that it works in another project.

/Marcus Hammarberg
www.marcusoft.net
Skickat från Marcus iPhone

9 dec 2011 kl. 03:11 skrev x97mdrreply@reply.github.com:

I was thinking about that. I got a short email from Gojko about being able to searcha dn filter the documentation on various criteria. To do so we would need JSON storage I think. It would work kind of like TiddlyWiki with all of the info in one file and various bits of functionality on top? Maybe we could even use a cool Javascript MVC framework to work it all up! ;)


Reply to this email directly or view it on GitHub:
#48 (comment)

@x97mdr
Copy link
Owner Author

x97mdr commented Dec 9, 2011

On Fri, Dec 9, 2011 at 6:30 AM, Marcus Hammarberg <
reply@reply.github.com

wrote:

Exactly - we simply point to a CDN'ed version of KnockIut.js for example.

The "app" is a simple HTML-file that include the JSON-structure. So if
anybody wants to they can replace the HTML to suit their style.

I've "proved" that it works in another project.

/Marcus Hammarberg
www.marcusoft.net
Skickat frn Marcus iPhone

9 dec 2011 kl. 03:11 skrev x97mdrreply@reply.github.com:

I was thinking about that. I got a short email from Gojko about being
able to searcha dn filter the documentation on various criteria. To do so
we would need JSON storage I think. It would work kind of like TiddlyWiki
with all of the info in one file and various bits of functionality on top?
Maybe we could even use a cool Javascript MVC framework to work it all up!
;)


Reply to this email directly or view it on GitHub:
#48 (comment)


Reply to this email directly or view it on GitHub:
#48 (comment)

@x97mdr
Copy link
Owner Author

x97mdr commented Dec 9, 2011

That would greatly improve the ability to redistribute the package as well
... Having only one (or a couple) of files would be awesome. Hrm, I'm
going to add this as an issue on Github right now

On Fri, Dec 9, 2011 at 8:21 AM, Jeffrey Cameron jeffreycameron@gmail.comwrote:

On Fri, Dec 9, 2011 at 6:30 AM, Marcus Hammarberg <
reply@reply.github.com

wrote:

Exactly - we simply point to a CDN'ed version of KnockIut.js for example.

The "app" is a simple HTML-file that include the JSON-structure. So if
anybody wants to they can replace the HTML to suit their style.

I've "proved" that it works in another project.

/Marcus Hammarberg
www.marcusoft.net
Skickat frn Marcus iPhone

9 dec 2011 kl. 03:11 skrev x97mdrreply@reply.github.com:

I was thinking about that. I got a short email from Gojko about being
able to searcha dn filter the documentation on various criteria. To do so
we would need JSON storage I think. It would work kind of like TiddlyWiki
with all of the info in one file and various bits of functionality on top?
Maybe we could even use a cool Javascript MVC framework to work it all up!
;)


Reply to this email directly or view it on GitHub:
#48 (comment)


Reply to this email directly or view it on GitHub:
#48 (comment)

@x97mdr
Copy link
Owner Author

x97mdr commented Dec 9, 2011

aaaaaand here it is: ) #49

On Fri, Dec 9, 2011 at 8:22 AM, Jeffrey Cameron jeffreycameron@gmail.comwrote:

That would greatly improve the ability to redistribute the package as well
... Having only one (or a couple) of files would be awesome. Hrm, I'm
going to add this as an issue on Github right now

On Fri, Dec 9, 2011 at 8:21 AM, Jeffrey Cameron jeffreycameron@gmail.comwrote:

On Fri, Dec 9, 2011 at 6:30 AM, Marcus Hammarberg <
reply@reply.github.com

wrote:

Exactly - we simply point to a CDN'ed version of KnockIut.js for example.

The "app" is a simple HTML-file that include the JSON-structure. So if
anybody wants to they can replace the HTML to suit their style.

I've "proved" that it works in another project.

/Marcus Hammarberg
www.marcusoft.net
Skickat frn Marcus iPhone

9 dec 2011 kl. 03:11 skrev x97mdrreply@reply.github.com:

I was thinking about that. I got a short email from Gojko about being
able to searcha dn filter the documentation on various criteria. To do so
we would need JSON storage I think. It would work kind of like TiddlyWiki
with all of the info in one file and various bits of functionality on top?
Maybe we could even use a cool Javascript MVC framework to work it all up!
;)


Reply to this email directly or view it on GitHub:
#48 (comment)


Reply to this email directly or view it on GitHub:
#48 (comment)

x97mdr pushed a commit that referenced this issue Dec 13, 2011
…support for all outputs to the build script
@x97mdr x97mdr closed this as completed Dec 13, 2011
marcusoftnet referenced this issue in marcusoftnet/pickles Jul 29, 2013
Nunit now handles inconclusive tests and marks them with yellow mark
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants