Feed The Beast Wiki

Follow the Feed The Beast Wiki on Discord or Mastodon!

READ MORE

Feed The Beast Wiki
Line 103: Line 103:
 
<div class="plainlinks" style="text-align:right">'''[http://wiki.feed-the-beast.com/index.php?title={{FULLPAGENAMEE}}&action=purge [Purge&#93;]'''</div>
 
<div class="plainlinks" style="text-align:right">'''[http://wiki.feed-the-beast.com/index.php?title={{FULLPAGENAMEE}}&action=purge [Purge&#93;]'''</div>
 
{{Project:Template documentation project/Progress bar|21|42}}
 
{{Project:Template documentation project/Progress bar|21|42}}
* {{Status|done|Done.}} {{Tl|Cg/Alloy Furnace}} creates a crafting grid for the [[Alloy Furnace]].
+
* {{Status|done|Done.}} {{Tl|Cg/Alloy Furnace/doc}} creates a crafting grid for the [[Alloy Furnace]].
* {{Status|done|Done.}} {{Tl|Cg/Alloy Smelter}} creates a crafting grid for the [[Allow Smelter]].
+
* {{Status|done|Done.}} {{Tl|Cg/Alloy Smelter/doc}} creates a crafting grid for the [[Allow Smelter]].
* {{Status|done|Done.}} {{Tl|Cg/Assembling Machine}} creates a crafting grid for the [[Assembling Machine]].
+
* {{Status|done|Done.}} {{Tl|Cg/Assembling Machine/doc}} creates a crafting grid for the [[Assembling Machine]].
* {{Status|done|Done.}} {{Tl|Cg/Automatic Canning Machine}} creates a crafting grid for the [[Automatic Canning Machine]].
+
* {{Status|done|Done.}} {{Tl|Cg/Automatic Canning Machine/doc}} creates a crafting grid for the [[Automatic Canning Machine]].
* {{Status|done|Done.}} {{Tl|Cg/Automatic Wiremill}} creates a crafting grid for the [[Automatic Wiremill]].
+
* {{Status|done|Done.}} {{Tl|Cg/Automatic Wiremill/doc}} creates a crafting grid for the [[Automatic Wiremill]].
* {{Status|done|Done.}} {{Tl|Cg/Canning Machine}} creates a crafting grid for the [[Canning Machine]].
+
* {{Status|done|Done.}} {{Tl|Cg/Canning Machine/doc}} creates a crafting grid for the [[Canning Machine]].
* {{Status|done|Done.}} {{Tl|Cg/Carpenter}} creates a crafting grid for the [[Carpenter]].
+
* {{Status|done|Done.}} {{Tl|Cg/Carpenter/doc}} creates a crafting grid for the [[Carpenter]].
* {{Status|done|Done.}} {{Tl|Cg/Centrifuge}} creates a crafting grid for the [[Centrifuge]].
+
* {{Status|done|Done.}} {{Tl|Cg/Centrifuge/doc}} creates a crafting grid for the [[Centrifuge]].
* {{Status|done|Done.}} {{Tl|Cg/Chemical Reactor}} creates a crafting grid for the [[Chemical Reactor]].
+
* {{Status|done|Done.}} {{Tl|Cg/Chemical Reactor/doc}} creates a crafting grid for the [[Chemical Reactor]].
* {{Status|done|Done.}} {{Tl|Cg/Coke Oven}} creates a crafting grid for the [[Coke Oven]].
+
* {{Status|done|Done.}} {{Tl|Cg/Coke Oven/doc}} creates a crafting grid for the [[Coke Oven]].
* {{Status|done|Done.}} {{Tl|Cg/Compressor}} creates a crafting grid for the [[Compressor]].
+
* {{Status|done|Done.}} {{Tl|Cg/Compressor/doc}} creates a crafting grid for the [[Compressor]].
* {{Status|notdone|Won't create.}} <s>{{Tl|Grid/Crafting Table}} creates a crafting grid for the [[Crafting Table]].</s>
+
* {{Status|notdone|Won't create.}} <s>{{Tl|Cg/Crafting Table/doc}} creates a crafting grid for the [[Crafting Table]].</s>
* {{Status|done|Done.}} {{Tl|Cg/Crafting Table}} creates an alternative crafting grid for the [[Crafting Table]].
+
* {{Status|done|Done.}} {{Tl|Cg/Crafting Table/doc}} creates an alternative crafting grid for the [[Crafting Table]].
* {{Status|done|Done.}} {{Tl|Cg/Distillation Tower}} creates a crafting grid for the [[Distillation Tower]].
+
* {{Status|done|Done.}} {{Tl|Cg/Distillation Tower/doc}} creates a crafting grid for the [[Distillation Tower]].
* {{Status|done|Done.}} {{Tl|Cg/Extractor}} creates a crafting grid for the [[Extractor]].
+
* {{Status|done|Done.}} {{Tl|Cg/Extractor/doc}} creates a crafting grid for the [[Extractor]].
* {{Status|done|Done.}} {{Tl|Cg/Furnace}} creates a crafting grid for the [[Furnace]].
+
* {{Status|done|Done.}} {{Tl|Cg/Furnace/doc}} creates a crafting grid for the [[Furnace]].
* {{Status|done|Done.}} {{Tl|Cg/Fusion Reactor}} creates a crafting grid for the [[Fusion Reactor]].
+
* {{Status|done|Done.}} {{Tl|Cg/Fusion Reactor/doc}} creates a crafting grid for the [[Fusion Reactor]].
* {{Status|done|Done.}} {{Tl|Cg/Implosion Compressor}} creates a crafting grid for the [[Implosion Compressor]].
+
* {{Status|done|Done.}} {{Tl|Cg/Implosion Compressor/doc}} creates a crafting grid for the [[Implosion Compressor]].
* {{Status|done|Done.}} {{Tl|Cg/Induction Smelter}} creates a crafting grid for the [[Induction Smelter]].
+
* {{Status|done|Done.}} {{Tl|Cg/Induction Smelter/doc}} creates a crafting grid for the [[Induction Smelter]].
* {{Status|done|Done.}} {{Tl|Cg/Industrial Blast Furnace}} creates a crafting grid for the [[Industrial Blast Furnace]].
+
* {{Status|done|Done.}} {{Tl|Cg/Industrial Blast Furnace/doc}} creates a crafting grid for the [[Industrial Blast Furnace]].
* {{Status|done|Done.}} {{Tl|Cg/Industrial Centrifuge}} creates a crafting grid for the [[Industrial Centrifuge]].
+
* {{Status|done|Done.}} {{Tl|Cg/Industrial Centrifuge/doc}} creates a crafting grid for the [[Industrial Centrifuge]].
* {{Status|wait|Pending...}} {{Tl|Grid/Industrial Electrolyzer}} creates a crafting grid for the [[Industrial Electrolyzer]].
+
* {{Status|wait|Pending...}} {{Tl|Cg/Industrial Electrolyzer/doc}} creates a crafting grid for the [[Industrial Electrolyzer]].
* {{Status|wait|Pending...}} {{Tl|Grid/Industrial Grinder}} creates a crafting grid for the [[Industrial Grinder]].
+
* {{Status|wait|Pending...}} {{Tl|Cg/Industrial Grinder/doc}} creates a crafting grid for the [[Industrial Grinder]].
* {{Status|wait|Pending...}} {{Tl|Grid/Industrial Sawmill}} creates a crafting grid for the [[Industrial Sawmill]].
+
* {{Status|wait|Pending...}} {{Tl|Cg/Industrial Sawmill/doc}} creates a crafting grid for the [[Industrial Sawmill]].
* {{Status|wait|Pending...}} {{Tl|Cg/Lathe}} creates a crafting grid for the [[Lathe]].
+
* {{Status|wait|Pending...}} {{Tl|Cg/Lathe/doc}} creates a crafting grid for the [[Lathe]].
* {{Status|wait|Pending...}} {{Tl|Grid/Liquid Transposer}} creates a crafting grid for the [[Liquid Transposer]].
+
* {{Status|wait|Pending...}} {{Tl|Cg/Liquid Transposer/doc}} creates a crafting grid for the [[Liquid Transposer]].
* {{Status|wait|Pending...}} {{Tl|Grid/Macerator}} creates a crafting grid for the [[Macerator]].
+
* {{Status|wait|Pending...}} {{Tl|Cg/Macerator/doc}} creates a crafting grid for the [[Macerator]].
* {{Status|wait|Pending...}} {{Tl|Grid/Magma Crucible}} creates a crafting grid for the [[Magma Crucible]].
+
* {{Status|wait|Pending...}} {{Tl|Cg/Magma Crucible/doc}} creates a crafting grid for the [[Magma Crucible]].
* {{Status|wait|Pending...}} {{Tl|Cg/Metal Former}} creates a crafting grid for the [[Metal Former]].
+
* {{Status|wait|Pending...}} {{Tl|Cg/Metal Former/doc}} creates a crafting grid for the [[Metal Former]].
* {{Status|wait|Pending...}} {{Tl|Cg/Ore Washing Plant}} creates a crafting grid for the [[Ore Washing Plant]].
+
* {{Status|wait|Pending...}} {{Tl|Cg/Ore Washing Plant/doc}} creates a crafting grid for the [[Ore Washing Plant]].
* {{Status|wait|Pending...}} {{Tl|Grid/Plate Bending Machine}} creates a crafting grid for the [[Plate Bending Machine]].
+
* {{Status|wait|Pending...}} {{Tl|Cg/Plate Bending Machine/doc}} creates a crafting grid for the [[Plate Bending Machine]].
* {{Status|wait|Pending...}} {{Tl|Cg/Plate Cutting Machine}} creates a crafting grid for the [[Place Cutting Machine]].
+
* {{Status|wait|Pending...}} {{Tl|Cg/Plate Cutting Machine/doc}} creates a crafting grid for the [[Place Cutting Machine]].
* {{Status|wait|Pending...}} {{Tl|Grid/Powered Furnace}} creates a crafting grid for the [[Power Furnace]].
+
* {{Status|wait|Pending...}} {{Tl|Cg/Powered Furnace/doc}} creates a crafting grid for the [[Power Furnace]].
* {{Status|wait|Pending...}} {{Tl|Grid/Pulverizer}} creates a crafting grid for the [[Pulverizer]].
+
* {{Status|wait|Pending...}} {{Tl|Cg/Pulverizer/doc}} creates a crafting grid for the [[Pulverizer]].
* {{Status|wait|Pending...}} {{Tl|Cg/Printing Factory}} creates a crafting grid for the [[Printing Factory]].
+
* {{Status|wait|Pending...}} {{Tl|Cg/Printing Factory/doc}} creates a crafting grid for the [[Printing Factory]].
* {{Status|wait|Pending...}} {{Tl|Cg/Recycler}} creates an alternative crafting grid for the [[Recycler]].
+
* {{Status|wait|Pending...}} {{Tl|Cg/Recycler/doc}} creates an alternative crafting grid for the [[Recycler]].
* {{Status|wait|Pending...}} {{Tl|Grid/Rolling Machine}} creates a crafting grid for the [[Rolling Machine]].
+
* {{Status|wait|Pending...}} {{Tl|Cg/Rolling Machine/doc}} creates a crafting grid for the [[Rolling Machine]].
* {{Status|wait|Pending...}} {{Tl|Grid/Sawmill}} creates a crafting grid for the [[Sawmill]].
+
* {{Status|wait|Pending...}} {{Tl|Cg/Sawmill/doc}} creates a crafting grid for the [[Sawmill]].
* {{Status|wait|Pending...}} {{Tl|Grid/Squeezer}} creates a crafting grid for the [[Squeezer]].
+
* {{Status|wait|Pending...}} {{Tl|Cg/Squeezer/doc}} creates a crafting grid for the [[Squeezer]].
* {{Status|wait|Pending...}} {{Tl|Cg/Thermal Centrifuge}} creates a crafting grid for the [[Thermal Centrifuge]].
+
* {{Status|wait|Pending...}} {{Tl|Cg/Thermal Centrifuge/doc}} creates a crafting grid for the [[Thermal Centrifuge]].
* {{Status|wait|Pending...}} {{Tl|Grid/Thermionic Fabricator}} creates a crafting grid for the [[Thermionic Fabricator]].
+
* {{Status|wait|Pending...}} {{Tl|Cg/Thermionic Fabricator/doc}} creates a crafting grid for the [[Thermionic Fabricator]].
* {{Status|wait|Pending...}} {{Tl|Grid/Vacuum Freezer}} creates a crafting grid for the [[Vacuum Freezer]].
+
* {{Status|wait|Pending...}} {{Tl|Cg/Vacuum Freezer/doc}} creates a crafting grid for the [[Vacuum Freezer]].
   
 
== Scope ==
 
== Scope ==

Revision as of 04:32, 15 September 2013

Welcome to the Template documentation project.

Warning

The new system will not be backwards compatible, old crafting grids will be automatically converted to the new crafting grids. You are safe to continue to use the current system but please do not modify the old grid templates.

Goals

  • Remove the animation frames limit
  • Introduce oreDict support.
  • Increase the implementation of stuff that grids support.
  • Improve the readability of templates in articles.
  • Ease the creation of crafting grid templates.
  • ...and more...

Links

Progress

 
92% (23/25)
92% (23/25)

Preparations

  • Yes checkDone. Protect crafting grid templates.

Code

  • Black checkAlready done. Code animation.
  • Yes checkDone. Code crafting grid controls.

Grid

  • Yes checkDone. Style grids.
  • Yes checkDone. Create grids template.

Animation

  • Yes checkDone. Create crafting grid controls to flip through different crafting recipes.
  • Yes checkDone. Create "activate animation" wrapping metatemplate.
  • Yes checkDone. Create "activate controls" wrapping metatemplate.

Tooltips

  • Yes checkDone. Code support for variables in tooltips.

Ore Dictionary

  • Yes checkDone. Create Ore Dictionary template
  • Yes checkDone. Create Ore Dictionary activation template
  • Yes checkDone. Populate Ore Dictionary

Tanks

  • Yes checkDone. Create tanks template.
  • Yes checkDone. Tank image truncation script.
  • Yes checkDone. Tank image helper.

Crafting Grids

  • Yes checkDone. Create "cells" metatemplate for crafting grid creation.
  • Yes checkDone. Create "tanks" metatemplate for crafting grid creation.
  • Yes checkDone. Create a crafting grid metatemplate.
  • Yes checkDone. Recreate all crafting grids.
  • Yes checkDone. Create documentation cell.

Cleanup

Crafting grids

 
100% (42/42)
100% (42/42)

Crafting grids documentation

 
50% (21/42)
50% (21/42)

Scope

  • Crafting grids and related templates.

Project Members

Please add your name to the list if you wish to participate in this project.

Template list

This is a list of experimental and final templates that the project is currently using.

Experimental templates

Final templates

  • {{G}} - Main grid wrapper.
  • {{Cg}} - Crafting grid components.
  • {{G/Dict}} - Ore Dictionary.
  • {{G/Mods}} - Resolves mod names.
  • {{G/T}} > {{G/Tank}} - Single tank wrapper.
  • {{Gc}} > {{G/Cell}} - Grid display logic.
  • {{Gcd}} > {{G/Cell doc}} - Documentation cell
  • {{I}} - Creates a image wrapped in the span tag, used in crafting grids.
  • {{N}} - Animation/slideshow wrapper
  • {{O}} > {{G/O}} - Ore dictionary wrapper, call by tag.
  • {{S}} - Creates a string wrapped in the span tag, used in crafting grids.
  • {{T}} - Liquid display logic, used in crafting grids.

Prototypes

Working prototypes

Future code example

Single crafting grids

This is what the code to create single crafting grids will look like in the future.

{{Furnace
 |I={{G|Oak Wood}}
 |O={{G|Charcoal}}
 |F={{G|Oak Wood Planks|tooltiptext=$1<br><span class="tcAspectTooltipDesc">Can smelt 1.5 items.</span>}}
}}
Code Explanation
  • Line 1: No more Grid/ prefix in front of crafting grid templates.
  • Line 2-4: Instead of providing a list of items to the crafting grid template, you give it a list of grids that can be fully customized. A redirect will be made for less typing (G->Grid).
  • {{G|Oak Wood}} and {{G|Oak Wood Planks|...}}: A animation will display ore dict compatible items.
  • {{G|Oak Wood Planks|tooltiptext=$1<br><span class="tcAspectTooltipDesc">Can smelt 1.5 items.</span>}}: Demonstrates that grids in crafting grids can be fully customized. And that tooltips will support variables.

Multiple crafting grids

This is what the code to create multiple crafting grids will look like in the future. Instead of flipping through animations automatically by the script, the user must flip through them manually with the controls provided.

{{Furnace
 |I={{G|Oak Wood|16}}{{G|Clay|9}}
 |O={{G|Charcoal|16}}{{G|Brick|9}}
 |F={{G|Charcoal|2|tooltiptext=Charcoal<br><span class="tcAspectTooltipDesc">Can smelt 8 items.</span>}}{{G|Oak Wood Planks|6|tooltiptext=$1<br><span class="tcAspectTooltipDesc">Can smelt 1.5 items.</span>}}
}}

Crafting grid creation

This is an example of how crafting grids will be created in the future. Ideally, templates used here should be substituted to allow for shallower expansion depth, however, by not substituting the templates you increase the maintainability of these crafting grids.

{{Crafting grid/Start}}
{{Crafting grid/Image|Link to image|style=Additional styles|class=Additional classes}}
{{Crafting grid/Cell|{{{1|{{{A1}}} }}}|X position|Y position|style=Additional styles|class=Additional classes}}
...
{{Crafting grid/Cell|{{{9|{{{C3}}} }}}|X position|Y position|style=Additional styles|class=Additional classes}}
...
{{Crafting grid/Tank|{{{liquid}}}|X position|Y position|style=Additional styles|class=Additional classes}}
{{Crafting grid/End}}