Thread Resource Submission Template

[Nestharus]

Sticky this please, this is like the ultimate resource template for submissions.

I'll be updating this to include software so that you can easily do thread management without having to deal with a giganto thread ^)^.

Resource Name - v2.0.0.0 - By Author

Special Thanks To

• Whoever
• Whoever Else

Information

Code

Wrappers

Extensions

Demos

Description

Known Issues

Changelog

Feature 1

Feature 2

Feature 3

Does stuff 1
It's so cool how it this does stuff with possible in-game screenshot or map to run demonstration

					An example of doing the stuff
					An example of doing the stuff
					An example of doing the stuff

Does stuff 2
It's so cool how it this does stuff with possible in-game screenshot or map to run demonstration

					An example of doing the stuff
					An example of doing the stuff
					An example of doing the stuff

Does stuff 3
It's so cool how it this does stuff with possible in-game screenshot or map to run demonstration

					An example of doing the stuff
					An example of doing the stuff
					An example of doing the stuff

• Issue 1
• Issue 2

1.0.0.1

• Change
• Change
• Change

2.0.0.0

• Change
• Change
• Change

Code 1

Code 2

Lua Based Code

				Code
				Code
				Code

Non Lua Based Code

				Code
				Code
				Code

Support for Other Lib 1

Support for Other Lib 2

