Unfortunately there is no convention. If you want the documentation to be part of the generated site, obviously `/src/site` is a good place. Maybe you can even write the documentation in the [APT](http://maven.apache.org/doxia/references/apt-format.html) format?

But more likely you have a set of `doc`, `pdf` and `xls` files, graphics, e-mails, etc. You can either place them under `/src/site` as well and put hyperlinks in the site or... define your own convention, sadly. Typically I have seen `/src/main/doc(s)`, `/src/doc(s)` or even `/doc(s)`.

You don&#39;t want to place your documentation in `/src/main/resources` or `src/main/webapp`, as the files will then be part of built artifact (JAR/WAR) which is rarely desired.

http://www.sonatype.com/books/mvnref-book/reference/site-generation-sect-dir-struct.html
recommends the following structure

    sample-project
    +- src/
    [..]
    +- resources/
    |  +- images/
    |  |  +- banner-left.png
    |  |  +- banner-right.png
    |  |
    |  +- architecture.html
    |  +- jira-roadmap-export-2007-03-26.html
    [..]

According to the [maven-javadoc-plugin][1]:

&gt; The `&lt;javadocDirectory/&gt;` parameter can be used to include additional resources, like HTML or images, in the generated javadoc. You can then link to these resources in your javadoc comments. By default, all javadoc resources are in `${basedir}/src/main/javadoc` directory. Note that you need to set the `docfilessubdirs` parameter to copy these.


  [1]: https://maven.apache.org/plugins/maven-javadoc-plugin/examples/javadoc-resources.html

I&#39;m diving into writing a mobile app with jQuery Mobile/PhoneGap. I&#39;m using [this sample template][1] to start from, which uses HTML/JS to create the pages. Rather than have all the `&lt;page&gt;` tags in one single html file, he&#39;s got it split up so it&#39;s easier to edit.

**Since I will have a separate file for each page, what&#39;s the best way to include the tempated header/footer?** I&#39;ve only seen it where you need to copy and paste the whole footer-&gt;navbar code into each HTML page. This doesn&#39;t seem like it should be. For example, if you want to change one menu item, you need to go into each page and change it. 

What&#39;s the solution that I&#39;m missing?

Maybe I&#39;m just not understanding jQuery Mobile. For example, their sidebar they use for their docs - is that sidebar code copy and pasted onto each page? That doesn&#39;t make sense. It&#39;s the same idea as the question I&#39;m asking here about the footer. 

http://jquerymobile.com/test/docs/pages/page-cache.html


This is what I&#39;ve got that doesn&#39;t seem right (and `$.live(&#39;pageinit&#39;)` isn&#39;t working). This HTML is what goes on each HTML page:

    &lt;div id=&quot;mainFooter&quot; data-position=&quot;fixed&quot; data-id=&quot;mainFooter&quot; data-role=&quot;footer&quot; class=&quot;ui-footer ui-bar-a ui-footer-fixed fade ui-fixed-inline&quot; role=&quot;contentinfo&quot; style=&quot;top: 58px;&quot;&gt;
  &lt;/div&gt;

And the JS

    $.live(&#39;pageinit&#39;, function (event) {
        displayFooter();
    });
    
    function displayFooter() {
        $(&#39;#mainFooter&#39;).html(&#39;&lt;div data-role=&quot;navbar&quot; class=&quot;nav-glyphish-example&quot; data-grid=&quot;d&quot;&gt;&#39; +
            &#39;&lt;ul&gt;&#39; +
            &#39;&lt;li&gt;&lt;a href=&quot;#&quot; id=&quot;menuitem1&quot; data-icon=&quot;custom&quot;&gt;Menu Item 1&lt;/a&gt;&lt;/li&gt;&#39; +
            &#39;&lt;li&gt;&lt;a href=&quot;#&quot; id=&quot;menuitem2&quot; data-icon=&quot;custom&quot;&gt;Menu Item 2&lt;/a&gt;&lt;/li&gt;&#39; +
            &#39;&lt;li&gt;&lt;a href=&quot;#&quot; id=&quot;menuitem3&quot; data-icon=&quot;custom&quot;&gt;Menu Item 3&lt;/a&gt;&lt;/li&gt;&#39; +
            &#39;&lt;/ul&gt;&#39; +
            &#39;&lt;/div&gt;&#39;);
    }


  [1]: http://coenraets.org/blog/2011/10/sample-application-with-jquery-mobile-and-phonegap/

Creating templated/persistant header/footer template in jQuery Mobile and PhoneGap

I&#39;m new to JS and Backbone

What&#39;s the difference between these two?

    TestModel = new Backbone.Model({ title: &quot;test title&quot; })
    TestModel = Backbone.Model.extend({ title: &quot;test title&quot; })


new Backbone.Model() vs Backbone.Model.extend()

Where should should project documentation (requirements, etc.) be stored in a typical maven project.

None of the directories listed in [Introduction to the Standard Directory Layout][1] page is an obvious candidate.


  [1]: http://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html

Where should project documentation be stored in a typical maven project

<p>Where should should project documentation (requirements, etc.) be stored in a typical maven project.</p>
<p>None of the directories listed in <a href="http://maven.apache.org/guides/introduction/introduction-to-the-standard-directory-layout.html" target="_blank" rel="noopener noreferrer">Introduction to the Standard Directory Layout</a> page is an obvious candidate.</p>


I am using Eclipse 3.7 Indigo with Maven M2E Plugin 1.0.100.

Using the JBoss 7.x JavaEE 6 EAR archetype, the pom for EAR is giving me this error:

&gt; Plugin execution not covered by lifecycle configuration:
&gt; org.apache.maven.plugins:maven-ear-plugin:2.6:generate-application-xml
&gt; (execution: default-generate-application-xml, phase:
&gt; generate-resources)

&lt;!-- language: lang-xml --&gt;

    &lt;plugin&gt;
       &lt;groupId&gt;org.apache.maven.plugins&lt;/groupId&gt;
       &lt;artifactId&gt;maven-ear-plugin&lt;/artifactId&gt;
       &lt;version&gt;2.6&lt;/version&gt;
       &lt;configuration&gt;
          &lt;!-- Tell Maven we are using Java EE 6 --&gt;
          &lt;version&gt;6&lt;/version&gt;
          &lt;!-- Use Java EE ear libraries as needed. Java EE ear libraries 
                      are in easy way to package any libraries needed in the ear, and automatically 
                      have any modules (EJB-JARs and WARs) use them --&gt;
          &lt;defaultLibBundleDir&gt;lib&lt;/defaultLibBundleDir&gt;
          &lt;modules&gt;&lt;/modules&gt;
       &lt;/configuration&gt;
    &lt;plugin&gt;

Plugin execution not covered by lifecycle configuration (JBossas 7 EAR archetype)

I don&#39;t know how to use Maven at all.  I&#39;ve been developing for a couple years with Eclipse and haven&#39;t yet needed to know about it.  However, now I&#39;m [looking at some docs][1] that suggest I do the following: 

*&quot;To include it within your project, just add this maven dependency to your build.&quot;*

    &lt;repository&gt;
       &lt;id&gt;jboss&lt;/id&gt;
       &lt;url&gt;http://repository.jboss.org/maven2&lt;/url&gt;
    &lt;/repository&gt;

       ...
    &lt;dependency&gt;
       &lt;groupId&gt;org.jboss.resteasy&lt;/groupId&gt;
       &lt;artifactId&gt;resteasy-jackson-provider&lt;/artifactId&gt;
       &lt;version&gt;1.1.GA&lt;/version&gt;
    &lt;/dependency&gt;


How do I do this with my Eclipse project? 

Please assume I know nothing about Maven. I just figured out it might be installed on my computer by typing `mvn` on the command line, but that&#39;s seriously the extent of my knowledge.  I would be happy to continue knowing nothing about Maven if there is an equivalent, non-Maven way of following these instructions with Eclipse.

  [1]: http://docs.jboss.org/resteasy/docs/1.1.GA/userguide/html/json.html

How do I add a Maven dependency in Eclipse?

If I can use `${project.build.sourceDirectory}` to reference the source directory, what do I use to reference the &quot;resources&quot; directory?

Looking at the super pom, it would seem that `${project.build.resources.resource.directory}` would work, but it does not . . .

Referencing resources directory from project object model variables

We&#39;re trying to deploy a war file with Jenkins, but nothing seems to happen.

The project is built successfully, and we&#39;re using Jenkins deploy plugin. It is configured with the following options:

![auto deploy plugin][1]

Post steps are set to &quot;run regardless of build result&quot;.

I have checked that the credentials are correct, as I can acces the manager page in my browser.

Here is the last part that Jenkins (Maven) outputs:

    [INFO] ------------------------------------------------------------------------
    [INFO] BUILD SUCCESS
    [INFO] ------------------------------------------------------------------------
    [INFO] Total time: 1:24.506s
    [INFO] Finished at: Tue Feb 14 12:10:45 UTC 2012
    [INFO] Final Memory: 22M/52M
    [INFO] ------------------------------------------------------------------------
    channel stopped
    Finished: SUCCESS

I can also change WAR/EAR file to something that doesn&#39;t exist, and it will not give me errors, which is kind of strange. What am I doing wrong here?

  [1]: http://i.stack.imgur.com/Gv6RL.png

Jenkins auto deploy tomcat 7

I may be missing something extremely obvious, but I need some clarification regardless. I am about to begin development using maven and archiva. I added both servers + settings to settings.xml, and `distributionManagement` tags to the maven POM which I want to deploy.

I put references to both my internal snapshot repo, and my internal release repo in the POM. is there a specific maven command or option, which specifies to deploy as a SNAPSHOT, and NOT to both repos? Or if I do deploy, will it automatically push one copy to each repo?

Can someone clarify this?&#180;

How to differentiate between deploying releases vs snapshots

**How to document methods with parameters using Python&#39;s documentation strings?**

**EDIT:** 
[PEP 257][1] gives this example:

    def complex(real=0.0, imag=0.0):
        &quot;&quot;&quot;Form a complex number.

        Keyword arguments:
        real -- the real part (default 0.0)
        imag -- the imaginary part (default 0.0)
   
        &quot;&quot;&quot;
        if imag == 0.0 and real == 0.0: return complex_zero
        ...

Is this the convention used by most Python developers ?

    Keyword arguments:
    &lt;parameter name&gt; -- Definition (default value if any)

I was expecting something a little bit more formal such as 

    def complex(real=0.0, imag=0.0):
        &quot;&quot;&quot;Form a complex number.

        @param: real The real part (default 0.0)
        @param: imag The imaginary part (default 0.0)
   
        &quot;&quot;&quot;
        if imag == 0.0 and real == 0.0: return complex_zero
        ...



**Environment**: Python 2.7.1


  [1]: http://www.python.org/dev/peps/pep-0257/

How to document a method with parameter(s)?

## Where can I find *documentation* on running JavaScript code inside a PDF? ##

I&#39;ve never added a JavaScript action inside a PDF document. However, I&#39;ve done quite a bit of web development using JavaScript. I have a few questions to whoever has any familiarity with JavaScript inside a PDF document.

NitroPDF and Adobe Acrobat definitely support JavaScript in PDF files. **Is there a standard on various objects that exist and functions to manipulate a PDF file via JavaScript?**  Everything I&#39;ve found so far has been from Adobe.  Anywhere else seems to reference Adobe&#39;s documentation.  Is there a standard out there, or is Adobe just the &quot;de Facto&quot; standard?

Also, **Do all PDF viewers support JavaScript actions?**

The best documentation on using JavaScript inside a PDF document that I could find was from Adobe - [Adobe :: Acrobat JavaScript Scripting Guide][1].

NitroPDF has this link - [NitroPDF :: JavaScript in PDF Files][2], but it basically just says it supports what Adobe has.

I also found this link from Scribus - [Scribus :: How to enhance your PDF forms with JavaScript][3], but this only includes a few small snippets of code.  Nothing super useful.

Adobe has documentation on how you can set breakpoints, etc... for JavaScript using their IDE.  Is it possible to run JavaScript in a PDF file using another IDE and have breakpoints, etc...? It would be awesome to find something as cool as [Firebug][4].

Note:
-----
Please do not answer how to manipulate a PDF that is loaded in a web browser.  The question is about running JavaScript from within a PDF document.  I&#39;m trying to explore the possibilities available via executing JavaScript in the PDF document.  Specifically I may use functions from [quickpdflibrary][5] to add JavaScript functionality to existing documents.

Another useful link is [Developing with Acrobat JavaScript][6]. Apparently JavaScript code in PDFs is frequently called AcroJS or Acrobat JavaScript.

  [1]: http://partners.adobe.com/public/developer/en/acrobat/sdk/AcroJSGuide.pdf
  [2]: http://www.nitropdf.com/help/pdf_javascript.htm
  [3]: http://wiki.scribus.net/canvas/How_to_enhance_your_PDF_forms_with_JavaScript
  [4]: http://getfirebug.com/
  [5]: http://www.quickpdflibrary.com/help/quickpdf/JavaScript.php
  [6]: http://www.planetpdf.com/developer/article.asp?ContentID=6622


Documentation for using JavaScript code inside a PDF file

What is the appropriate syntax to add an itemized list to roxygen2, for instance, in the @details section?  Can I create a latex list environment?

It seems that line breaks are simply ignored, i.e. 

    #&#39; @details text describing parameter inputs in more detail
    #&#39;
    #&#39; parameter 1: stuff
    #&#39; 
    #&#39; parameter 2: stuff

thanks!

When documenting in Roxygen: How do I make an itemized list in @details?

**Update Aug 2015:** Pinterest provides it here now https://dev.pinterest.com/

**Is there official or unofficial documentation on the v2 Pinterest API?**

Things I know:

- JSON api is in version 2.  https://api.pinterest.com/v2 gives you a json response
- People are programming against it because there is a mobile app and beta dev
- [Pintrest authentication question on SO][1]
- [PHP wrapper for v1 with updates for v2 on Github by Kellan][2] with methods: upload, pin, repin, boards, activity, popular  - reading Kellan&#39;s code is the best information I could find
- [More info][3] on Kellan&#39;s work with responses from Pinterest team
- [Private unofficial Facebook Pinterest Dev group][4]
- [Here are some of the stars behind Pinterest][5]


**Update Mar 4 2014**
Pinterest has unveiled a beta v3 API which you can request access to. Scroll down the page and you&#39;ll see the endpoints listed in the left column.
https://developers.pinterest.com/api_docs/

**Update Jan 9 2013**
Since https://api.pinterest.com/v2 gives a 404, it seems to have been moved to v3.
https://api.pinterest.com/v3

    { &quot;status&quot;: &quot;failure&quot;, &quot;code&quot;: 11, &quot;host&quot;: &quot;053&quot;, &quot;generated_at&quot;: &quot;Wed, 09 Jan 2013 10:25:27 +0000&quot;, &quot;message&quot;: &quot;API method not found.&quot;, &quot;data&quot;: null }

**Update Nov 19, 2012**
The unofficial api documentation at http://tijn.bo.lt/pinterest-api is gone, along with their entire website.  I&#39;m leaving the link in this post because it may come back online.  Still no word from Pinterest to developers on their api status.

**Update May 22, 2012**
Pinterest has still not provided a public api.  People are connecting to the api endpoints as the iPhone user agent, which is available to the iOS app

**Update Apr 17, 2012**
Thanks to tijn, we have [unofficial version 1(now v2) Pinterest api docs][6], and reports that only read endpoints are currently available so RSS style feeds are possible within rate limits.

**Update Apr 3, 2012**
The unofficial Facebook group has some quality info on it and several people asking questions and posting fairly useful responses 


  [1]: https://stackoverflow.com/questions/9333434/pinterest-authentication-url-returning-404-error/9333486#9333486
  [2]: https://github.com/kellan/pinterest.api.php
  [3]: http://laughingmeme.org/2011/12/04/pinterest-api-php/
  [4]: http://www.facebook.com/groups/pinterestapi/
  [5]: http://pinterest.com/about/team
  [6]: http://tijn.bo.lt/pinterest-api

pinterest api documentation

Is there a standard to interpret the syntax of function interfaces in API documentations and if yes, how is it defined?

Here is an example on how to change the color of an item the JavaScript scripting guide for Photoshop for the &quot;fillColor&quot; function:

    fillPath
    ([fillColor]
    [, mode]
    [, opacity]
    [, preserveTransparency] [, feather]
    [, wholePath] [, antiAlias])

What is the meaning of the brackets and why are there commas in the brackets? How does this relate to the following example calls?

    myPath.fillPath(myNewColor)

    myPath.fillPath(mynewColor, {
        mode: RGB,
        opacity: .5
    })



Content Type	Original Author	Original Content on Stackoverflow
Question	user63904	View Question on Stackoverflow
Solution 1 - Maven	Tomasz Nurkiewicz	View Answer on Stackoverflow
Solution 2 - Maven	rob2universe	View Answer on Stackoverflow
Solution 3 - Maven	Alun	View Answer on Stackoverflow

Where should project documentation be stored in a typical maven project

Maven Problem Overview

Maven Solutions

Solution 1 - Maven

Solution 2 - Maven

Solution 3 - Maven

new Backbone.Model() vs Backbone.Model.extend()

Creating templated/persistant header/footer template in jQuery Mobile and PhoneGap

Attributions