This code supports another lib that does the same thing (wrapper for this lib using other lib's API)
For example, UnitIndexer supports AIDS and Zinc AIDS

				Code
				Code
				Code

This code supports another lib that does the same thing (wrapper for this lib using other lib's API)
For example, UnitIndexer supports AIDS and Zinc AIDS

				Code
				Code
				Code

Extension 1

Extension 2

An extension to the library, like how Position has many extensions to add features

				Code
				Code
				Code

An extension to the library, like how Position has many extensions to add features

				Code
				Code
				Code

Demo 1

Demo 2

Demonstration of how to do something cool with the lib
Possible screenshot + map to run demo

This is not a feature demo, but rather a demo of how to accomplish something useful or to show how the entire lib
put together might be used.

				Code
				Code
				Code

Demonstration of how to do something cool with the lib
Possible screenshot + map to run demo

This is not a feature demo, but rather a demo of how to accomplish something useful or to show how the entire lib
put together might be used.

				Code
				Code
				Code

[plain]
[center]
[size=6][b][i]Resource Name - v2.0.0.0 - By Author[/i][/b][/size]
[tabs][tab=Special Thanks To]
[list]
	[*]Whoever
	[*]Whoever Else
[/list]
[tabs]
	[tab=Information][tabs]
		[tab=Description][tabs]
			[tab=Feature 1]
				Does stuff 1
				It's so cool how it this does stuff with possible in-game screenshot or map to run demonstration
				
				[code=jass]
					An example of doing the stuff
					An example of doing the stuff
					An example of doing the stuff

[/tab]
[tab=Feature 2]
Does stuff 2
It's so cool how it this does stuff with possible in-game screenshot or map to run demonstration

					An example of doing the stuff
					An example of doing the stuff
					An example of doing the stuff

[/tab]
[tab=Feature 3]
Does stuff 3
It's so cool how it this does stuff with possible in-game screenshot or map to run demonstration

					An example of doing the stuff
					An example of doing the stuff
					An example of doing the stuff

[/tab]
[/tabs][/tab]
[tab=Known Issues]

• Issue 1
• Issue 2

[/tab]
[tab=Changelog]

1.0.0.1

• Change
• Change
• Change

2.0.0.0

• Change
• Change
• Change

[/tab]
[/tabs][/tab]
[tab=Code]

Code 1

Code 2

Lua Based Code

				Code
				Code
				Code

Non Lua Based Code

				Code
				Code
				Code

[/tab]
[tab=Wrappers]

Support for Other Lib 1

Support for Other Lib 2

This code supports another lib that does the same thing (wrapper for this lib using other lib's API)
For example, UnitIndexer supports AIDS and Zinc AIDS

				Code
				Code
				Code

This code supports another lib that does the same thing (wrapper for this lib using other lib's API)
For example, UnitIndexer supports AIDS and Zinc AIDS

				Code
				Code
				Code

[/tab]
[tab=Extensions]

Extension 1

Extension 2

An extension to the library, like how Position has many extensions to add features

				Code
				Code
				Code

An extension to the library, like how Position has many extensions to add features

				Code
				Code
				Code

[/tab]
[tab=Demos]

Demo 1

Demo 2

Demonstration of how to do something cool with the lib
Possible screenshot + map to run demo

This is not a feature demo, but rather a demo of how to accomplish something useful or to show how the entire lib
put together might be used.

				Code
				Code
				Code

Demonstration of how to do something cool with the lib
Possible screenshot + map to run demo

This is not a feature demo, but rather a demo of how to accomplish something useful or to show how the entire lib
put together might be used.

				Code
				Code
				Code

[/tab]
[/tabs][/tab]
[/tabs][/center]
[/plain][/code]

 

[Statharas]

What if I want a giganto thread

 

[Anachron]

What about you add a horizontal line so it won't have different widths?
Right now it's kind of ugly.

 

[Nestharus]

Horizontal line of dashes adds a ton of chars and

---

 

[Anachron]

Maybe its another tag, but there is a horizontal line that fixes the issue. I saw it in the bug report forum.

 

[Nestharus]

if you could let me know which, i can put it in. it's not listed

 

[Anachron]

Okay, if you put in
[ hr ][ / hr ]
you get a new line. Check if it fixes the tabs.

 

[Nestharus]

doesn't fix

 

[overcold_ice]

use characters that are colored like the background
like this:
you found it
just highlight the text

 

[Anachron]

Nes, this is how you can fix the bug.

 

[overcold_ice]

how about this:

	Resource Name	v2.1c by Author
__	[td] Brief description ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____​ ____________________________________________________________________________________________________
	Features​
	Feature 1 Feature 2 Feature 3 Feature 4 Brief description ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____​ ____________________________________________________________________________________________________ // An example of doing the stuff 1 // An example of doing the stuff 1 // An example of doing the stuff 1 Brief description ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____​ ____________________________________________________________________________________________________ // An example of doing the stuff 2 // An example of doing the stuff 2 // An example of doing the stuff 2 Brief description ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____​ ____________________________________________________________________________________________________ // An example of doing the stuff 3 // An example of doing the stuff 3 // An example of doing the stuff 3 Brief description ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____​ ____________________________________________________________________________________________________ // An example of doing the stuff 4 // An example of doing the stuff 4 // An example of doing the stuff 4
	Codes​
	Lua Code [td] // Lua code // Lua code // Lua code ____________________________________________________________________________________________________
	Additional Informations​
	Change Log v2.1c [td] Change v2.1c Change v2.1c Change v2.1c ____________________________________________________________________________________________________
	.

[/td]

Lua Code

Code 1

Code 2

[td]

          //  Code 1
          //  Code 1
          //  Code 1

____________________________________________________________________________________________________
[/td]

[td]

          //  Code 2
          //  Code 2
          //  Code 2

____________________________________________________________________________________________________
[/td]

[/td]

Change Log

Author's Notes

Credits

v2.1c

v2.1b

v2.1a

v2.1

Older Versions

[td]

• Change v2.1b
• Change v2.1b
• Change v2.1b

____________________________________________________________________________________________________
[/td]

[td]

• Change v2.1a
• Change v2.1a
• Change v2.1a

____________________________________________________________________________________________________
[/td]

[td]

• Change v2.1
• Change v2.1
• Change v2.1

____________________________________________________________________________________________________
[/td]

• v2.0

  • Change v2.0
  • Change v2.0
  • Change v2.0

• v1.0a

  • Change v1.0a
  • Change v1.0a
  • Change v1.0a

• v1.0

  • Change v1.0
  • Change v1.0
  • Change v1.0

____________________________________________________________________________________________________

Library Links​

Known Issues​

Important Notes​

• Link 1
• Link 2
• Link 3

• Issue 1
• Issue 2
• Issue 3

• Note 1
• Note 2
• Note 3

____________________________________________________________________________________________________

Ideas​

External Resources​

Miscellaneous​

• Idea 1 by Someone
• Idea 2 by Someone
• Idea 3 by Someone

• Resource Code 1 by Someone
• Resource Code 2 by Someone
• Resource Code 3 by Someone

• Misc 1 by Someone
• Misc 2 by Someone
• Misc 3 by Someone

____________________________________________________________________________________________________

[/td]

 

[Nestharus]

That's excellent, post up the code and I'll put it in the first post

do

[code][plain]
[/plain][/code]

around it

Except, you also want additional wrappers and extensions sections.

Example of extensions (at bottom of post)
http://www.hiveworkshop.com/forums/jass-resources-412/snippet-position-184578/

Example of wrapper (see AIDS Support + Zinc AIDS under Code)
http://www.hiveworkshop.com/forums/jass-resources-412/system-unit-indexer-172090/

edit
After you do that, I'll try to work on a cool editor for it ;o.

edit
Also for code, there are 3 types of code

1. Objects: Code w/ Lua + Code w/ Map
2. No Objects, but possible Lua installation: Code w/ Lua
3. Plain Code

Example of #1 (althugh my layout is prob bad)
Note that this would be the code section, not what you have =P

Lua Dependent Code

Map Dependent Code

Lua

Script

Map

 

[overcold_ice]

do

[code][plain]
[/plain][/code]

around it

forgot to do that xD

[plain]
[TABLE]
  [tr]
    [TD][/TD]
    [TD][size=6][color=#ccaa00]Resource Name[/color][/size][/TD]
    [TD]
      [size=2][color=#60a600][right]v2.1c
      by Author[/right][/color][/size]
    [/TD]
  [/tr]
  [tr]
    [TD][size=5][color=#222222]__[/color][/size][/TD]
    [td][center][TABLE][td]
      [indent]Brief description ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____[/indent]
      [color=#332c29]____________________________________________________________________________________________________[/color]
    [/td][/TABLE][/center][/td]
    [TD][/TD]
  [/tr]
  [tr]
    [TD][/TD]
    [td][indent][size=5][color=#d0f680][b]Features[/b][/color][/size][/indent][/td]
    [TD][/TD]
  [/tr]
  [tr]
    [TD][/TD]
    [td][center][tabs]
      [tab=Feature 1][center][TABLE]
        [tr]
          [indent]Brief description ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____[/indent]
          [color=#332c29]____________________________________________________________________________________________________[/color]
        [/tr]
        [tr][center][code=jass]
	  //  An example of doing the stuff 1
          //  An example of doing the stuff 1
          //  An example of doing the stuff 1

[/center][/tr]
[/TABLE][/center][/tab]
[tab=Feature 2]

Brief description ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____​

____________________________________________________________________________________________________

	  //  An example of doing the stuff 2
          //  An example of doing the stuff 2
          //  An example of doing the stuff 2

[/tab]
[tab=Feature 3]

Brief description ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____​

____________________________________________________________________________________________________

	  //  An example of doing the stuff 3
          //  An example of doing the stuff 3
          //  An example of doing the stuff 3

[/tab]
[tab=Feature 4]

Brief description ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____ ____​

____________________________________________________________________________________________________

	  //  An example of doing the stuff 4
          //  An example of doing the stuff 4
          //  An example of doing the stuff 4

[/tab]
[/tabs][/center][/td]
[TD][/TD]
[/tr]
[tr]
[TD][/TD]
[td]

Codes​

[/td]
[TD][/TD]
[/tr]
[tr]
[TD][/TD]
[td]

Lua Code

Code 1

Code 2

[td]

          //  Lua code
          //  Lua code
          //  Lua code

____________________________________________________________________________________________________
[/td]

[td]

          //  Code 1
          //  Code 1
          //  Code 1

____________________________________________________________________________________________________
[/td]

[td]

          //  Code 2
          //  Code 2
          //  Code 2

____________________________________________________________________________________________________
[/td]

[/td]
[TD][/TD]
[/tr]
[tr]
[TD][/TD]
[td]

Additional Informations​

[/td]
[TD][/TD]
[/tr]
[tr]
[TD][/TD]
[td]

Change Log

Author's Notes

Credits

v2.1c

v2.1b

v2.1a

v2.1

Older Versions

[td]

• Change v2.1c
• Change v2.1c
• Change v2.1c

____________________________________________________________________________________________________
[/td]

[td]

• Change v2.1b
• Change v2.1b
• Change v2.1b

____________________________________________________________________________________________________
[/td]

[td]

• Change v2.1a
• Change v2.1a
• Change v2.1a

____________________________________________________________________________________________________
[/td]

[td]

• Change v2.1
• Change v2.1
• Change v2.1

____________________________________________________________________________________________________
[/td]

• v2.0

  • Change v2.0
  • Change v2.0
  • Change v2.0

• v1.0a

  • Change v1.0a
  • Change v1.0a
  • Change v1.0a

• v1.0

  • Change v1.0
  • Change v1.0
  • Change v1.0

____________________________________________________________________________________________________

Library Links​

Known Issues​

Important Notes​

• Link 1
• Link 2
• Link 3

• Issue 1
• Issue 2
• Issue 3

• Note 1
• Note 2
• Note 3

____________________________________________________________________________________________________

Ideas​

External Resources​

Miscellaneous​

• Idea 1 by Someone
• Idea 2 by Someone
• Idea 3 by Someone

• Resource Code 1 by Someone
• Resource Code 2 by Someone
• Resource Code 3 by Someone

• Misc 1 by Someone
• Misc 2 by Someone
• Misc 3 by Someone

____________________________________________________________________________________________________

[/td]
[TD][/TD]
[/tr]
[tr]
[TD][/TD]
[td].[/td]
[TD][/TD]
[/tr]
[/TABLE]
[/plain][/code]

Except, you also want additional wrappers and extensions sections.

i only provide some formats, it's up to the user to add wrappers and extensions tab, since i have provided more than enough formats
just tell me if you want more, recoloring, etc (or absolutely new thread formats)

 

[Nestharus]

Please add those sections. I really want to do an editor to make this formatting automatic.

For changelog, it's customary to only show the last version changes and then to throw older versions all into another tab, so changelogs should have 2 tabs, one for latest version and one for older versions.

For code, there should be 3 types of layouts.

Features are good, but include a screenshot section ; )

Need a demo section too. Feature would be like specific feature w/ demonstration of that specific feature whereas a demo would be the full resource in action ; D. Each demo should sport a description of the demonstration, the code, a screenshot, and a map link.

For versions, please adopt the 1.0.0.0 convention ;D. Make sure that this convention fits into the right column. Also, keep in mind that the author's name may be semi long.

The look in the right corner, specifically by author, looks pretty ugly. It'd be nice if you could fix that ; ). The problem is that it looks like this

by
Author

It should look like -> by Author, or better yet, -Author

Otherwise it's looking excellent so far ;D. It might be better to just put this up as your own thread too and we can just gy mine or w/e, lol. This template is your work after all. We can get mag to sticky it and require all resources to use it : p.

I'll put up the software for editing it at some point and we can put that into your thread =), ofc I don't really have any good GUI elements to work with since dev express stopped going free. I guess I can check around for Qt stuff.

 

[Nestharus]

Graveyarding